Skip to main content
GET
List messages

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.

Query Parameters

sent_after
string

Returns messages sent on or after this date, in YYYY-MM-DD format.

Example:

"2023-04-10"

sent_before
string

Returns messages sent on or before this date, in YYYY-MM-DD format.

Example:

"2023-04-13"

type
string
required

Filters messages by direction. One of inbound (messages received by the account) or outbound (messages sent by the account).

Example:

"outbound"

from
string

Filters by message sender. For outbound messages, the Sender ID used to send the message; for inbound messages, the originating phone number.

Example:

"15072429497"

to
string

Filters by message recipient. For outbound messages, the destination phone number; for inbound messages, an SMS-enabled number on the Wavix platform.

Example:

"16419252149"

status
enum<string>

Filters messages by delivery status. Accepts a MessageDeliveryStatus value. 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.
Available options:
accepted,
pending,
sent,
delivered,
undelivered,
expired,
rejected,
dlr_expired
tag
string

Filters messages by tag. Supported for outbound messages only.

Example:

"campaignX"

message_type
enum<string>

Filters messages by type. One of sms (text message) or mms (multimedia message).

Available options:
sms,
mms
Example:

"sms"

page
integer<int32>

Page number to retrieve. Default 1.

Example:

2

per_page
integer<int32>

Number of records to return per page. Default 25.

Example:

50

Response

Returns a paginated list of messages.

items
Message · object[]
required

Messages that match the request.

pagination
Pagination · object
required