Saltar al contenido 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 es la referencia completa de la API. Los endpoints están organizados en módulos, cada uno cubriendo un aspecto específico de WhatsApp. Si recién estás comenzando, recomendamos leer: Inicio rápido → Conceptos → Autenticación antes de entrar en un módulo específico.

​
Base URL y convenciones

  • Base URL: https://ryzeapi.cloud
  • Prefijo de ruta: todos los endpoints comienzan con /api/<module>/...
  • Sonda de salud: /health (sin prefijo /api/)
  • Eventos en tiempo real: /ws/:instance (WebSocket)
  • Content-Type: application/json en todo POST / PUT / DELETE con cuerpo
  • Autenticación: cabecera token en cada ruta (consulta Autenticación)
  • Rate limit: 100 req/min por defecto; la creación de instancia tiene un límite estricto de 20 req/min
  • Cuerpo máximo: 64 MB por solicitud (cubre subidas en base64)

​
Módulos

Instance

Crea, conecta, configura y opera tus instancias de WhatsApp.

Messages

Texto, media, sticker, ubicación, contacto, reacción, encuesta, carrusel, botones, lista, formulario, PIX y estado.

Chat

Contactos, etiquetas, archivar, fijar, silenciar, presencia, historial, reenviar, editar, eliminar y más.

Groups

Crea grupos, gestiona participantes, enlaces de invitación y moderación.

Communities

Crea comunidades y vincula subgrupos.

Newsletter

Crea canales y gestiona suscripciones.

Profile

Nombre, foto, mensaje de estado y privacidad de la cuenta de WhatsApp conectada.

Events

Webhooks (con cola persistente + retry) y WebSockets en tiempo real.

WebSocket

Upgrade /ws/:instance, protocolo, heartbeat, reconexión.

Chatwoot

Integración con Chatwoot vía bridge (RyzeIntegrations).

Observability

/health, sonda combinada para orquestadores.

​
Formato de respuesta

Cada llamada devuelve un JSON con el campo success indicando el resultado: 
{
  "success": true,
  "message": "Message sent successfully",
  "status": "sent",
  "data": { "...": "..." }
}
El envoltorio de error tiene solo success + error.message: no existe un campo numérico code. La diferenciación programática usa el status HTTP + el texto del mensaje. Consulta Tipos de error para ver el catálogo completo de mensajes.

​
Identificadores de WhatsApp (JIDs)

TipoFormatoEjemplo
Privado<phone>@s.whatsapp.net5511999999999@s.whatsapp.net
Grupo<id>@g.us120363406289005073@g.us
Newsletter<id>@newsletter120363422585881117@newsletter
LID (oculto)<id>@lid199789077627112@lid
Broadcast (estado)status@broadcaststatus@broadcast
La mayoría de los endpoints aceptan un número plano (5511999999999) y lo convierten internamente. Para números brasileños (con prefijo 55), la API intenta variaciones con/sin el “9” extra después del código de área.

​
Glosario rápido

  • JID, el identificador único en WhatsApp (contacto, grupo, canal, LID).
  • Cuenta, tu espacio en RyzeAPI, identificado por el TokenAccount.
  • Instancia, una conexión activa a un número de WhatsApp.
  • TokenAccount, token de cuenta; se usa para crear/listar/eliminar instancias y operar cualquier instancia de la cuenta.
  • TokenInstance, token específico de la instancia; se usa para operaciones diarias de esa instancia.
  • Webhook, un POST que la API hace a tu URL cuando ocurre un evento (con retry exponencial y DLQ).
  • WebSocket, conexión persistente para recibir eventos en tiempo real.
  • RyzeIntegrations, microservicio opcional (bridge) que conecta RyzeAPI con integraciones externas como Chatwoot.

​
Variables en los ejemplos

La Base URL siempre es https://ryzeapi.cloud. Los ejemplos usan estas variables:
VariableSignificado
$Token_AccountTu TokenAccount
$Token_InstanceTokenInstance de una instancia específica
$Instance_NameNombre de la instancia (p. ej., myInstance)