Get SMS delivery statuses

POST

/sms/outgoing/status

sms

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

Request

Body Params application/json

array[integer]

optional

>= 1 items<= 1000 items

Example:

[2316,2317]

Examples

Responses

🟢200OK

application/json

Body

messageStatuses

array[object (messageStatus) {6}]

optional

An array of messageStatus objects detailing the delivery status of each 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.

If delivery to the recipient is unsuccessful, under certain conditions, this may be 0.

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

statusDelivered

boolean

optional

A boolean value indicating whether an SMS message was successfully delivered to the recipient's mobile number

Example:

true

statusErrorCode

string

optional

If the SMS message was successfully delivered, this value will be blank.
If the statusDelivered value is false, this will contain a string indicating the current status of the SMS message. Possible values-

Value	Description	Type
SENT	The message has been sent to the recipient, but no delivery report has been received	Temporary
NOTFOUND	Either an incorrect MessageID was sent in the request, or the message was sent more than 90 days previously	Permanent
INQUEUE	Message is queued for sending	Temporary
SENDINGFAILED	The message was not transmitted, due to e.g. an invalid destination number or insufficient credits	Permanent
FAILED	The message was sent but could not be delivered to the recipient due to e.g. no such subscriber, subscriber's phone offline	Permanent

Example:

FAILED

statusTime

string

optional

The date and time of the last status update for this message, in the format YYYYMMDDHHmm.

If the message was delivered (statusDelivered = true) then this is a final status time. If the message is still awaiting delivery, this time might change when updates are received.

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

🟠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

Send multiple different SMS messages

Get a list of scheduled SMS messages