Skip to main content
GET
/
v3
/
messages
/
{id}
Retrieve a message
curl --request GET \
  --url https://api.wavix.com/v3/messages/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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
  },
  "tag": "Fall sale",
  "status": "delivered",
  "segments": 1,
  "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"
}

Authorizations

​
Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Path Parameters

​
id
string
required

Message ID.

Example:

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

Response

Message details.

​
message_id
string
required

Message ID.

Example:

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

​
message_type
string
required

Message type. Possible values are sms, mms.

Example:

"sms"

​
from
string
required

Sender ID.

Example:

"Wavix"

​
to
string
required

Recipient phone number.

Example:

"447537151866"

​
direction
string
required

Message direction. Possible values are outbound, inbound.

Example:

"outbound"

​
mcc
string | null
required

Mobile country code.

Example:

"301"

​
mnc
string | null
required

Mobile network code.

Example:

"204"

​
message_body
MessageBody · object
required
​
tag
string | null
required

Tag to group messages, such as for a specific 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 SMS segments. Always 1 for MMS.

Example:

1

​
charge
string
required

Total charge for the message in USD.

Example:

"0.01"

​
submitted_at
string
required

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

Example:

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

​
sent_at
string | null
required

Date and time the message was sent in ISO 8601 format. For mobile-terminated messages only.

Example:

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

​
delivered_at
string | null
required

Date and time the message was delivered in ISO 8601 format. Refers to DLR reception for mobile-terminated messages or webhook relay for mobile-originated messages.

Example:

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

​
error_message
string | null
required

Human-readable error message.

​
carrier_fees
string | null

Mobile carrier fees in USD.

Example:

"0.0"