Delete scheduled SMS messages and refund credits

POST

/sms/scheduled/delete

Delete a list of previously scheduled SMS messages that have not yet been sent.

Credits originally deducted for each SMS message will be refunded to your account upon successful deletion.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://www.winsms.co.za/api/rest/v1/sms/scheduled/delete' \
--header 'Content-Type: application/json' \
--data-raw '[
    2316,
    2317
]'

Response Example

200 - Example 1

{
    "deletedMessageStatuses": [
        {
            "apiMessageId": 2316,
            "creditCost": 1,
            "deleteError": "",
            "deleted": true,
            "mobileNumber": "27444444444"
        },
        {
            "apiMessageId": 2317,
            "creditCost": 0,
            "deleteError": "NOTFOUND",
            "deleted": false,
            "mobileNumber": "27555555555"
        }
    ],
    "statusCode": 200,
    "timeStamp": "20170117054658978",
    "version": "1.0"
}

Request

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Not found

🟠405Method Not Allowed

🟠413Payload Too Large

🟠415Unsupported Media Type

🟠422Unprocessable Entity

🔴500Internal Server Error

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

Get a list of scheduled SMS messages

Get a list of all Sub Accounts.