Skip to main content
POST
Delivery-report

Authorizations

​
appid
string
query
required

An API key to authorize your request

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"

​
tag
string | null
required

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

Example:

"Fall sale"

​
status
enum<string>
required

Message delivery status

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

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

Example:

1

​
sent
string<date-time>

Timestamp when Wavix submitted the message for delivery

Example:

"2022-04-14T13:51:16.096Z"

​
delivered
string<date-time> | null

Timestamp when final status was received

Example:

"2022-04-14T13:51:16.096Z"

​
error
string | null

A human-readable error description, if any

Response

200

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