Get a list of scheduled SMS messages

GET

/sms/scheduled

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

Query Params

Responses

🟢200OK

application/json

Body

🟠401Unauthorized

🟠404Not found

🟠405Method Not Allowed

🟠422Unprocessable Entity

🔴500Internal Server Error

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"
}

Modified at 2023-08-15 09:05:19

Get SMS delivery statuses

Delete scheduled SMS messages and refund credits