HTTP Interface

Message Status Reports

Our server can be configured to forward message status reports (e.g. Delivery Reports) to you webserver via a HTTP POST.

To configure HTTP forwarding please login into your account and go to Preferences and then select the Forwarding tab. 

{
  "notifications": [
    {
      "notificationtype": "status",
      "messageid": "21ba6a2ee454d1710d88f357df34fdb3f5",
      "to": "44771012345",
      "status": "delivered",
      "status_code": 4,
      "category": "success",
      "userkey": "UserKey"
    }
  ]
}

Parameters:

notificationtypeNotification Type ('status')
messageidUnique message id (as returned when message was sent)
toPhone Number message was sent to
statusMessage status (See table below)
status_codeStatus Code (Numerical representation of the 'status' parameter, see table below)
categoryMessage status category (success/interim/failure/rejection)
userkey(Optional) Userkey provided when message was sent

Message Status:

queued2Message Queued
sent3Message Sent
delivered4Message Delivered
error_with_request5Error With Request
unable_to_deliver6Unable To Deliver
routing_error7Routing Error
expired8Message Expired
acknowledged_by_recipient11Acknowledged By Recipient (Voice-SMS Only)
rejected_by_recipient12Rejected By Recipient (Voice-SMS Only)
rejected_spam_filter13Rejected (Spam Filtering)
read14Message Read (WhatsApp and RCS Only)
rejected_response_window15Rejected Response Window (WhatsApp Only)
rejected_age_restriction16Rejected Age Restriction (WhatsApp Only)
recipient_not_provisioned17Rejected Recipient Not Provisioned (WhatsApp Only) 
msgid=10011000000000000001&status=4&toaddr=44771012345

Parameters:

msgidUnique message id (as returned when message was sent)
statusMessage status (See table below)
toaddrPhone Number message was sent to

Message Status:

2Message Queued
3Message Sent
4Message Delivered
5Error With Request
6Unable To Deliver
7Routing Error
8Message Expired
11Acknowledged By Recipient (Voice-SMS Only)
12Rejected By Recipient (Voice-SMS Only)
13Rejected (Spam Filtering)
14Message Read (WhatsApp and RCS Only)
15Rejected Response Window (WhatsApp Only)
16Rejected Age Restriction (WhatsApp Only)
17Rejected Recipient Not Provisioned (WhatsApp Only)

HTTP Response:

Our server expects a HTTP 200 (OK) status. Any content returned by your server will be ignored.

If anything other than a status 200 is returned then our server will consider this an error. On an error condition our server will retry to delivery the same status report every 5 minute until the error is resolved.