Marcar mensaje como leído

POST

api

chat

markRead

:instance

Marcar mensaje como leído

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 o TokenInstance • Rate-limit: Global (100/min) • Idempotente: sí

Descripción

Envía el ACK de lectura para un mensaje específico, el efecto visible para el remitente es el “doble check azul”. Para marcar el chat completo de una vez, usa markChatRead.

En grupos, el campo sender (JID del autor del mensaje) es obligatorio. En conversaciones 1 a 1 es opcional y puede omitirse.

Ejemplos

DM

En una conversación 1 a 1, basta con messageId y el number del contacto. sender puede omitirse, el servidor infiere el autor a partir del JID del 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 (con sender)

En un grupo (@g.us), el campo sender con el JID del autor del mensaje es obligatorio, sin él WhatsApp no puede enrutar correctamente el ACK de lectura.

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)
}

Respuesta exitosa

La respuesta refleja el message_id que fue marcado y el chat_jid resuelto. Útil para auditar qué mensajes se marcaron como leídos, especialmente en flujos automáticos que confirman recepción tras procesar el mensaje.

200 OK

{
  "success": true,
  "message": "Message marked as read successfully",
  "message_id": "3EB08FCF27E532F1B0F5",
  "chat_jid": "5511999999999@s.whatsapp.net"
}

Parámetros de ruta

string

requerido

Nombre de la instancia.

Cabeceras

Nombre	Requerido	Ejemplo	Descripción
`Content-Type`	sí	`application/json`	,
`token`	sí (o `Authorization`)	`a1b2c3d4-...`	TokenAccount o TokenInstance.

Cuerpo de la solicitud

string

requerido

ID del mensaje a marcar como leído.

string

requerido

JID del chat: número de teléfono, JID privado (...@s.whatsapp.net o ...@lid), grupo (...@g.us) o newsletter.

string

JID del autor del mensaje (...@s.whatsapp.net o ...@lid). Obligatorio en grupos. Opcional en DMs.

Respuestas de error

HTTP	`error.message`	Cuándo ocurre
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`	Falta `sender` en un grupo.
401	`Invalid token`	,
404	`Instance not found`	,
503	`Instance is not connected to WhatsApp`	,

Error 400

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

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Marcar mensaje como leído

Descripción

Ejemplos

DM

Grupo (con sender)

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Respuestas de error

Relacionados

Marcar chat como leído

Estado de entrega

​Descripción

​Ejemplos

​DM

​Grupo (con sender)

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Respuestas de error

​Relacionados

Marcar chat como leído

Estado de entrega

Descripción

Ejemplos

DM

Grupo (con sender)

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Respuestas de error

Relacionados