Retrieve the delivery status for a specific SMS using its Message ID. The Message ID is provided in the Send Message API response as the third parameter in the data string.
The API returns an object with a data field containing the message ID and delivery status in the following format:
{
"timestamp": 1782969745,
"exection": 0.0013545999526978,
"error": false,
"data": {
"message_id": "12345",
"status": "sent"
}
}| Error Code | Error Type | Error Message |
|---|---|---|
| -1000 | ACCESS-DENIED | Access Denied |
| -1040 | MISSING-MESSAGE-ID | ID field missing |
| -1041 | INVALID-MESSAGE-ID | ID field has invalid value or not found |
| -1042 | NOT-AVAILABLE-STATUS | The message status is not available |
| -1043 | ACCESS-DENIED-TO-MESSAGE-ID | Access denied to the message ID |
| Type | Status | Description |
|---|---|---|
| Processing States | not_sent | The message is in the sending queue. |
| Processing States | sent | The message has been sent successfully. Delivery confirmation pending. |
| Terminal States | delivered | The message was successfully delivered. |
| Terminal States | failed | The message failed to send. |
| Terminal States | undelivered | The message was sent but not delivered. |
Security
accessToken
- Avanser Productionhttps://p3.avanser.com/app/deliverystatus
- AVANSER Mock Serverhttps://avanser.redocly.app/_mock/user-api/references/deliverystatus
curl -i -X POST \
'https://p3.avanser.com/app/deliverystatus?id=12345&token=YOUR_API_KEY_HERE'Delivery status.
The time that the API response left the server, represented as the number of seconds since the UNIX epoch.
Example:1508903167
The number of seconds that it took to process the API request.
Example:0.00041531896591187
Boolean indicating whether there was an error returned by the API request.
Example:false
Response
{ "timestamp": 1782969745, "exection": 0.0013545999526978, "error": false, "data": { "message_id": "12345", "status": "sent" } }