WINSMS

Delete scheduled SMS messages and refund credits

POST

/sms/scheduled/delete

sms

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

array[integer]

optional

>= 1 items<= 1000 items

Example:

[2316,2317]

Examples

Responses

🟢200OK

application/json

Body

deletedMessageStatuses

array[object (deletedMessageStatus) {5}]

optional

An array of deletedMessageStatus objects detailing the deleted status of each message requested for deletion.

>= 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 refunded to your account after deleting the scheduled message.

If the deletion was unsuccessful, this value will be 0.

Example:

1.3

deleteError

string

optional

If the deleted value is false, this will contain an error code indicating the reason for the failure. If the scheduled SMS message was successfully deleted, this value will be blank.

Example:

NOTFOUND

deleted

boolean

optional

A boolean value indicating whether a scheduled SMS message was successfully deleted

Example:

true

mobileNumber

string

optional

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

Example:

27824444444

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

🟠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.