Skip to main content
WEBHOOK
Delivery-report
{
  "message_id": "871b4eeb-f798-4105-be23-32df9e991456",
  "message_type": "sms",
  "from": "Wavix",
  "to": "+447537151866",
  "status": "accepted",
  "segments_count": 1,
  "sent": "2024-05-28T12:34:54.000Z",
  "charge": "0.01",
  "carrier_fees": "0.0",
  "tag": "Fall sale",
  "delivered": "2024-05-28T12:34:56.000Z",
  "error": null
}

Body

application/json
​
message_id
string
required

Unique identifier of the message generated by the platform

Example:

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

​
message_type
string
required

Type of the message sent or received. Can be either sms or mms

Example:

"sms"

​
from
string
required

Sender ID used to send the message. Can be numeric or alphanumeric.

Example:

"Wavix"

​
to
string
required

Destination phone number

Example:

"+447537151866"

​
status
enum<string>
required

Message delivery status

Available options:
accepted,
pending,
sent,
delivered,
undelivered,
expired,
rejected,
dlr_expired
​
segments_count
integer<int32>
required

Number of message segments, for SMS only. For MMS messages segments is always 1.

Example:

1

​
sent
string<date-time> | null
required

Timestamp when Wavix submitted the message for delivery

Example:

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

​
charge
string
required

Total price of the message

Example:

"0.01"

​
carrier_fees
string
required

Mobile carrier fees, in USD.

Example:

"0.0"

​
tag
string | null

An optional field normally used to identify a group of SMS, e.g. messages associated with a certain campaign.

Example:

"Fall sale"

​
delivered
string<date-time> | null

Timestamp when final status was received

Example:

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

​
error
string | null

A human-readable error description, if any

Example:

null

Response

200

Return a 200 status to indicate that the data was successfully received