Skip to main content
GET
/
messages
Get messages on your account
curl --request GET \
  --url https://api.wavix.com/v3/messages
{
  "items": [
    {
      "charge": "0.0475",
      "delivered_at": "2023-08-29T12:32:45.000Z",
      "direction": "outbound",
      "error_message": null,
      "from": "SenderName",
      "mcc": "234",
      "message_body": {
        "text": "Please call me back",
        "media": null
      },
      "message_id": "3a525ca2-6909-4c72-9399-905adf7f3a74",
      "message_type": "sms",
      "mnc": "024",
      "segments": 1,
      "sent_at": "2023-08-29T12:32:44.000Z",
      "status": "delivered",
      "submitted_at": "2023-08-29T12:32:44.000Z",
      "tag": null,
      "to": "447537151866"
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total": 1,
    "total_pages": 1
  }
}

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-10"

​
sent_before
string

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

Example:

"2023-04-13"

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

​
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. 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

Requested page

Example:

2

​
per_page
integer

Number of records per page

Example:

50

Response

​
items
SMSorMMSmessage · object[]
required

A list of messages that match the search criteria

​
pagination
object
required
⌘I