Marcar como lidas
POST /messages/read
Marca mensagens recebidas como lidas: quem enviou vê os tiques azuis no WhatsApp, "Visto" no Instagram e no Messenger, se a confirmação de leitura estiver ligada. Também zera as não lidas da conversa. Responde o resultado de cada mensagem; uma falha não impede as outras.
Autenticação
[
{
"token": []
}
]
{
"token": {
"name": "token",
"type": "apiKey",
"in": "header"
}
}
Corpo da requisição
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"message_ids"
],
"properties": {
"message_ids": {
"type": "array",
"minItems": 1,
"maxItems": 500,
"items": {
"type": "string"
},
"description": "As mensagens (o `id` de cada uma)."
}
}
},
"example": {
"message_ids": [
"3EB0A1B2C3D4E5F60718",
"3EB0F9E8D7C6B5A40312"
]
}
}
}
}
Respostas
{
"200": {
"description": "Resultado por mensagem.",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"required": [
"results"
],
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"message_id",
"ok"
],
"properties": {
"message_id": {
"type": "string",
"description": "A mensagem pedida."
},
"ok": {
"type": "boolean",
"description": "Marcada como lida."
},
"error": {
"type": "string",
"description": "Só com `ok: false`, o código: `not_found` (mensagem que a inbox não tem), `unsupported_message` (registro de ligação ou de entrada e saída de membro, que não é mensagem), `whatsapp_rejected` (o WhatsApp recusou) ou `internal_error`.",
"enum": [
"not_found",
"unsupported_message",
"whatsapp_rejected",
"internal_error"
]
}
}
}
}
}
},
"example": {
"results": [
{
"message_id": "3EB0A1B2C3D4E5F60718",
"ok": true
},
{
"message_id": "3EB0F9E8D7C6B5A40312",
"ok": false,
"error": "not_found"
}
]
}
}
}
},
"400": {
"description": "Pedido inválido.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "invalid_request",
"message": "message_ids aceita de 1 a 500 itens."
}
}
}
},
"401": {
"description": "Token inválido ou ausente.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "unauthorized",
"message": "Token inválido."
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"500": {
"$ref": "#/components/responses/InternalError"
},
"503": {
"$ref": "#/components/responses/Disconnected"
}
}
Estado: Disponível
Compatibilidade de canais
| Canal | Compatível | Observação |
|---|---|---|
| WhatsApp (Web) | Sim | |
| WhatsApp (API oficial) | Sim | |
| Sim | ||
| Messenger | Sim | |
| Telegram | Em parte | Só no Telegram Business. Na conversa com o bot o Telegram não mostra leitura (responde sem erro). |
Eventos que esta rota gera
O que chega no seu webhook (ou em GET /events) depois desta rota.
chat.updated: changes: [unread_count]
{
"id": "evt_01JAB3K9ZQ7V0M4T8R2X6WYD5H",
"type": "chat.updated",
"created_at": "2026-10-17T12:00:00.000Z",
"inbox": {
"id": "r0269625d29bfbd",
"name": "loja",
"phone": "5511888888888",
"channel": "whatsapp_web"
},
"data": {
"chat": {
"id": "5511999999999@s.whatsapp.net",
"type": "direct",
"name": "Maria",
"archived": false,
"unread_count": 0
},
"changes": [
"unread_count"
]
}
}
Antes e depois (uazapi → Orkesio)
Na uazapi: POST /message/markread.
id(lista) →message_ids;results[].status→okeerror.
#/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/Disconnected
{
"description": "`disconnected`: a inbox está desconectada do WhatsApp (a api esperou a sessão e tentou reconectar). `unavailable`: o WhatsApp não respondeu agora; tente de novo.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrkesioError"
},
"example": {
"error": "disconnected",
"message": "Instância desconectada do WhatsApp."
}
}
}
}
Guias relacionados
Visão geral · O que funciona em cada canal · O que muda da uazapi