Pular para o conteúdo principal

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.

Esta é a referência completa da API. Os endpoints estão organizados em módulos, onde cada um cobre um aspecto específico do WhatsApp. Se você está começando, a leitura recomendada é: Início rápido → Conceitos → Autenticação antes de mergulhar em um módulo específico.

​
URL base e convenções

  • Base URL: https://ryzeapi.cloud
  • Path prefix: todos os endpoints começam com /api/<módulo>/...
  • Probe de saúde: /health (sem prefixo /api/)
  • Eventos em tempo real: /ws/:instance (WebSocket)
  • Content-Type: application/json em todo POST / PUT / DELETE com body
  • Autenticação: header token em todas as rotas (veja Autenticação)
  • Rate limit: 100 req/min por padrão; criação de instância tem limite estrito de 20 req/min
  • Body máximo: 64 MB por requisição (cobre uploads em base64)

​
Módulos

Instância

Criar, conectar, configurar e operar suas instâncias de WhatsApp.

Mensagens

Texto, mídia, sticker, localização, contato, reação, enquete, carrossel, botões, lista, formulário, PIX e status.

Chat

Contatos, etiquetas, arquivar, fixar, mute, presença, histórico, encaminhar, editar, apagar e mais.

Grupos

Criar grupos, gerenciar participantes, links de convite e moderação.

Comunidades

Criar comunidades e vincular subgrupos.

Newsletter

Criar canais (channels) e gerenciar inscrições.

Perfil

Nome, foto, recado e privacidade da conta WhatsApp conectada.

Eventos

Webhooks (com fila persistida + retry) e WebSockets em tempo real.

WebSocket

Upgrade /ws/:instance, protocolo, heartbeat, reconexão.

Chatwoot

Integração com Chatwoot via bridge (RyzeIntegrations).

Observabilidade

/health, probe combinado para orquestradores.

​
Formato das respostas

Toda chamada retorna um JSON com o campo success indicando o resultado: 
{
  "success": true,
  "message": "Message sent successfully",
  "status": "sent",
  "data": { "...": "..." }
}
O envelope de erro tem apenas success + error.message, não existe campo code numérico. A diferenciação programática usa o status HTTP + texto da mensagem. Veja Tipos de erro para o catálogo completo de mensagens.

​
Identificadores WhatsApp (JIDs)

TipoFormatoExemplo
Privado<phone>@s.whatsapp.net5511999999999@s.whatsapp.net
Grupo<id>@g.us120363406289005073@g.us
Newsletter<id>@newsletter120363422585881117@newsletter
LID (oculto)<id>@lid199789077627112@lid
Broadcast (status)status@broadcaststatus@broadcast
A maioria dos endpoints aceita número simples (5511999999999) e converte internamente. Para números brasileiros (com prefixo 55), a API tenta variações com/sem o “9” extra após o DDD.

​
Glossário rápido

  • JID, identificador único no WhatsApp (contato, grupo, canal, LID).
  • Conta, seu espaço na RyzeAPI, identificado pelo TokenAccount.
  • Instância, uma conexão ativa com um número de WhatsApp.
  • TokenAccount, token de conta; usado para criar/listar/deletar instâncias e operar qualquer instância da conta.
  • TokenInstance, token específico de uma instância; usado nas operações do dia a dia daquela instância.
  • Webhook, POST que a API faz para sua URL quando um evento acontece (com retry exponencial e DLQ).
  • WebSocket, conexão persistente para receber eventos em tempo real.
  • RyzeIntegrations, microserviço opcional (bridge) que conecta a RyzeAPI a integrações externas, como o Chatwoot.

​
Variáveis em exemplos

A Base URL é sempre https://ryzeapi.cloud. Os exemplos usam estas variáveis:
VariávelSignificado
$Token_AccountSeu TokenAccount
$Token_InstanceTokenInstance de uma instância específica
$Instance_NameNome da instância (ex.: minhaInstancia)