What DLR format will the API send?

Updated 4 months ago

Currently, the only forwarding format we support is x-www-form-urlencoded data.

We require a valid SSL certificate chain on the server we are forwarding to, otherwise you will not receive any data.

Inbound Webhook

Parameter Keys

Description

body

The contents of the inbound message.

custom_string

The custom_string of the originating message if replying.

customstring

The custom_string of the originating message if replying.

from

The phone number that the message is from.

message

The contents of the inbound message.

message_id

The id of the inbound message.

original_message_id

The id of the previous outbound message if one exists.

originalmessage

The contents of the previous outbound message if one exists.

originalmessageid

The id of the previous outbound message if one exists.

originalsenderid

The from number that the original message used.

sms

The number that received the inbound message.

subaccount_id

The id of the subaccount that received the inbound message.

timestamp

The unix timestamp of when the inbound message was received.

user_id

The id of the account that received the inbound message.

DLR Webhook

Parameter Keys

Description

custom_string

The custom_string of the message being sent.

customstring

The custom_string of the message being sent.

error_code

The decimal code for the status of the message.

error_text

Text describing the status of the message.

message_id

The id of the message being sent.

message_type

The type of message that it is (sms, voice, email, or fax)

messageid

The id of the message being sent.

status

The status of the message that was sent.

status_code

The status code of the message that was sent.

status_text

Text describing the status of the message.

subaccount_id

The id of the subaccount that sent the message.

timestamp

The unix timestamp of when the DLR was received.

timestamp_send

The unix timestamp of when the message was sent.

user_id

The idof the account that sent the message.


How Did We Do?


Powered by HelpDocs (opens in a new tab)