Webhook for message status updates

POST https://example.com/webhook
X api key

This webhook is triggered when the status of a sent message changes. A separate notification is sent for each actual message sent. "The possible status updates are: DELIVERED, READ, FAILED (only for the last channel of the fallback chain), and NOSENT. "Notifications are only sent for the final delivery channel. If a webhook call fails, retries will be performed at increasing intervals for up to 48 hours.

*/*

Body Required

Payload for the message status update callback

  • dispatchId string Required

    The API call ID, returned in the response of the message dispatch request.

  • messageId string Required

    The message ID.

  • messagePart integer(int32) Required

    Refers to the specific content of the translation sent in the request or the single content defined in the template used for sending.

  • messageTotalParts integer(int32) Required

    Total number of content parts, representing the actual number of messages sent to the recipient.

  • channel string Required

    Values are RCS, SMS, or WHATSAPP.

  • channelIdentifier string Required

    The user identifier specified in the API request for the current channel.

  • status string Required

    The new status of the message. Possible values: DELIVERED, READ, FAILED, NOSENT.

    Values are DISPATCHED, NOSENT, SENT, FAILED, DELIVERED, or READ.

  • statusOrder integer(int32) Required

    The order number to be used for sorting statuses when notifications have the same timestamp. Notifications may arrive out of order due to provider behavior or webhook retries.

  • statusDate string(date-time) Required

    The date and time (UTC) of the status change.

  • dispatchMetadata object

    General metadata sent in the message dispatch request.

    Hide dispatchMetadata attribute Show dispatchMetadata attribute object
    • * string Additional properties
  • recipientMetadata object

    Metadata specific to the recipient associated with the channelIdentifier specified in the message dispatch request.

    Hide recipientMetadata attribute Show recipientMetadata attribute object
    • * string Additional properties

Responses

  • 200

    Callback received successfully

POST Message Status Update
Request examples 
{
  "dispatchId": "0FCB1XXXVEABC",
  "messageId": "0FCB1ABCVEXYZ",
  "messagePart": 1,
  "messageTotalParts": 3,
  "channel": "RCS",
  "channelIdentifier": "+390000000",
  "status": "DELIVERED",
  "statusOrder": 10,
  "statusDate": "2024-01-01T14:30:00Z",
  "dispatchMetadata": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "recipientMetadata": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  }
}