# Mostrar digitando ou gravando POST /chats/presence Mostra "digitando..." ou "gravando áudio..." para o contato nesta conversa. A api renova o aviso a cada 12 a 18 segundos até acabar o tempo (padrão e máximo de 5 minutos). Para antes quando a inbox envia uma mensagem na conversa ou com `state: paused`. Um pedido novo na mesma conversa substitui o anterior. ## Autenticação ```json [ { "token": [] } ] ``` ```json { "token": { "name": "token", "type": "apiKey", "in": "header" } } ``` ## Corpo da requisição ```json { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "required": [ "chat_id", "state" ], "properties": { "chat_id": { "type": "string", "description": "A conversa: o `chat.id` (o número sozinho também vale)." }, "state": { "type": "string", "enum": [ "typing", "recording", "paused" ], "description": "`typing` (digitando), `recording` (gravando áudio) ou `paused` (para). Os nomes do evento `chat.presence`." }, "duration_ms": { "type": "integer", "minimum": 1, "maximum": 300000, "description": "Por quanto tempo mostrar, em milissegundos. Sem ele, ou acima de 300000, vale 5 minutos." } } }, "example": { "chat_id": "5511999999999@s.whatsapp.net", "state": "typing", "duration_ms": 5000 } } } } ``` ## Respostas ```json { "202": { "description": "Aceito: o aviso já está sendo mostrado." }, "400": { "description": "`invalid_request`: `state` fora da lista ou campo desconhecido. `no_received_message`: na API oficial, a conversa ainda não tem mensagem recebida.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrkesioError" }, "example": { "error": "invalid_request", "message": "state aceita typing, recording ou paused." } } } }, "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) | Em parte | Mostra só "digitando" (também com `recording`) e marca como lida a última mensagem recebida da conversa; a Meta tira o aviso na resposta ou em até 25 s, e `duration_ms` não vale. Sem mensagem recebida na conversa, `400`. | | Instagram | Em parte | Só "digitando" (também com `recording`); some sozinho. `paused` e `duration_ms` não valem. | | Messenger | Em parte | Só "digitando" (também com `recording`); `paused` tira no Messenger. `duration_ms` não vale. | | Telegram | Em parte | Só "digitando" (também com `recording`), por até 5 s ou até a próxima mensagem; `paused` e `duration_ms` não valem. | ## Eventos que esta rota gera Nenhum. Quem vê o "digitando..." é o contato; a inbox não recebe aviso da própria presença. ## Antes e depois (uazapi → Orkesio) Na uazapi: `POST /message/presence`. - `number` → `chat_id`; `presence` → `state` (`composing` → `typing`) (o antigo `pause: true` vira `state: paused`); `delay` → `duration_ms`. Responde `202` sem corpo. ## #/components/schemas/OrkesioError ```json { "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 ```json { "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 ```json { "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 ```json { "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](/docs/overview) · [O que funciona em cada canal](/docs/canais) · [O que muda da uazapi](/docs/o-que-muda)