Marcar mensagem como lida

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>"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({messageId: '<string>', number: '<string>', sender: '<string>'})
};

fetch('https://api.example.com/api/chat/markRead/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/chat/markRead/:instance"

payload = {
    "messageId": "<string>",
    "number": "<string>",
    "sender": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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"
  }'

await fetch(`https://ryzeapi.cloud/api/chat/markRead/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    messageId: "3EB08FCF27E532F1B0F5",
    number:    "5511999999999"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/chat/markRead/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "messageId": "3EB08FCF27E532F1B0F5",
        "number":    "5511999999999"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "messageId": "3EB08FCF27E532F1B0F5",
        "number":    "5511999999999"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/markRead/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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"
  }'

await fetch(`https://ryzeapi.cloud/api/chat/markRead/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    messageId: "3EB08FCF27E532F1B0F5",
    number:    "120363123456789@g.us",
    sender:    "5511999999999@s.whatsapp.net"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/chat/markRead/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "messageId": "3EB08FCF27E532F1B0F5",
        "number":    "120363123456789@g.us",
        "sender":    "5511999999999@s.whatsapp.net"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "messageId": "3EB08FCF27E532F1B0F5",
        "number":    "120363123456789@g.us",
        "sender":    "5511999999999@s.whatsapp.net"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/markRead/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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

string

obrigatório

Nome da instância.

Headers

Nome	Obrigatório	Exemplo	Descrição
`Content-Type`	sim	`application/json`	,
`token`	sim (ou `Authorization`)	`a1b2c3d4-...`	TokenAccount ou TokenInstance.

Request body

string

obrigatório

ID da mensagem que será marcada como lida.

string

obrigatório

JID do chat: telefone, JID privado (...@s.whatsapp.net ou ...@lid), grupo (...@g.us) ou newsletter.

string

JID do autor da mensagem (...@s.whatsapp.net ou ...@lid). Obrigatório em grupos. Em DM, opcional.

Respostas de erro

HTTP	`error.message`	Quando ocorre
400	`Instance name is required`	,
400	`Invalid request body: <...>`	JSON malformado.
400	`messageId is required`	,
400	`Number is required`	,
400	`sender is required for group messages`	Faltou `sender` em grupo.
401	`Invalid token`	,
404	`Instance not found`	,
503	`Instance is not connected to WhatsApp`	,

Erro 400

{
  "success": false,
  "error": { "message": "sender is required for group messages" }
}

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Marcar mensagem como lida

Descrição

Exemplos

DM

Grupo (com sender)

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Respostas de erro

Relacionados

Marcar chat como lido

Status de entrega

​Descrição

​Exemplos

​DM

​Grupo (com sender)

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Respostas de erro

​Relacionados

Marcar chat como lido

Status de entrega

Descrição

Exemplos

DM

Grupo (com sender)

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Respostas de erro

Relacionados