Saltar al contenido principal
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>"
}
'

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 o TokenInstanceRate-limit: Global (100/min) • Idempotente:

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

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

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

instance
string
requerido
Nombre de la instancia.

Cabeceras

NombreRequeridoEjemploDescripción
Content-Typeapplication/json
tokensí (o Authorization)a1b2c3d4-...TokenAccount o TokenInstance.

Cuerpo de la solicitud

messageId
string
requerido
ID del mensaje a marcar como leído.
number
string
requerido
JID del chat: número de teléfono, JID privado (...@s.whatsapp.net o ...@lid), grupo (...@g.us) o newsletter.
sender
string
JID del autor del mensaje (...@s.whatsapp.net o ...@lid). Obligatorio en grupos. Opcional en DMs.

Respuestas de error

HTTPerror.messageCuándo ocurre
400Instance name is required
400Invalid request body: <...>JSON malformado.
400messageId is required
400Number is required
400sender is required for group messagesFalta sender en un grupo.
401Invalid token
404Instance not found
503Instance is not connected to WhatsApp
Error 400
{
  "success": false,
  "error": { "message": "sender is required for group messages" }
}

Relacionados

Marcar chat como leído

Marca el chat completo de una vez.

Estado de entrega

Verifica el estado actual del mensaje.