Skip to main content
WEBHOOK

Body

application/json

Message delivery report (DLR).

​
message_id
string
required

Message ID.

Example:

"871b4eeb-f798-4105-be23-32df9e991456"

​
message_type
string
required

Type of message. Possible values are sms, mms.

Example:

"sms"

​
from
string
required

Sender ID. Can be numeric or alphanumeric.

Example:

"Wavix"

​
to
string
required

Destination phone number.

Example:

"+447537151866"

​
status
enum<string>
required

Current delivery status of the message. One of:

  • accepted — the message was accepted by the platform for sending.
  • pending — the message is queued and awaiting a carrier response.
  • sent — the message was handed to the carrier.
  • delivered — the carrier confirmed delivery to the handset.
  • undelivered — the carrier reported that delivery failed.
  • expired — the validity period elapsed before the message was sent.
  • rejected — the message was rejected before sending.
  • dlr_expired — no delivery receipt arrived from the carrier within the expected window.
Available options:
accepted,
pending,
sent,
delivered,
undelivered,
expired,
rejected,
dlr_expired
​
segments_count
integer<int32>
required

Number of message segments for SMS. For MMS, the value is always 1.

Example:

1

​
sent
string<date-time> | null
required

Date and time the message was accepted in ISO 8601 format.

Example:

"2024-05-28T12:34:54Z"

​
charge
string
required

Total charge for the message in USD.

Example:

"0.01"

​
carrier_fees
string
required

Mobile carrier fees in USD.

Example:

"0.0"

​
tag
string | null

Tag to identify a group of messages, such as those associated with a campaign.

Example:

"Fall sale"

​
delivered
string<date-time> | null

Date and time when the final status was received in ISO 8601 format.

Example:

"2024-05-28T12:34:56Z"

​
error
string | null

Human-readable error description.

Response

200

Successful callback receipt.