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.
O que é a RyzeAPI
A RyzeAPI é um gateway REST que transforma o WhatsApp em uma API moderna, permitindo que sistemas, CRMs, bots, automações e dashboards enviem e recebam mensagens, gerenciem grupos, publiquem em canais e reajam a eventos em tempo real, sem lidar com a complexidade do protocolo interno do WhatsApp Web. Você envia uma requisição HTTP, a RyzeAPI cuida do resto.Mensagens em qualquer formato
Texto, mídia, stickers, localização, contatos, reações, enquetes, carrosséis, listas, botões, formulários e até PIX.
Múltiplas instâncias por conta
Gerencie vários números de WhatsApp simultaneamente, cada um com token próprio e configurações isoladas.
Eventos em tempo real
Receba mensagens, status de entrega e mudanças de grupo via webhook ou WebSocket. Até 3 webhooks simultâneos por instância.
Recursos nativos avançados
Carrosséis, botões interativos, listas, formulários e botões PIX, recursos normalmente indisponíveis em APIs genéricas do WhatsApp.
O que você pode fazer
A RyzeAPI cobre o ciclo completo de integração com o WhatsApp:- Conversas 1-a-1 e em grupo, envie e receba qualquer tipo de conteúdo
- Gestão de contatos, liste, organize em etiquetas, bloqueie, favorite
- Grupos, crie, convide, modere, atualize nome/descrição/foto, gerencie participantes
- Comunidades, crie comunidades e vincule seus grupos
- Canais (newsletters), publique em broadcast para seguidores
- Perfil da conta, nome, foto, privacidade
- Stories (status), publique status que somem em 24h
- Eventos ao vivo, webhooks e WebSockets para reagir em tempo real
Arquitetura da sua integração
Entender estes 3 níveis ajuda a desenhar sua aplicação corretamente:Sua conta (Account)
Seu espaço na RyzeAPI. Tem um TokenAccount único e um limite de quantas instâncias você pode criar.
Suas instâncias (Instance)
Cada instância é uma conexão ativa com um número de WhatsApp. Uma conta pode ter várias, por exemplo, uma para vendas, outra para suporte, outra para marketing.Cada instância recebe um TokenInstance próprio ao ser criada.
Primeiros passos
Início rápido
Conecte seu WhatsApp e envie sua primeira mensagem em menos de 5 minutos.
Conceitos
Entenda os conceitos centrais antes de mergulhar nos endpoints.
Autenticação
Como usar TokenAccount e TokenInstance.
Tipos de erro
Formatos de resposta e como tratar cada código HTTP.
Explore os módulos
A API é organizada em módulos. Cada um agrupa endpoints que cuidam de um aspecto específico do WhatsApp.Instância
Criar, conectar, desconectar, ajustar configurações.
Mensagens
Enviar todos os tipos: texto, mídia, botões, carrosséis, listas.
Chat
Contatos, etiquetas, arquivar, fixar, editar, apagar mensagens.
Grupos
Criar grupos, gerenciar participantes, links de convite.
Comunidades
Criar comunidades e vincular seus grupos.
Newsletter
Criar e gerenciar canais de broadcast.
Perfil
Nome, foto e privacidade da conta WhatsApp.
Eventos
Configurar webhooks e WebSockets por instância.
WebSocket
Conexão persistente para eventos em tempo real.
Chatwoot
Integração com Chatwoot via RyzeIntegrations bridge.