Receive delivery notifications

POST https://webhook.example.com

application/json

Body object

tstamp string(date-time)

The time at which the message was received
message_type string

The type of the message
ref string

Client reference
messageID integer

The Id of the message
balance_used integer

Total number of credits used to send all messages
statuses object

The status of the individual messages
Hide statuses attributes Show statuses attributes object
- pending integer
  
  The number of messages pending delivery
- submitted integer
  
  The number of messages submitted for delivery
- sent integer
  
  The number of messages sent
- delivered integer
  
  The number of messages delivered
- cancelled integer
  
  The number of messages cancelled
- expired integer
  
  The number of messages which have expired
- aborted integer
  
  The number of messages aborted
- rejected integer
  
  The number of messages rejected
- failed integer
  
  The number of messages failed to deliver
- deleted integer
  
  The number of messages deleted
- unknown integer
  
  The number of messages in an unknown state
callback_type string

The type of the callback

tstamp string(date-time)

The time at which the message was received
message_type string

The type of the message
ref string

Client reference
messageID integer

The Id of the message
balance_used integer

Total number of credits used to send all messages
statuses object

The status of the individual messages
Hide statuses attributes Show statuses attributes object
- Additional properties
- status string
  
  Values are pending, submitted, sent, delivered, cancelled, expired, aborted, rejected, failed, deleted, or unknown.
- recipients array[string]
  
  The msisdn of the recipient
callback_type string

The type of the callback

tstamp string(date-time)

The time at which the message was received
message_type string

The type of the message
ref string

Client reference
messageID integer

The Id of the message
balance_used integer

Total number of credits used to send all messages
status string

The status of the message

Values are pending, submitted, sent, delivered, cancelled, expired, aborted, rejected, failed, deleted, or unknown.
status_code integer

The statu code for the message
recipients string

The recipient of the message
callback_type string

The type of the callback

tstamp string(date-time)

The time at which the message was received
message_type string

The type of the message
ref string

Client reference
messageID integer

The Id of the message
balance_used integer

Total number of credits used to send all messages
status string

The status of the message

Values are pending, submitted, sent, delivered, cancelled, expired, aborted, rejected, failed, deleted, or unknown.
status_code integer

The status code for the message
recipients string

The recipient of the message
callback_type string

The type of the callback

Responses

200

Your server returns this code if it accepts the callback

POST Delivery Report

Request examples

{
  "tstamp": "2024-06-03T10:05:22Z",
  "message_type": "sms",
  "ref": "d93b9ec9-4e0d-42b8-80c0-ef3036acdafc",
  "messageID": 923934,
  "balance_used": 2,
  "statuses": {
    "pending": 0,
    "submitted": 0,
    "sent": 0,
    "delivered": 2,
    "cancelled": 0,
    "expired": 0,
    "aborted": 0,
    "rejected": 0,
    "failed": 1,
    "deleted": 0,
    "unknown": 0
  },
  "callback_type": "summary_delivery_report"
}

{
  "tstamp": "2024-06-03T10:05:22Z",
  "message_type": "sms",
  "ref": "d93b9ec9-4e0d-42b8-80c0-ef3036acdafc",
  "messageID": 923934,
  "balance_used": 2,
  "statuses": {
    "status": "delivered",
    "recipients": [
      "+447700900998"
    ]
  },
  "callback_type": "summary_delivery_report"
}

{
  "tstamp": "2024-06-03T10:05:22Z",
  "message_type": "sms",
  "ref": "d93b9ec9-4e0d-42b8-80c0-ef3036acdafc",
  "messageID": 923934,
  "balance_used": 2,
  "status": "delivered",
  "status_code": 200,
  "recipients": "+447700900999",
  "callback_type": "recipient_delivery_report"
}

{
  "tstamp": "2024-06-03T10:05:22Z",
  "message_type": "sms",
  "ref": "d93b9ec9-4e0d-42b8-80c0-ef3036acdafc",
  "messageID": 923934,
  "balance_used": 2,
  "status": "delivered",
  "status_code": 200,
  "recipients": "+447700900999",
  "callback_type": "recipient_delivery_report"
}