Skip to main content
GET
/
messages
/
{id}
Get a specific message
curl --request GET \
  --url 'https://api.wavix.com/v1/messages/{id}?appid='
{
  "message_id": "3a525ca2-6909-4c72-9399-905adf7f3a74",
  "message_type": "sms",
  "from": "15072429497",
  "to": "16419252149",
  "direction": "outbound",
  "mcc": "310",
  "mnc": "024",
  "message_body": {
    "text": "Hello, this is a test message",
    "media": null
  },
  "segments": 1,
  "status": "delivered",
  "charge": "0.01",
  "submitted_at": "2022-04-14T13:51:16.096Z",
  "sent_at": "2022-04-14T13:51:16.096Z",
  "delivered_at": "2022-04-14T13:51:16.096Z",
  "error_message": null,
  "carrier_fees": "0.0",
  "tag": "Fall sale"
}

Authorizations

​
appid
string
query
required

An API key to authorize your request

Path Parameters

​
id
string
required

Unique identifier of the message

Example:

"3a525ca2-6909-4c72-9399-905adf7f3a74"

Response

​
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"

​
direction
string
required

Message direction. Can be either outbound or inbound

Example:

"outbound"

​
mcc
string | null
required

Mobile country code of the destination phone number.

Example:

"301"

​
mnc
string | null
required

Mobile network code of the destination phone number.

Example:

"204"

​
message_body
MessageBody1 · object
required
​
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

​
charge
string
required

Total price of the message

Example:

"0.01"

​
submitted_at
string
required

Timestamp the messages is accepted by the platform

Example:

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

​
sent_at
string | null
required

Timestamp the messages is sent, for mobile terminated messages only. For mobile originated messages the parameter is not returned.

Example:

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

​
delivered_at
string | null
required

Timestamp DLR is received for mobile terminated messages or timestamp the messages was successfully relayed to a webhook for mobile originated messages.

Example:

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

​
error_message
string | null
required

A human-readable error description, if any

​
carrier_fees
string | null

Mobile carrier fees for delivering the message, in USD.

Example:

"0.0"