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.
Qué es RyzeAPI
RyzeAPI es una pasarela REST que convierte WhatsApp en una API moderna, permitiendo que sistemas, CRMs, bots, automatizaciones y dashboards envíen y reciban mensajes, gestionen grupos, publiquen en canales y reaccionen a eventos en tiempo real, sin tener que lidiar con la complejidad del protocolo interno de WhatsApp Web. Tú envías una solicitud HTTP, RyzeAPI se encarga del resto.Mensajes en cualquier formato
Texto, multimedia, stickers, ubicación, contactos, reacciones, encuestas, carruseles, listas, botones, formularios e incluso PIX.
Múltiples instancias por cuenta
Gestiona varios números de WhatsApp simultáneamente, cada uno con su propio token y configuración aislada.
Eventos en tiempo real
Recibe mensajes, estado de entrega y cambios de grupo vía webhook o WebSocket. Hasta 3 webhooks simultáneos por instancia.
Funciones avanzadas nativas
Carruseles, botones interactivos, listas, formularios y botones PIX, funciones que normalmente no están disponibles en APIs genéricas de WhatsApp.
Lo que puedes hacer
RyzeAPI cubre todo el ciclo de vida de la integración con WhatsApp:- Conversaciones 1 a 1 y en grupo, envía y recibe cualquier tipo de contenido
- Gestión de contactos, listar, organizar con etiquetas, bloquear, marcar como favorito
- Grupos, crear, invitar, moderar, actualizar nombre/descripción/foto, gestionar participantes
- Comunidades, crea comunidades y vincula tus grupos
- Newsletter (canales), transmite a tus seguidores
- Perfil de la cuenta, nombre, foto, privacidad
- Estados (status), publica estados que desaparecen en 24h
- Eventos en vivo, webhooks y WebSockets para reaccionar en tiempo real
Arquitectura de tu integración
Comprender estos 3 niveles te ayuda a diseñar tu aplicación correctamente:Tu cuenta (Account)
Tu espacio en RyzeAPI. Tiene un TokenAccount único y un límite de cuántas instancias puedes crear.
Tus instancias (Instance)
Cada instancia es una conexión activa a un número de WhatsApp. Una cuenta puede tener varias, por ejemplo una para ventas, otra para soporte y otra para marketing.Cada instancia recibe su propio TokenInstance al ser creada.
Primeros pasos
Inicio rápido
Conecta tu WhatsApp y envía tu primer mensaje en menos de 5 minutos.
Conceptos
Comprende los conceptos clave antes de adentrarte en los endpoints.
Autenticación
Cómo usar TokenAccount y TokenInstance.
Tipos de error
Formatos de respuesta y cómo manejar cada código HTTP.
Explora los módulos
La API está organizada en módulos. Cada uno agrupa endpoints que tratan un aspecto específico de WhatsApp.Instancia
Crear, conectar, desconectar, ajustar configuraciones.
Mensajes
Envía todos los tipos: texto, multimedia, botones, carruseles, listas.
Chat
Contactos, etiquetas, archivar, fijar, editar, eliminar mensajes.
Grupos
Crea grupos, gestiona participantes, enlaces de invitación.
Comunidades
Crea comunidades y vincula tus grupos.
Newsletter
Crea y gestiona canales de difusión.
Perfil
Nombre, foto y privacidad de la cuenta de WhatsApp.
Eventos
Configura webhooks y WebSockets por instancia.
WebSocket
Conexión persistente para eventos en tiempo real.
Chatwoot
Integración con Chatwoot vía el puente RyzeIntegrations.