Quem recebeu e leu
GET /messages/{message_id}/receipts
Mostra quem recebeu, leu ou ouviu uma mensagem que a inbox enviou num grupo, com os totais.
- Se a inbox já acompanha o grupo, responde na hora (
source: memory). Senão pergunta ao celular (source: phone), que precisa estar ligado e online; a espera vai até 40 segundos. - Depois da primeira consulta num grupo, a inbox acompanha as confirmações dele por 24 horas.
- As confirmações novas também chegam em
group.receipts.
Autenticação
[
{
"token": []
}
]
{
"token": {
"name": "token",
"type": "apiKey",
"in": "header"
}
}
Parâmetros
[
{
"name": "message_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"description": "A mensagem: o `id` dela."
},
{
"name": "status",
"in": "query",
"schema": {
"type": "string",
"enum": [
"delivered",
"read",
"played"
]
},
"description": "Só os recibos neste estado."
},
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 200,
"default": 50
},
"description": "Itens por página (1 a 200; padrão 50)."
},
{
"name": "cursor",
"in": "query",
"schema": {
"type": "string"
},
"description": "O `next_cursor` da página anterior. Sem ele, vem a primeira página."
}
]
Respostas
{
"200": {
"description": "Os recibos.",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"summary",
"receipts"
],
"properties": {
"summary": {
"type": "object",
"additionalProperties": false,
"properties": {
"delivered": {
"type": "integer",
"description": "Quantos receberam."
},
"read": {
"type": "integer",
"description": "Quantos leram."
}
}
},
"receipts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrkesioGroupReceipt"
}
},
"source": {
"type": "string",
"enum": [
"memory",
"phone"
],
"description": "`memory`: das confirmações que a inbox acompanha (na hora); `phone`: perguntado ao celular."
},
"next_cursor": {
"type": "string",
"description": "Cursor da próxima página: mande em `cursor`. Ausente na última página."
}
}
},
"example": {
"summary": {
"delivered": 12,
"read": 8
},
"source": "memory",
"receipts": [
{
"participant": {
"id": "5511999999999@s.whatsapp.net",
"phone": "5511999999999",
"lid": "123456789012345@lid"
},
"status": "read",
"at": "2026-10-17T12:03:00.000Z"
}
]
}
}
}
},
"400": {
"description": "Mensagem que não dá para pedir ao celular (registro de ligação, ids inválidos).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "invalid_request",
"message": "Registro de ligação não dá para pedir ao celular."
}
}
}
},
"401": {
"description": "Token inválido ou ausente.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "unauthorized",
"message": "Token inválido."
}
}
}
},
"404": {
"description": "Mensagem não encontrada.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "not_found",
"message": "Mensagem não encontrada."
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/InternalError"
},
"501": {
"$ref": "#/components/responses/CloudUnsupported"
},
"503": {
"description": "Não deu para perguntar ao celular (inbox desconectada, por exemplo).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "phone_unreachable",
"message": "Não deu para perguntar ao celular agora."
}
}
}
},
"504": {
"description": "O celular não respondeu em 40 segundos; ele precisa estar ligado e online.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "phone_timeout",
"message": "O celular não respondeu; ele precisa estar ligado e online."
}
}
}
}
}
Estado: Disponível
Compatibilidade de canais
| Canal | Compatível | Observação |
|---|---|---|
| WhatsApp (Web) | Sim | |
| WhatsApp (API oficial) | Não | A Orkesio não atende os grupos da API oficial. |
| 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: POST /message/status.
GETcom a mensagem no caminho (antesidno corpo);state→status(minúsculo); página porcursor.receipts[]:participant,participant_pn,participant_lid→participant(pessoa);state→status;timestamp→at.
#/components/schemas/OrkesioGroupReceipt
{
"type": "object",
"properties": {
"participant": {
"$ref": "#/components/schemas/OrkesioParticipant"
},
"status": {
"type": "string",
"enum": [
"delivered",
"read",
"played"
],
"description": "Recebeu, leu ou ouviu."
},
"at": {
"type": "string",
"format": "date-time",
"description": "Quando. ISO 8601 em UTC com milissegundos."
}
},
"required": [
"participant",
"status",
"at"
],
"additionalProperties": false,
"description": "Recibo de um participante do grupo."
}
#/components/schemas/OrkesioParticipant
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Identificador da pessoa no canal (opaco). No WhatsApp é `<número>@s.whatsapp.net` ou `<BSUID>@bsuid`; em outros canais, o id deles. Não conte com ele ser telefone: use `phone`."
},
"phone": {
"type": "string",
"description": "Telefone (só dígitos), quando o canal informa."
},
"username": {
"type": "string",
"description": "Nome de usuário (@), quando o canal informa."
},
"lid": {
"type": "string",
"description": "**Só WhatsApp.** LID, quando conhecido.",
"x-only": "whatsapp"
},
"name": {
"type": "string",
"description": "Nome visível (push name), quando conhecido."
},
"picture_url": {
"type": "string",
"description": "Foto de perfil, quando conhecida."
}
},
"required": [
"id"
],
"additionalProperties": false,
"description": "Pessoa: autor de mensagem, participante de grupo, quem fez uma ação."
}
#/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/RateLimited
{
"description": "`rate_limited`: passou do limite de chamadas desta inbox (ou do admin); espere o tempo do header `Retry-After` e tente de novo.",
"headers": {
"Retry-After": {
"description": "Segundos até poder chamar de novo.",
"schema": {
"type": "integer",
"minimum": 1
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "rate_limited",
"message": "Muitas requisições."
}
}
}
}
#/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