Get a list of scheduled SMS messages

GET

/sms/scheduled

sms

Get a list of all scheduled SMS messages that have not yet been sent.

Only the first 100 scheduled messages will be returned if no offset and limit parameters are specified.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://www.winsms.co.za/api/rest/v1/sms/scheduled'

Response Example

200 - Example 1

{
  "resultsLimit": 100,
  "resultsOffset": 3400,
  "resultsTotalAvailable": 3402,
  "scheduledMessages": [
    {
      "apiMessageId": 2316,
      "creditCost": 1,
      "mobileNumber": "27444444444",
      "scheduledSendTime": "201712251430",
      "submitTime": "201710220850"
    },
    {
      "apiMessageId": 2317,
      "creditCost": 1,
      "mobileNumber": "27555555555",
      "scheduledSendTime": "201712251430",
      "submitTime": "201710220850"
    }
  ],
  "statusCode": 200,
  "timeStamp": "20170117054658978",
  "version": "1.0"
}

Request

Query Params

offset

integer

optional

Optional - The number of items to skip before starting to return results. Default 0. Minimum 0.

limit

integer

optional

Optional - The number of items to return. Default 100. Minimum 1. Maximum 1000.

Responses

🟢200OK

application/json

Body

resultsLimit

integer

optional

The number of items returned in the results. This is the value specified in the limit parameter sent to the endpoint. If the parameter was not specified, this defaults to 100.

resultsOffset

integer

optional

The number of items skipped before the results were returned. This is the value specified in the offset parameter sent to the endpoint. If the parameter was not specified, this defaults to 0.

resultsTotalAvailable

integer

optional

The total number of results available for retrieval. The offset and limit properties specify which of the total available results have been returned.

scheduledMessages

array[object (scheduledMessage) {5}]

optional

An array of scheduledMessage objects containing properties of each unsent scheduled message.

>= 1 items<= 1000 items

apiMessageId

integer

optional

The WinSMS API Message Id identifying the SMS message.

Example:

2316

creditCost

number <double>

optional

The number of credits deducted from your account for the SMS to this recipient.

This is the number of credits that will be refunded if you delete this scheduled message.

Example:

1.3

mobileNumber

string

optional

The mobile number of the recipient of the SMS message, using the international E164 (without the plus) format

Example:

27824444444

scheduledSendTime

string

optional

The date and time the message is scheduled to be delivered to the recipient, in the format YYYYMMDDHHmm.

Example:

201812250930

submitTime

string

optional

The date and time the message was originally submitted for scheduled delivery, in the format YYYYMMDDHHmm.

Example:

201712251431

statusCode

integer

optional

The http status code returned - reflected in the body for convenience

timeStamp

string

optional

The date/time the request was processed, in the format YYYYMMDDhhmmssSSS

version

string

optional

The current version of the API of the endpoint that was called

🟠401Unauthorized

🟠404Not found

🟠405Method Not Allowed

🟠422Unprocessable Entity

🔴500Internal Server Error

Get SMS delivery statuses

Delete scheduled SMS messages and refund credits