Skip to main content
GET
Listar mensagens WhatsApp

Autorizações

Authorization
string
header
obrigatório

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Parâmetros de consulta

page
string
limit
string
fromDate
string<date-time>
toDate
string<date-time>
instanceIds
string

IDs separados por vírgula

status
enum<string>
Opções disponíveis:
QUEUED,
PROCESSING,
SENT,
DELIVERED,
READ,
FAILED,
CANCELLED,
SCHEDULED,
DELETED,
RESPONDED,
EDITED
type
enum<string>

Filtra por tipo de mensagem no histórico. TEMPLATE é tipo armazenado para modelos específicos; demais tipos refletem o que foi enviado pela API.

Opções disponíveis:
TEXT,
IMAGE,
DOCUMENT,
AUDIO,
VIDEO,
BUTTONS,
LIST,
TEMPLATE,
LOCATION,
CONTACT
includeEvents
string

true/1/yes para incluir eventos

Resposta

Lista de mensagens e paginação.

success
boolean
Exemplo:

true

data
object[]
pagination
object