Visão Geral - RyzeAPI

O módulo Chat agrupa tudo o que acontece depois que uma mensagem entra ou sai, gestão de contatos, organização com etiquetas, controle do estado dos chats (arquivar, fixar, silenciar, bloquear) e ações sobre mensagens individuais (editar, apagar, encaminhar, favoritar). É o módulo mais amplo da API: vai de uma chamada simples como “listar contatos” até fluxos completos como “criar uma etiqueta, atribuir a vários chats e depois listar tudo que tem essa etiqueta”.

Todas as rotas aceitam TokenAccount ou TokenInstance e validam ownership da instância antes de operar.

Endpoints

Método	Path	Função
GET	`/api/chat/contacts/:instance`	Listar/buscar contatos
GET	`/api/chat/contactsByLabel/:instance`	Chats filtrados por etiqueta
GET	`/api/chat/getMessage/:instance`	Buscar mensagem por ID
GET	`/api/chat/tag/:instance`	Listar etiquetas
POST	`/api/chat/tag/:instance`	Criar etiqueta
DELETE	`/api/chat/tag/:instance`	Deletar etiqueta
POST	`/api/chat/assignTag/:instance`	Aplicar etiqueta a chat
DELETE	`/api/chat/assignTag/:instance`	Remover etiqueta de chat
POST	`/api/chat/archive/:instance`	Arquivar/desarquivar
POST	`/api/chat/markRead/:instance`	Marcar mensagem como lida
POST	`/api/chat/markChatRead/:instance`	Marcar chat inteiro como lido
POST	`/api/chat/pinChat/:instance`	Fixar/desafixar chat
POST	`/api/chat/pinMessage/:instance`	Fixar/desafixar mensagem
POST	`/api/chat/favorite/:instance`	Favoritar chat ou mensagem
POST	`/api/chat/mute/:instance`	Silenciar
POST	`/api/chat/block/:instance`	Bloquear/desbloquear contato
POST	`/api/chat/presence/:instance`	Enviar presença (typing/recording)
POST	`/api/chat/history/:instance`	Histórico do chat
GET	`/api/chat/base64/:instance`	Mídia em base64
GET	`/api/chat/status/:instance`	Status de entrega de mensagem
GET	`/api/chat/poll/:instance`	Votos de uma enquete
POST	`/api/chat/forward/:instance`	Encaminhar mensagem
POST	`/api/chat/edit/:instance`	Editar mensagem
DELETE	`/api/chat/delete/:instance`	Apagar mensagem
DELETE	`/api/chat/deleteChat/:instance`	Apagar chat inteiro

Contatos

Consulta de contatos sincronizados e filtragem por etiquetas.

Listar contatos

GET /api/chat/contacts/:instance

Contatos por etiqueta

GET /api/chat/contactsByLabel/:instance

Etiquetas (tags / labels)

Crie etiquetas, aplique aos chats e use-as como filtro, exatamente como o WhatsApp Business permite, mas via API.

Listar etiquetas

GET /api/chat/tag/:instance

Criar etiqueta

POST /api/chat/tag/:instance

Deletar etiqueta

DELETE /api/chat/tag/:instance

Atribuir etiqueta

POST /api/chat/assignTag/:instance

Desatribuir etiqueta

DELETE /api/chat/assignTag/:instance

Estado do chat

Controle como cada conversa aparece para o usuário do WhatsApp, arquivar, fixar, silenciar, favoritar, bloquear.

Arquivar chat

POST /api/chat/archive/:instance

Fixar chat

POST /api/chat/pinChat/:instance

Fixar mensagem

POST /api/chat/pinMessage/:instance

Silenciar chat

POST /api/chat/mute/:instance

Favoritar chat ou mensagem

POST /api/chat/favorite/:instance

Bloquear / desbloquear

POST /api/chat/block/:instance

Leitura

Marcar mensagem como lida

POST /api/chat/markRead/:instance

Marcar chat como lido

POST /api/chat/markChatRead/:instance

Presença

Enviar presença (digitando/gravando)

POST /api/chat/presence/:instance, mostra typing ou recording para o contato.

Histórico

Solicitar histórico

POST /api/chat/history/:instance, mensagens armazenadas com filtros opcionais por data.

Mensagens

Ações sobre mensagens específicas, além de utilitários para baixar mídia, ler enquetes e checar status de entrega.

