Atividade das últimas 24 horas
GET /messages/activity
Resume a atividade da inbox nas últimas 24 horas a partir dos registros gravados nela, sem consultar o WhatsApp. Serve para acompanhar volume de envio, retorno dos contatos e falhas de webhook.
- Totais:
sent_api,sent_otherereceivedcontam conversas com contatos; osgroup_*, grupos. Ligações, reações, canais e mensagens de protocolo ficam fora. buckets: a janela em horas UTC. A primeira e a última podem ser parciais, por isso vêm 24 ou 25.contacts: quem recebeu envio da api e quem mandou mensagem ou reação depois, sem ligar a resposta a uma mensagem específica.inventory: totais da inbox, sem o filtro de 24 horas e sem forçar sincronização.- Cobertura: só o que está gravado; retenção, exclusões, reconexões e atraso de gravação podem deixar lacunas. Não é avaliação de risco de banimento.
- O resumo fica guardado por 1 minuto, e a inbox aceita até 120 consultas por minuto.
Autenticação
[
{
"token": []
}
]
{
"token": {
"name": "token",
"type": "apiKey",
"in": "header"
}
}
Respostas
{
"200": {
"description": "Resumo dos registros locais disponíveis",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"window_start_at",
"window_end_at",
"generated_at",
"coverage",
"sent_api",
"sent_other",
"received",
"group_sent_api",
"group_sent_other",
"group_received",
"buckets",
"contacts",
"contacts_unavailable",
"inventory",
"session_ready",
"webhook_errors",
"webhook_capture_started_at"
],
"properties": {
"generated_at": {
"type": "string",
"format": "date-time",
"description": "Quando o resumo foi calculado Pode ter até 1 minuto, porque o resumo fica guardado. ISO 8601 em UTC com milissegundos."
},
"coverage": {
"type": "string",
"enum": [
"available_local_records"
],
"description": "Sempre `available_local_records`: o resumo cobre só os registros gravados na inbox."
},
"sent_api": {
"type": "integer",
"format": "int64",
"description": "Envios pela api para contatos, contados depois que o WhatsApp confirmou."
},
"sent_other": {
"type": "integer",
"format": "int64",
"description": "Envios para contatos que não saíram pela api (celular, outro aparelho). Pode incluir envios antigos de origem não identificada."
},
"received": {
"type": "integer",
"format": "int64",
"description": "Mensagens recebidas de contatos."
},
"group_sent_api": {
"type": "integer",
"format": "int64",
"description": "Envios pela api para grupos, contados depois que o WhatsApp confirmou."
},
"group_sent_other": {
"type": "integer",
"format": "int64",
"description": "Envios para grupos que não saíram pela api (celular, outro aparelho)."
},
"group_received": {
"type": "integer",
"format": "int64",
"description": "Mensagens recebidas em grupos."
},
"buckets": {
"type": "array",
"minItems": 24,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"start_at",
"sent_api",
"sent_other",
"received",
"group_sent_api",
"group_sent_other",
"group_received"
],
"properties": {
"sent_api": {
"type": "integer",
"format": "int64",
"description": "Envios pela api para contatos nesta hora."
},
"sent_other": {
"type": "integer",
"format": "int64",
"description": "Envios para contatos sem origem API identificada."
},
"received": {
"type": "integer",
"format": "int64",
"description": "Mensagens recebidas de contatos nesta hora."
},
"group_sent_api": {
"type": "integer",
"format": "int64",
"description": "Envios confirmados pela API para grupos."
},
"group_sent_other": {
"type": "integer",
"format": "int64",
"description": "Envios para grupos sem origem API identificada."
},
"group_received": {
"type": "integer",
"format": "int64",
"description": "Mensagens recebidas em grupos."
},
"start_at": {
"type": "string",
"format": "date-time",
"description": "Início da hora (UTC). ISO 8601 em UTC com milissegundos."
}
}
},
"description": "A janela dividida em horas UTC (24 ou 25 faixas), com os mesmos totais por hora."
},
"contacts": {
"type": "object",
"nullable": true,
"required": [
"contacted",
"returned",
"without_return",
"aliases_resolved"
],
"properties": {
"contacted": {
"type": "integer",
"description": "Contatos que receberam ao menos um envio da api na janela."
},
"returned": {
"type": "integer",
"description": "Desses, quantos mandaram mensagem ou reação depois do primeiro envio da api."
},
"without_return": {
"type": "integer",
"description": "`contacted` menos `returned`."
},
"aliases_resolved": {
"type": "boolean",
"description": "`false` quando a api não ligou algum LID ao número: o mesmo contato pode contar duas vezes."
}
},
"description": "Retorno dos contatos na janela. `null` quando não dá para calcular (o motivo vem em `contacts_unavailable`); os totais de mensagens continuam."
},
"contacts_unavailable": {
"type": "string",
"description": "Vazio quando `contacts` veio. Senão, o motivo: `too_many_contacts` (mais de 50 mil contatos na janela) ou `alias_lookup_failed` (falha ao ligar LID e número)."
},
"inventory": {
"type": "object",
"description": "Totais da inbox, sem o filtro de 24 horas. Cada um vem `null` quando a fonte não está disponível (nunca zero no lugar).",
"required": [
"chats",
"address_book_contacts",
"groups"
],
"properties": {
"chats": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Conversas gravadas na inbox, de contatos e grupos."
},
"address_book_contacts": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Contatos salvos na agenda do celular (com nome de agenda, não só o nome do perfil)."
},
"groups": {
"type": "integer",
"format": "int64",
"nullable": true,
"description": "Grupos e comunidades de que a inbox participa (grupos que ela deixou ficam fora)."
}
}
},
"session_ready": {
"type": "boolean",
"description": "A conexão com o WhatsApp está pronta para enviar agora."
},
"webhook_capture_started_at": {
"type": "string",
"format": "date-time",
"description": "Desde quando `webhook_errors` registra falhas (RFC 3339); vazio quando não se sabe."
},
"webhook_errors": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"required": [
"created_at",
"event",
"status_code",
"attempts",
"kind"
],
"properties": {
"created_at": {
"type": "string",
"format": "date-time",
"description": "Quando a falha aconteceu."
},
"event": {
"type": "string",
"description": "O evento que não foi entregue: `message.received` ou `message.sent`; `messages` quando o webhook está no formato antigo."
},
"status_code": {
"type": "integer",
"description": "Código HTTP que o seu servidor respondeu; `0` quando não houve resposta."
},
"attempts": {
"type": "integer",
"description": "Tentativas feitas."
},
"kind": {
"type": "string",
"enum": [
"http",
"timeout",
"connection",
"rejected"
],
"description": "`http` (seu servidor respondeu erro), `timeout` (não respondeu a tempo), `connection` (não deu para conectar) ou `rejected` (a entrega nem saiu: fila do webhook cheia ou reinício do servidor)."
}
}
},
"description": "Até 20 falhas recentes de entrega do webhook, das últimas 24 horas. Ficam gravadas e sobrevivem ao reinício; entram só as falhas de mensagens (as que o `POST /webhooks/resends` reenvia)."
},
"window_start_at": {
"type": "string",
"format": "date-time",
"description": "Início da janela (24 horas antes de `window_end`). ISO 8601 em UTC com milissegundos."
},
"window_end_at": {
"type": "string",
"format": "date-time",
"description": "Fim da janela (o momento do cálculo). ISO 8601 em UTC com milissegundos."
}
}
}
}
}
},
"401": {
"description": "Token ausente ou inválido.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "unauthorized",
"message": "Token inválido."
}
}
}
},
"409": {
"description": "`conflict`: a inbox ainda não sabe o próprio número (nunca conectou). Tente de novo depois de conectar.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "conflict",
"message": "A inbox ainda não sabe o próprio número (nunca conectou); tente de novo depois de conectar."
}
}
}
},
"429": {
"description": "`rate_limited`: mais de 120 consultas no minuto; espere o tempo do header `Retry-After`.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "rate_limited",
"message": "Muitas consultas; espere o tempo do Retry-After."
}
}
}
},
"500": {
"$ref": "#/components/responses/InternalError"
},
"501": {
"$ref": "#/components/responses/CloudUnsupported"
},
"503": {
"description": "`unavailable`: resumo temporariamente indisponível; não interpretar como contadores zerados.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "unavailable",
"message": "Resumo indisponível agora; tente de novo depois."
}
}
}
}
}
Estado: Disponível
Compatibilidade de canais
| Canal | Compatível | Observação |
|---|---|---|
| WhatsApp (Web) | Sim | |
| WhatsApp (API oficial) | Não | Só no WhatsApp Web por enquanto: responde 501. |
| Não | ||
| Messenger | Não | |
| Telegram | Não |
Eventos que esta rota gera
Nenhum. Esta rota não gera evento no webhook (nem em GET /events): o resultado vem só na resposta.
Antes e depois (uazapi → Orkesio)
Na uazapi: GET /message/activity.
- Caminho no padrão da Orkesio (
/messages/activity). - Datas em ISO 8601 (antes Unix ms);
webhook_errors[].created→created_at.
#/components/schemas/OrkesioError
{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Código estável do erro, em inglês e `snake_case`. Os de uso geral: `invalid_request` (400): pedido inválido: JSON malformado, campo desconhecido ou valor fora do permitido (o detalhe em `message`; o campo em `field`, quando é um só); `unauthorized` (401): `token` ou `admintoken` ausente ou inválido; `forbidden` (403): o token não pode fazer isso (no servidor de demonstração, por exemplo); `not_admin` (403): o WhatsApp recusou por falta de permissão no grupo ou na newsletter; `account_restricted` (403): o WhatsApp restringiu a conta de iniciar conversas novas (mandar para quem já conversa continua valendo; até quando, em `GET /inbox/limits`); `new_chat_limit` (403): a conta atingiu a cota do WhatsApp de conversas novas neste ciclo (veja `GET /inbox/limits`); os dois também no `error` de `OrkesioMessage` e de `message.status`, e não adianta repetir o envio; `payment_required` (403): na API oficial, a Meta recusou o envio por um problema no pagamento da conta do WhatsApp Business (erro 131042 da Meta); acerte a forma de pagamento no gerenciador da Meta, porque repetir não adianta; também no `error` de `OrkesioMessage` e de `message.status`; `whatsapp_rejected` (400): o WhatsApp recusou a mudança pedida (o campo, em `field`, quando é um só); `not_found` (404): o recurso não existe nesta inbox; `conflict` (409): o recurso já existe ou mudou (id em uso, inbox de outro canal); `inbox_not_paired` (409): a inbox ainda não conectou um número; `payload_too_large` (413): o corpo passou do limite; `canceled` e `expired`: só no `error` de `OrkesioMessage` e de `message.status` (envio cancelado antes de sair, ou que passou do prazo na fila); `rate_limited` (429): muitos pedidos; espere o `Retry-After`; `internal_error` (500): falha inesperada na api; tente de novo; `send_failed` (500): o envio falhou (o motivo em `message`); também no `error` de `OrkesioMessage` e de `message.status`; `unsupported_for_channel` (501): o canal da inbox não atende esta rota ou este tipo de mensagem; `meta_error` (502): a Meta recusou ou não respondeu; `disconnected` (503): a inbox está desconectada (sem sessão do WhatsApp, ou token do canal oficial vencido); `unavailable` (503 ou 504): o WhatsApp não respondeu a tempo, ou algo em andamento impede agora; tente de novo. Cada rota lista os códigos próprios dela (`outside_window`, `number_invalid`, `flow_invalid`...). A lista pode crescer: trate código desconhecido pelo status HTTP."
},
"message": {
"type": "string",
"description": "Descrição para pessoas (às vezes o texto do WhatsApp ou da Meta). Não compare o texto: use `error`."
},
"field": {
"type": "string",
"description": "O campo do pedido que causou o erro, quando é um só (por exemplo, o campo que o WhatsApp recusou num `PATCH`)."
}
},
"required": [
"error",
"message"
],
"additionalProperties": true,
"description": "O objeto de erro da Orkesio, o mesmo em todo lugar: o corpo das respostas de erro e o `error` de `OrkesioMessage`, `message.status` e `message.failed`. Algumas rotas juntam campos próprios (`request_id`, `errors`...)."
}
#/components/responses/InternalError
{
"description": "`internal_error`: falha inesperada na api (no banco, por exemplo); tente de novo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "internal_error",
"message": "Falha inesperada."
}
}
}
}
#/components/responses/CloudUnsupported
{
"description": "`unsupported_for_channel`: o canal da inbox não atende esta rota (rota só do WhatsApp Web numa inbox oficial, ou rota da API oficial numa inbox do WhatsApp Web). O canal está em `Inbox.channel`.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "unsupported_for_channel",
"message": "Esta rota não está disponível no canal da inbox."
}
}
}
}
Guias relacionados
Visão geral · O que funciona em cada canal · O que muda da uazapi