Delivery Receipt Notification

This document will go over how to receive Delivery Receipt notifications via API.

When the status of a message changes, a notification will be POSTed to the specified webhook URL.

Headers

Header	Value
Content-Type	application/json

Arguments

Name	Type	Description
deliveryMessageId	string	Sent Message Id.
batchId	string	Batch ID of the message.
clientReference	string	Client message reference.
created	datetime	Date/Time receipt was received.
status	string	Message status, see list of possible statuses.
statusCode	integer	Message status in numeric value.
parts	integer	Number of parts in the message.
hlr	object	HLR Data, see HLR documentation.

Examples

Payload

{
   "deliveryMessageId":"9A85B95E0A000A9D2FBD46710388AD54",
   "batchId":"9A85B9110A000A9D2FBD4671D691C328",
   "clientReference":null,
   "created":"2023-07-28T03:23:22.000+00:00",
   "status":"ACCEPTED",
   "statusCode":2,
   "parts":1,
   "hlr":null
}

Delivery Status List

Status	Code	Description
DELIVERED	1	Message successfully delivered to the handset.
ACCEPTED	2	Message accepted by carrier.
EXPIRED	3	The SMSC was unable to deliver the message in a specified amount of time (e.g. Phone is turned off).
DELETED	4	Message has been deleted.
UNDELIVERABLE	5	The SMS was unable to deliver the message (e.g. the number does not exist).
UNKNOWN	6	Unknown error occurred.
REJECTED	7	The message was rejected.
INTERIM_QUEUED	8	Message has been queued by next tier provider.
INTERIM_ACKNOWLEDGED	9	Message has been acknowledged by next tier provider.
RETRY	10	Message delivery will be retried.
FAILED_NACK	11	Message accepted but not delivered to the handset.
FAILED_NOROUTE	12	Provider could not route the message.
FAILED_INSUFFICIENT_CREDIT	17	Your account does not have sufficient credit to send the message.
FAILED_ORIGINATOR_RECIPIENT_EQUAL	18	Message originator and recipient are the same.
FAILED_RECIPIENT_BLACKLISTED	19	Recipient has been blacklisted.
FAILED_ORIGINATOR_REJECTED	20	Invalid message originator.
FAILED_ROUTE_INVALID	21	The selected Route ID cannot send messages to this recipient.
FAILED_LIMITS_EXCEEDED	22	Your account has exceeded its allocated limits.
FAILED_EXHAUSTED	24	Retries exhausted.
FAILED_INTERNAL_ERROR	28	Message failed to process/send due to internal error.
FAILED_UNKNOWN	29	Message failed to process/send due to unknown error.
REJECTED_INVALID_ORIGINATOR	33	Message rejected due to invalid originator.
REJECTED_INVALID_RECIPIENT	34	Message rejected due to invalid recipient.
REJECTED_INVALID_TEXT	36	Message rejected due to invalid text.
ERR_CONNECTION_NETWORK	40	Message failed to send due to connectivity issues.