Delivery Reports
Last updated
Last updated
The REST API uses message statuses and error codes in delivery reports, which refer to the state of the batch and can be fetched or sent as a callback.
To enable delivery report, navigate to Settings => Webhook on the Customer Dashboard and enter the callback URL. Once set, all delivery reports would be delivered to the URL.
The status field describes which state a particular message is in.
The following statuses are available when using the SMS REST API:
Status | Type | Description |
---|---|---|
Queued
Intermediate
Message is queued within REST API system and will be dispatched according to the rate of the account.
Diapatched
Intermediate
Message has been dispatched and accepted for delivery by the SMSC.
Rejected
Final
Message was rejected by the SMSC.
Delivered
Final
Message has been delivered.
Failed
Final
Message failed to be delivered
Expired
Final
Message expired after several failed attempts to deliver message to the recipient. Expiry time differs per operator, set to a minimun of 12 hours.
Unknown
Final
Message was delivered to the SMSC but no Delivery Receipt has been received or a Delivery Receipt that couldn't be interpreted was received.