Pular para o conteúdo principal
GET
/
api
/
chat
/
status
/
:instance
Status de entrega da mensagem
curl --request GET \
  --url https://api.example.com/api/chat/status/:instance

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

​
Descrição

Retorna o status de entrega de uma mensagem enviada, equivalente aos checks (cinza, duplo, azul) que aparecem no WhatsApp. O status é atualizado em tempo real conforme eventos do WhatsMeow informam que a mensagem foi recebida pelo servidor, entregue ao destinatário, lida ou reproduzida.
Para receber a evolução do status em tempo real, assine o webhook message.status. Este endpoint é a leitura pontual do snapshot atual.

​
Mapa de status

status (string)status_codeSemântica
pending0Aguardando ACK do servidor.
sent1ACK do servidor (check simples).
delivered2Entregue ao celular do destinatário (check duplo).
received3Mensagem recebida (apenas para direction = "received").
read4Lida pelo destinatário (check azul).
played5Áudio/vídeo reproduzido.
error-1Falha permanente de envio.

​
Exemplo

curl -X GET "https://ryzeapi.cloud/api/chat/status/$Instance_Name?messageId=3EB08FCF27E532F1B0F5" \
  -H "token: $Token_Instance"

​
Resposta de sucesso

status é o estado textual (sent, received, delivered, read, played, error, pending) e status_code traz o código numérico equivalente do WhatsMeow (0–5). direction distingue mensagens enviadas pela instância ("sent") das recebidas ("received"). timestamp é o instante em que a mensagem trafegou.
200 OK
{
  "success": true,
  "message": "Message status retrieved successfully",
  "message_id": "3EB08FCF27E532F1B0F5",
  "status": "read",
  "status_code": 4,
  "direction": "sent",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "timestamp": "2026-04-28T14:30:00Z"
}

​
Parâmetros de rota

​
instance
string
obrigatório
Nome da instância.

​
Query params

​
messageId
string
obrigatório
ID da mensagem cujo status deseja consultar.

​
Headers

NomeObrigatórioExemploDescrição
tokensim (ou Authorization)a1b2c3d4-...TokenAccount ou TokenInstance.

​
Respostas de erro

HTTPerror.messageQuando ocorre
400Instance name is required—
400messageId query parameter is required—
401Invalid token—
404Instance not found—
404Message not foundmessageId inexistente.
404Message does not belong to this instanceMensagem pertence a outra instância.
Erro 404
{
  "success": false,
  "error": { "message": "Message not found" }
}

​
Notas e gotchas

  • played (5) só faz sentido para áudio e vídeo, mensagens de texto não chegam a esse estado.
  • Pode haver um delay de 1 a 3 segundos entre a ação no celular do destinatário e o status atualizado aqui.
  • Para acompanhar várias mensagens em tempo real, prefira o webhook message.status em vez de polling.

​
Relacionados

Buscar mensagem

Recuperar conteúdo e metadados.

Marcar como lida

Sinalizar que você já leu uma mensagem recebida.