Get messages on your account

Authorizations

appid

string

query

required

An API key to authorize your request

Query Parameters

sent_after

string

Start date of your search time range, in yyyy-mm-dd format.

Example:

"2023-04-10T00:00:00.000Z"

sent_before

string

End date of your search time range, in yyyy-mm-dd format.

Example:

"2023-04-13T00:00:00.000Z"

type

string

required

Filter messages by the direction of the traffic, i.e. inbound or outbound

Example:

"outbound"

from

string

Filter messages by SMS sender. For outbound message contains a Sender ID used to sent the message, for inbound message contains a phone number originated the message.

Example:

"15072429497"

string

Filter messages by destination phone number. For outbound message contains phone number the message was sent to, for inbound message contains a SMS-enabled DID on the Wavix platform.

Example:

"16419252149"

status

enum<string>

Filter messages by message delivery status.

Available options:

accepted,

pending,

sent,

delivered,

undelivered,

expired,

rejected,

dlr_expired

tag

string

Filter messages by tag. For outbound SMS and MMS messages only, for inbound messages the parameter is ignored.

Example:

"campaignX"

message_type

enum<string>

Filter messages by message type (SMS or MMS)

Available options:

sms,

mms

Example:

"sms"

page

integer<int32>

Requested page

Example:

2

per_page

integer<int32>

Number of records per page

Example:

50

Response

items

SMSorMMSmessage · object[]

required

A list of messages that match the search criteria

Show child attributes

items.message_id

string

required

Unique identifier of the message generated by the platform

Example:

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

items.message_type

string

required

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

Example:

"sms"

items.from

string

required

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

Example:

"Wavix"

items.to

string

required

Destination phone number

Example:

"447537151866"

items.direction

string

required

Message direction. Can be either outbound or inbound

Example:

"outbound"

items.mcc

string | null

required

Mobile country code of the destination phone number.

Example:

"301"

items.mnc

string | null

required

Mobile network code of the destination phone number.

Example:

"204"

items.message_body

MessageBody1 · object

required

Show child attributes

items.message_body.text

string

required

Message text.

Example:

"Hi there, this is a sample message"

items.message_body.media

string[] | null

required

An array of URLs to a media attachments. If the parameters contains any value other that null, the message is considered to be an MMS, SMS otherwise.

Maximum array length: 5

Example:

["https://you-site.com/media"]

items.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"

items.status

enum<string>

required

Message delivery status

Available options:

accepted,

pending,

sent,

delivered,

undelivered,

expired,

rejected,

dlr_expired

items.segments

integer<int32>

required

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

Example:

1

items.charge

string

required

Total price of the message

Example:

"0.01"

items.submitted_at

string

required

Timestamp the messages is accepted by the platform

Example:

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

items.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"

items.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"

items.error_message

string | null

required

A human-readable error description, if any

items.carrier_fees

string<float>

Example:

"0.0"

pagination

Pagination · object

required

Show child attributes

pagination.current_page

integer<int32>

required

Current page number

Example:

2

pagination.per_page

integer<int32>

required

Number of records per page

Example:

25

pagination.total

integer<int32>

required

Total number of records

Example:

101

pagination.total_pages

integer<int32>

required

Total number of pages

Example:

5

Using the APIs

API reference

Get messages on your account

Authorizations

Query Parameters

Response