Marcar chat como lido

POST

api

chat

markChatRead

:instance

Marcar chat como lido

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

Descrição

Marca todas as mensagens não-lidas de um chat como lidas (read: true) ou desfaz a marcação (read: false). É equivalente a abrir o chat no celular: o badge de mensagens novas zera.

Para marcar uma única mensagem (sem zerar o badge), use markRead.

Exemplos

Marcar como lido

Com read: true, marca todas as mensagens não-lidas do chat como lidas e zera o badge, equivalente a abrir a conversa no celular.

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 não-lido

Com read: false, restaura o estado de “não-lido” no chat para que ele volte a aparecer destacado na lista, útil para revisitar uma conversa mais 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)
}

Resposta de sucesso

A resposta confirma a operação com chat_jid (JID resolvido a partir do number) e read refletindo o estado final. A message muda conforme o valor de read: "Chat marked as read successfully" ou "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 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

Telefone, JID privado (...@s.whatsapp.net ou ...@lid), JID de grupo (...@g.us) ou newsletter.

boolean

obrigatório

true marca como lido, false marca como não-lido.

Respostas de erro

HTTP	`error.message`	Quando ocorre
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`	,

Erro 400

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

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Marcar chat como lido

Descrição

Exemplos

Marcar como lido

Marcar como não-lido

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Respostas de erro

Relacionados

Marcar mensagem como lida

Arquivar chat

​Descrição

​Exemplos

​Marcar como lido

​Marcar como não-lido

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Respostas de erro

​Relacionados

Marcar mensagem como lida

Arquivar chat

Descrição

Exemplos

Marcar como lido

Marcar como não-lido

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Respostas de erro

Relacionados