Pular para o conteúdo principal
GET
/
api
/
v1
/
messages
Listar mensagens com filtros
curl --request GET \
  --url https://6827d740d717.ngrok-free.app/api/v1/messages \
  --header 'Authorization: <api-key>'
[
  {
    "id": "msg_1694024400000_xyz123456",
    "type": "API",
    "mediaType": "TEXT",
    "sendStatus": "SENT",
    "phone": "+5511999999999",
    "contentPreview": "Olá! Como posso ajudá-lo hoje?...",
    "createdAt": "2023-09-06T20:00:00.000Z",
    "sentAt": "2023-09-06T20:00:00.000Z"
  }
]

Autorizações

​
Authorization
string
header
obrigatório

API Key de autenticação - usar ApiKey {sua-api-key}

Parâmetros de consulta

​
type
enum<string>

Tipo da mensagem para filtrar

Opções disponíveis:
API,
BATCH
Exemplo:

"API"

​
mediaType
enum<string>

Tipo de mídia para filtrar

Opções disponíveis:
TEXT,
IMAGE,
VIDEO,
DOCUMENT,
AUDIO
Exemplo:

"TEXT"

​
sendStatus
enum<string>

Status de envio para filtrar

Opções disponíveis:
PENDING,
IN_QUEUE,
SENT,
FAILED,
CANCELLED
Exemplo:

"SENT"

​
phone
string

Número de telefone para filtrar

Exemplo:

"+5511999999999"

​
instanceId
string

ID da instância para filtrar

Exemplo:

"inst_1694024400000_xyz123456"

​
startDate
string

Data inicial para filtrar (ISO string)

Exemplo:

"2023-09-06T00:00:00.000Z"

​
endDate
string

Data final para filtrar (ISO string)

Exemplo:

"2023-09-06T23:59:59.999Z"

​
page
number

Página para paginação

Exemplo:

1

​
limit
number

Itens por página

Exemplo:

10

Resposta

200 - application/json

Lista de mensagens

​
id
string
obrigatório

ID da mensagem

Exemplo:

"msg_1694024400000_xyz123456"

​
type
enum<string>
obrigatório

Tipo da mensagem

Opções disponíveis:
API,
BATCH
Exemplo:

"API"

​
mediaType
enum<string>
obrigatório

Tipo de mídia da mensagem

Opções disponíveis:
TEXT,
IMAGE,
VIDEO,
DOCUMENT,
AUDIO
Exemplo:

"TEXT"

​
sendStatus
enum<string>
obrigatório

Status de envio da mensagem

Opções disponíveis:
PENDING,
IN_QUEUE,
SENT,
FAILED,
CANCELLED
Exemplo:

"SENT"

​
phone
string
obrigatório

Número de telefone do destinatário

Exemplo:

"+5511999999999"

​
contentPreview
string
obrigatório

Prévia do conteúdo da mensagem (primeiros 100 caracteres)

Exemplo:

"Olá! Como posso ajudá-lo hoje?..."

​
createdAt
string<date-time>
obrigatório

Data de criação da mensagem

Exemplo:

"2023-09-06T20:00:00.000Z"

​
sentAt
string<date-time>

Data de envio da mensagem

Exemplo:

"2023-09-06T20:00:00.000Z"