Sign in

v50

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-06-16122182589.7 KB
SMS and MMS

Delivery report

Sends a notification when an outbound message delivery status changes.

postWebhookDeliveryReport

Payload

message_idstring required

Message ID.

message_typestring required

Type of message. Possible values are sms, mms.

fromstring required

Sender ID. Can be numeric or alphanumeric.

tostring required

Destination phone number.

tagstring nullable

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

status'accepted' | 'pending' | 'sent' | 'delivered' | 'undelivered' | 'expired' | 'rejected' | 'dlr_expired' 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.
segments_countinteger required

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

sentstring date-time nullable required

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

deliveredstring date-time nullable

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

errorstring nullable

Human-readable error description.

chargestring required

Total charge for the message in USD.

carrier_feesstring required

Mobile carrier fees in USD.

Example payload

{
  "message_id": "871b4eeb-f798-4105-be23-32df9e991456",
  "message_type": "sms",
  "from": "Wavix",
  "to": "+447537151866",
  "tag": "Fall sale",
  "segments_count": 1,
  "sent": "2024-05-28T12:34:54Z",
  "delivered": "2024-05-28T12:34:56Z",
  "charge": "0.01",
  "carrier_fees": "0.0"
}

Response

Successful callback receipt.