Skip to main content
GET
/
v3
/
messages
/
all
Export messages
curl --request GET \
  --url https://api.wavix.com/v3/messages/all \
  --header 'Authorization: Bearer <token>'
"{\"message_id\":\"3a525ca2-6909-4c72-9399-905adf7f3a74\",\"message_type\":\"sms\",\"from\":\"15072429497\",\"to\":\"16419252149\",\"direction\":\"outbound\",\"status\":\"delivered\"}\n{\"message_id\":\"4b636ca3-7900-5d83-a400-016bf8f8f4b85\",\"message_type\":\"sms\",\"from\":\"15072429497\",\"to\":\"16419252150\",\"direction\":\"outbound\",\"status\":\"delivered\"}\n"

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 timestamp, in YYYY-MM-DDTHH:MM:SS format.

Example:

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

​
sent_before
string

Returns messages sent on or before this timestamp, in YYYY-MM-DDTHH:MM:SS format.

Example:

"2023-04-13T23:59:59"

​
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, the SMS-enabled number that received the message.

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"

Response

Returns an NDJSON stream of messages, one per line.

Newline-delimited JSON stream of messages.

Example:

"{\"message_id\":\"3a525ca2-6909-4c72-9399-905adf7f3a74\",\"message_type\":\"sms\",\"from\":\"15072429497\",\"to\":\"16419252149\",\"direction\":\"outbound\",\"status\":\"delivered\"}\n{\"message_id\":\"4b636ca3-7900-5d83-a400-016bf8f8f4b85\",\"message_type\":\"sms\",\"from\":\"15072429497\",\"to\":\"16419252150\",\"direction\":\"outbound\",\"status\":\"delivered\"}\n"