Buscar mensagem por ID

GET /api/chat/getMessage/:instance

Encaminhar mensagem

POST /api/chat/forward/:instance

Editar mensagem

POST /api/chat/edit/:instance

Apagar mensagem

DELETE /api/chat/delete/:instance

Apagar chat inteiro

DELETE /api/chat/deleteChat/:instance

Mídia em base64

GET /api/chat/base64/:instance

Status de entrega

GET /api/chat/status/:instance

Votos de enquete

GET /api/chat/poll/:instance

Identificadores aceitos

A maioria dos endpoints aceita os mesmos formatos para identificar chat ou destino. A tabela abaixo resume:

Endpoint	Aceita
Maioria (`number`)	Número (`5511...`), JID privado (`...@s.whatsapp.net` ou `...@lid`), JID grupo (`...@g.us`), JID newsletter
`markRead` em grupo	Exige `sender` (JID do autor da mensagem, `...@s.whatsapp.net` ou `...@lid`)
`forward` (`to`)	Mesmo conjunto que `number`

Sobre @lid (LinkedID): identificador alternativo que o WhatsApp usa para usuários individuais quando o número de telefone não está exposto (privacidade em comunidades, grupos grandes, etc.). É equivalente ao ...@s.whatsapp.net para fins de roteamento, qualquer endpoint que aceite JID privado também aceita @lid. Use o JID exato vindo de webhook ou de respostas anteriores da API; não tente converter @lid em número.

Janelas do WhatsApp

Ação	Limite
Editar mensagem	~15 minutos após envio
Apagar para todos (`deleteForEveryone: true`)	~2 dias e 12 h após envio
Após a janela	Apenas exclusão local (`delete_for_me`)

Padrões de uso

Workflow de etiquetas

# 1. Criar etiqueta
curl -X POST "https://ryzeapi.cloud/api/chat/tag/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"name":"VIP","color":3}'

# 2. Aplicar a um chat
curl -X POST "https://ryzeapi.cloud/api/chat/assignTag/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"number":"5511999999999","tagId":"1"}'

# 3. Listar chats com a etiqueta
curl "https://ryzeapi.cloud/api/chat/contactsByLabel/$Instance_Name?labelIds=1" \
  -H "token: $Token_Instance"

# 4. Remover etiqueta do chat
curl -X DELETE "https://ryzeapi.cloud/api/chat/assignTag/$Instance_Name?number=5511999999999&tagId=1" \
  -H "token: $Token_Instance"

Workflow de moderação

# 1. Marcar como lido
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}'

# 2. Silenciar 8h
curl -X POST "https://ryzeapi.cloud/api/chat/mute/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"number":"5511999999999","mute":true,"duration":"8h"}'

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

# 4. Bloquear (último recurso)
curl -X POST "https://ryzeapi.cloud/api/chat/block/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{"number":"5511999999999","block":true}'

Relacionados

Enviar mensagens

Enviar conteúdo antes de gerenciar.

Eventos em tempo real

Webhooks message.exchange, message.status e label.update.

​Endpoints

​Contatos

Listar contatos

Contatos por etiqueta

​Etiquetas (tags / labels)

Listar etiquetas

Criar etiqueta

Deletar etiqueta

Atribuir etiqueta

Desatribuir etiqueta

​Estado do chat

Arquivar chat

Fixar chat

Fixar mensagem

Silenciar chat

Favoritar chat ou mensagem

Bloquear / desbloquear

​Leitura

Marcar mensagem como lida

Marcar chat como lido

​Presença

Enviar presença (digitando/gravando)

​Histórico

Solicitar histórico

​Mensagens

Buscar mensagem por ID

Encaminhar mensagem

Editar mensagem

Apagar mensagem

Apagar chat inteiro

Mídia em base64

Status de entrega

Votos de enquete

​Identificadores aceitos

​Janelas do WhatsApp

​Padrões de uso

​Workflow de etiquetas

​Workflow de moderação

​Relacionados

Enviar mensagens

Eventos em tempo real

Endpoints

Contatos

Etiquetas (tags / labels)

Estado do chat

Leitura

Presença

Histórico

Mensagens

Identificadores aceitos

Janelas do WhatsApp

Padrões de uso

Workflow de etiquetas

Workflow de moderação

Relacionados