Skip to main content
GET
/
messages
/
all
Get messages in NDJSON format
curl --request GET \
  --url 'https://api.wavix.com/v1/messages/all?appid='
"{\"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

​
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 HH:MM:SS format.

Example:

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

​
sent_before
string

End date of your search time range, in yyyy-mm-dd HH:MM:SS format.

Example:

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

​
type
string
required

Filter messages by the direction of SMS 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"

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

Response

Newline-delimited JSON stream of message objects

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"