Skip to main content
GET
Consultar logs de mensagens

Authorizations

Authorization
string
header
required

Access token (at_...) obtido em /oauth-token, ou o par client_id:client_secret separado por dois-pontos, sem espaços.

Query Parameters

id
string<uuid>

Devolve uma única mensagem pelo id (o message_id do /send-message), no formato { "data": { ... } }, em vez da lista paginada. Um valor que não é UUID responde 400; id inexistente ou de outra conta responde 404.

tag
string

Devolve os envios que têm esta tag entre as suas tags. Uma tag por consulta.

channel
enum<string>

Devolve só os envios deste canal. Um valor fora da lista devolve lista vazia, sem erro.

Available options:
email,
whatsapp,
sms,
telegram,
slack,
web_push,
in_app,
push
status
enum<string>

Devolve só os envios com este status atual. Um valor fora da lista devolve lista vazia, sem erro. queued: enfileirada, aguardando envio (ex.: fila de WhatsApp). processing: em processamento. sent: enviada, o provedor aceitou a mensagem (no WhatsApp oficial da Meta, a mensagem fica sent e as confirmações preenchem delivered_at e read_at). delivered: entregue e read: lida, confirmações do WhatsApp enviado pela Evolution API. failed: falhou (veja error_message), inclusive quando o envio foi recusado pelo limite diário da conta. skipped: ignorada (faltou dado do destinatário, não havia template no idioma, o número não tem WhatsApp, o canal In-App está desabilitado, o contato se descadastrou do canal — em campanhas, automações de marketing e envios pela API com respect_opt_out: true — ou, em campanhas, o contato foi removido antes de a mensagem sair).

Available options:
queued,
processing,
sent,
delivered,
read,
failed,
skipped
communication_slug
string

Slug da comunicação, ativa ou não. Slug inexistente na conta devolve lista vazia, sem erro.

from
string<date-time>

Envios criados a partir desta data e hora, inclusive (ISO 8601). Sem fuso no valor, vale UTC; para o fuso da conta, informe o deslocamento (ex.: 2026-01-01T00:00:00-03:00)

to
string<date-time>

Envios criados até esta data e hora, inclusive (ISO 8601). Sem fuso no valor, vale UTC

page
integer
default:1

Página. Valores menores que 1 viram 1.

Required range: x >= 1
limit
integer
default:20

Itens por página. Valores acima de 100 viram 100.

Required range: 1 <= x <= 100

Response

Lista paginada de envios

data
object[]
total
integer

Total de envios que atendem aos filtros, somando todas as páginas

page
integer
limit
integer