Skip to main content
GET
List WhatsApp 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

direction
enum<string>

Filters messages by direction. Possible values:

  • outbound — The message was sent from your account to a recipient.
  • inbound — A customer sent the message to one of your senders.
Available options:
outbound,
inbound
status
enum<string>

Filters messages by delivery status. Inbound messages always have delivered status. Possible values:

  • sent — The message isn't delivered yet.
  • delivered — The message was delivered to the recipient.
  • undelivered — The message was sent but not delivered.
  • expired — The message expired before it was delivered.
  • rejected — The message was permanently rejected before or by the provider.
  • unknown — The provider hasn't reported a status.
Available options:
sent,
delivered,
undelivered,
expired,
rejected,
unknown
from
string

Filters messages by the from phone number, in E.164 format. The leading + is optional.

Pattern: ^\+?\d{6,20}$
to
string

Filters messages by the to phone number, in E.164 format. The leading + is optional.

Pattern: ^\+?\d{6,20}$
from_date
string<date>

Filters messages to those created on or after the start of this date in your account's time zone, in YYYY-MM-DD format.

to_date
string<date>

Filters messages to those created on or before the end of this date in your account's time zone, in YYYY-MM-DD format.

page
integer<int32>
default:1

Page number to retrieve. Page numbering starts at 1. Defaults to 1.

per_page
integer<int32>
default:25

Number of records to return per page. Defaults to 25. Values above 100 are treated as 100.

Response

A paginated list of WhatsApp messages.

Returned by whatsapp_messages_list.

messages
WhatsAppMessageListItem · object[]
required

Messages that match the request.

pagination
Pagination · object
required