receiptRequest
, the system will send a delivery receipt to your specified callback URL once the message reaches its final state.
This allows you to monitor the delivery status of your messages in real-time.
receiptRequest
object of the message request. If you do not include a
receiptRequest
, no delivery receipt will be sent.Field | Type | Description |
---|---|---|
type | String | Type of the request, which is always DeliveryReceipt for delivery receipts |
correlator | String | Unique ID that correlates with your original message request |
phone | String | Recipient’s phone number |
timestamp | String | ISO-8601 formatted date and time when the delivery status was recorded |
deliveryStatus | String | Current delivery status of the message |
reason | String | Optional human-readable explanation for the delivery status |
reasonCode | String | Optional provider-specific code related to the delivery status |
Status | Description |
---|---|
Waiting | Delivery process is pending and hasn’t been attempted yet |
Delivered | Message was successfully delivered to the recipient |
DeliveryUncertain | Delivery status is ambiguous or unknown |
DeliveryImpossible | Delivery failed and was deemed impossible |
SenderBlacklisted | Sender is blacklisted, preventing delivery |
InsufficientFunds | Delivery failed due to insufficient account credits |
InvalidLinkId | The provided link ID for delivery was invalid |
SubscriberOptedOut | Recipient has opted out and cannot receive messages |
AbsentSubscriber | Recipient is temporarily unavailable or unreachable |
InvalidMsisdn | Recipient’s phone number is invalid |
Failed | Termination failed while attempting to handover to gateway |