Delivery Receipt Webhooks

Delivery Receipt webhooks requests are sent to your endpoints when you:

• Specify a callback parameter in an add-message request
• Specify a callback parameter in an add-batch request

A Delivery Receipt webhook request will be made to your specified endpoint immediately after a message has been marked as delivered, or failed to deliver.

Delivery states

Successful delivery

A message is marked as delivered if we get successfully notified of delivery via our Service providers.

Failed delivery

A message is marked as failed if:

• We are notified by our service provider that the message was rejected for any reason. This includes:
  • Handset turned off
  • Handset not supporting the requested message channel
  • Carrier marked message content/sender ID as spam
  • User has opted out of business communication
• We failed to send the message to our service providers

Request

In this example, the URL supplied in the callback parameter is:

https://my-website.com/delivery-receipt

Endpoint

A POST request will be made to your endpoint

POST https://my-website.com/delivery-receipt

Body

Delivered message

{
    "destination": "+441111111111",
    "delivered": true,
    "batchuuid": "ea5b64d8-4267-4ffa-937d-2ba0c4f031f3",
    "messageuuid": "6a96a54d-596f-403a-bcd6-6a07fd985f93",
    "receiptInfo": {
        "code": "00",
        "description": "Successful"
    }
}

Failed message

{
    "destination": "+441111111111",
    "delivered": false,
    "batchuuid": "ea5b64d8-4267-4ffa-937d-2ba0c4f031f3",
    "messageuuid": "6a96a54d-596f-403a-bcd6-6a07fd985f93",
    "receiptInfo": {
        "code": "22",
        "description": "No response from the SME (e.g. phone switched off)"
    }
}

Key	Expected value	Description
destination	string	The destination this message was being sent to.
delivered	boolean	Whether this message successfully delivered.
batchuuid	string	Batch UUID of the message this delivery receipt is for.
messageuuid	string	Message UUID of the message this delivery receipt is for.
receiptInfo.code	string	Error/Success code associated with this delivery receipt
receiptInfo.description	string	Description of this receipts status

Response

Messaging Plus expects a 200 response to the webhook. If a non-200 response is supplied, it will retry up to 5 times.