DLR Webhook

DLR

Similar to incoming SMS messages, if a DLR has been requested, it will also be delivered by webhook. DLR webhook requests are sent to the same URL that’s been set for incoming messages.

DLR Webhook Schema

DLR:

Name	Type	Description
delivery_status	Enum:String	The delivery status of the SMS.
from	String	The originating number for the SMS delivery report.
id	String	The assigned ID for the delivery report.
sms	sms	SMS details associated with the delivery report, if available.
timestamp	String(format:date-time)	ISO 8601 timestamp indicating when the delivery report was first received by the SMS system.
to	String	The destination number for the SMS delivery report.
type	Enum:String	The type of webhook event. Always sms_dlr for this schema.

SMS object within the DLR:

Name	Type	Description
id	String	The unique identifier of the SMS associated with the delivery report.

DLR Webhook Example

{
  "delivery_status": "delivered",
  "from": "12003004000",
  "id": "01JDQ0R6MMNKQ4XNEV3QH49H8H",
  "sms": {
    "id": "01JDQ0T6SXSD6B2A4JP8XZ8GTS"
  },
  "timestamp": "2024-06-14T00:00:00.000000Z",
  "to": "12003004001",
  "type": "sms_dlr"
}

MMS DLR

Similar to SMS delivery reports, MMS delivery reports are also delivered by webhook if requested.

MMS DLR Webhook Schema

MMS DLR:

Name	Type	Description
data	MMS Part	Contains the content of the MMS message.
delivery_status	String	The delivery status of the MMS.
from	String	The originating number for the MMS delivery report.
id	String	The unique identifier for the delivery report.
mms	mms	MMS details associated with the delivery report.
timestamp	String(format:date-time)	ISO 8601 timestamp indicating when the delivery report was generated.
to	String	The destination number for the MMS delivery report.
type	Enum:String	The type of webhook event. Always mms_dlr for this schema.

MMS object within the DLR:

Name	Type	Description
id	String	The unique identifier of the MMS associated with the delivery report.

MMS DLR Webhook Example

{
  "data": {
    "body": "Hello, World",
    "encoding": "identity",
    "headers": {
      "*": "string"
    },
    "is_multipart": true,
    "parts": [
      {}
    ]
  },
  "delivery_status": "delivered",
  "from": "string",
  "id": "string",
  "mms": {
    "id": "string"
  },
  "timestamp": "2024-06-14T00:00:00.000000Z",
  "to": "string",
  "type": "mms_dlr"
}