Get SMS delivery statuses

POST

/sms/outgoing/status

Get a list of previously submitted SMS message delivery statuses.

Post an array of API Message Ids received from the /sms/outgoing/send endpoint.

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

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
    "messageStatuses": [
        {
            "apiMessageId": 2316,
            "creditCost": 1,
            "mobileNumber": "27444444444",
            "statusDelivered": true,
            "statusErrorCode": 0,
            "statusTime": "201712251431"
        },
        {
            "apiMessageId": 2317,
            "creditCost": 1,
            "mobileNumber": "27555555555",
            "statusDelivered": false,
            "statusErrorCode": "BADDEST",
            "statusTime": "201712251432"
        }
    ],
    "statusCode": 200,
    "timeStamp": "20170117054658978",
    "version": "1.0"
}

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

Send multiple different SMS messages

Get a list of scheduled SMS messages