Marcar chat como leído

POST

api

chat

markChatRead

:instance

Marcar chat como leído

curl --request POST \
  --url https://api.example.com/api/chat/markChatRead/:instance \
  --header 'Content-Type: application/json' \
  --data '
{
  "number": "<string>",
  "read": true
}
'

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

fetch('https://api.example.com/api/chat/markChatRead/: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/markChatRead/:instance"

payload = {
    "number": "<string>",
    "read": True
}
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

Marca todos los mensajes no leídos de un chat como leídos (read: true) o deshace la marca (read: false). Es equivalente a abrir el chat en el teléfono: el contador de mensajes nuevos se resetea.

Para marcar un único mensaje (sin resetear el contador), usa markRead.

Ejemplos

Marcar como leído

Con read: true, marca todos los mensajes no leídos del chat como leídos y resetea el contador, equivalente a abrir la conversación en el teléfono.

curl -X POST "https://ryzeapi.cloud/api/chat/markChatRead/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "read":   true
  }'

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

import os, requests

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

package main

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

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

Marcar como no leído

Con read: false, restaura el estado “no leído” en el chat para que aparezca destacado en la lista nuevamente, útil para revisar una conversación más tarde.

curl -X POST "https://ryzeapi.cloud/api/chat/markChatRead/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "read":   false
  }'

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

import os, requests

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

package main

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

func main() {
    body := strings.NewReader(`{
        "number": "5511999999999",
        "read":   false
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/chat/markChatRead/"+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 confirma la operación con chat_jid (JID resuelto desde number) y read reflejando el estado final. El message cambia según el valor de read: "Chat marked as read successfully" o "Chat marked as unread successfully".

200 OK

{
  "success": true,
  "message": "Chat marked as read successfully",
  "chat_jid": "5511999999999@s.whatsapp.net",
  "read": true
}

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

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

boolean

requerido

true marca como leído, false marca como no leído.

Respuestas de error

HTTP	`error.message`	Cuándo ocurre
400	`Instance name is required`	,
400	`Invalid request body: <...>`	JSON malformado.
400	`Number is required`	,
401	`Invalid token`	,
404	`Instance not found`	,
503	`Instance is not connected to WhatsApp`	,

Error 400

{
  "success": false,
  "error": { "message": "Number is required" }
}

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Marcar chat como leído

Descripción

Ejemplos

Marcar como leído

Marcar como no leído

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Respuestas de error

Relacionados

Marcar mensaje como leído

Archivar chat

​Descripción

​Ejemplos

​Marcar como leído

​Marcar como no leído

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Respuestas de error

​Relacionados

Marcar mensaje como leído

Archivar chat

Descripción

Ejemplos

Marcar como leído

Marcar como no leído

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Respuestas de error

Relacionados