GET/v1/messaging/messages

Authorization

Bearer token

Authorizationrequiredheader

Send your API key as Bearer YOUR_API_KEY.

Requires whatsapp.full_access, because the list includes messages your customers sent you. WhatsApp must be turned on for your organization.

Query parameters

pageoptionalinteger

Page number, from 1 to 10000. Default 1.

limitoptionalinteger

1–100. Default 50.

channeloptionalstring

whatsapp. Only messages of this channel.

directionoptionalstring

outbound for messages you sent, inbound for messages your customers sent you.

One of"outbound""inbound"

statusoptionalstring

Only messages with this status, such as delivered, failed, or received. See the message object.

Response

application/json200 OK

Results are under data, newest first, with page-based pagination.

itemsarray

Messages on this page.

totalnumber

Messages matching the filters.

pagenumber

The page returned.

limitnumber

The page size.

Each item has id, channel, direction, status, sender, recipient, failure_code, is_billable, cost, cost_currency, and the timestamps created_at, accepted_at, sent_at, delivered_at, read_at, and failed_at, as in the message object. Retrieve a message for its type, template, content, including each card of a carousel, and conversation. Messages are kept for 30 days.

Nexiom Connect
Open dashboard