Callback Service: Messaging API

This page describes any parameters in callback notifications from the Messaging product that are different from the general callback notification schema explained on Transaction Callback Service.

Schema

The Messaging callback notification schema includes both the parameters below and those described in the general schema:

object
status
object
channel_status
array[object]

Contains an object with properties related to the status of the send for each attempted channel.

external_id
string or null

The customer-generated ID for this transaction that was provided in the request. If the external_id parameter was not included in the request, the value here is null.

1 validation

Example

Product-specific parameters that are not part of the general schema are highlighted in the code.

Callback Example
HTTP
POST /callback_endpoint HTTP/1.1
Host: your-callback-url.com
{
  "reference_id": "35C8B5D509BC10689196FED2AD551B8A",
  "external_id": null,
  "status": {
    "code": 3000,
    "description": "Delivered",
    "last_channel": "sms",
    "updated_on": "2020-05-04 22:07:01:226"
  },
  "channel_status": [
    {"rcs": {
      "code": 3056,
      "description": "Message failed to deliver in specified fallback time",
      "reference_id": "65C77D4A6C5C09085694EFB6C554D2BF",
      "updated_on": "2020-05-04 22:05:00.325"
    }},
    {"sms": {
      "code": 3000,
      "description": "Delivered",
      "reference_id": "65C77D4A6C5C09085694EFB6C558B4C7",
      "updated_on": "2020-05-04 22:07:01:226"
    }}
  ]
}