Pular para o conteúdo principal
POST
/
api
/
chat
/
markRead
/
:instance
Marcar mensagem como lida
curl --request POST \
  --url https://api.example.com/api/chat/markRead/:instance \
  --header 'Content-Type: application/json' \
  --data '
{
  "messageId": "<string>",
  "number": "<string>",
  "sender": "<string>"
}
'

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

Envia o ACK de leitura para uma mensagem específica, o efeito visível para o remetente é o “check azul”. Para marcar o chat inteiro de uma vez, use markChatRead.
Em grupos, o campo sender (JID do autor da mensagem) é obrigatório. Em conversas 1-a-1, é opcional, pode ser omitido.

​
Exemplos

​
DM

Em conversa 1-a-1, basta messageId e number do contato. O sender é dispensado, o servidor infere o autor a partir do JID do chat. 
curl -X POST "https://ryzeapi.cloud/api/chat/markRead/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "messageId": "3EB08FCF27E532F1B0F5",
    "number":    "5511999999999"
  }'

​
Grupo (com sender)

Em grupo (@g.us), o campo sender com o JID do autor da mensagem é obrigatório, sem ele o WhatsApp não consegue rotear o ACK de leitura corretamente. 
curl -X POST "https://ryzeapi.cloud/api/chat/markRead/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "messageId": "3EB08FCF27E532F1B0F5",
    "number":    "120363123456789@g.us",
    "sender":    "5511999999999@s.whatsapp.net"
  }'

​
Resposta de sucesso

A resposta ecoa o message_id marcado e o chat_jid resolvido. Útil para auditar quais mensagens foram marcadas como lidas, especialmente em fluxos automáticos que confirmam recibo após processar a mensagem.
200 OK
{
  "success": true,
  "message": "Message marked as read successfully",
  "message_id": "3EB08FCF27E532F1B0F5",
  "chat_jid": "5511999999999@s.whatsapp.net"
}

​
Parâmetros de rota

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

​
Headers

NomeObrigatórioExemploDescrição
Content-Typesimapplication/json—
tokensim (ou Authorization)a1b2c3d4-...TokenAccount ou TokenInstance.

​
Request body

​
messageId
string
obrigatório
ID da mensagem que será marcada como lida.
​
number
string
obrigatório
JID do chat: telefone, JID privado (...@s.whatsapp.net ou ...@lid), grupo (...@g.us) ou newsletter.
​
sender
string
JID do autor da mensagem (...@s.whatsapp.net ou ...@lid). Obrigatório em grupos. Em DM, opcional.

​
Respostas de erro

HTTPerror.messageQuando ocorre
400Instance name is required—
400Invalid request body: <...>JSON malformado.
400messageId is required—
400Number is required—
400sender is required for group messagesFaltou sender em grupo.
401Invalid token—
404Instance not found—
503Instance is not connected to WhatsApp—
Erro 400
{
  "success": false,
  "error": { "message": "sender is required for group messages" }
}

​
Relacionados

Marcar chat como lido

Marca o chat inteiro de uma vez.

Status de entrega

Conferir o status atual da mensagem.