Inicio rápido

Esta guía cubre el camino mínimo para tener una instancia conectada e intercambiar tu primer mensaje.

Requisitos previos

Ya tienes tu TokenAccount de RyzeAPI.

Un teléfono con WhatsApp Business (o WhatsApp normal) instalado.

1. Configura tu token

export Token_Account="tu-token-de-cuenta"

En todos los ejemplos, la Base URL es siempre https://ryzeapi.cloud.

2. Crea una instancia

Usa tu TokenAccount para aprovisionar una nueva instancia de WhatsApp.

curl -X POST "https://ryzeapi.cloud/api/instance/new" \
  -H "token: $Token_Account" \
  -H "Content-Type: application/json" \
  -d '{"name": "$Instance_Name"}'

const res = await fetch(`https://ryzeapi.cloud/api/instance/new`, {
  method: "POST",
  headers: {
    "token": Token_Account,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ name: "$Instance_Name" }),
});
const { data } = await res.json();
console.log(data.token); // this is the TokenInstance

import os, requests

r = requests.post(
    "https://ryzeapi.cloud/api/instance/new",
    headers={"token": os.environ["Token_Account"]},
    json={"name": "myInstance"},
)
print(r.json()["data"]["token"])  # this is the TokenInstance

Respuesta esperada:

{
  "success": true,
  "message": "Instance created successfully",
  "status": "created",
  "data": {
    "id": "01953abc-...",
    "name": "$Instance_Name",
    "token": "a1b2c3d4-...",
    "status": "disconnected",
    "createdAt": "2026-04-21T12:00:00Z"
  }
}

Guarda el data.token, este es tu TokenInstance. A partir de ahora, úsalo (no el TokenAccount) para operar esta instancia.

export Token_Instance="a1b2c3d4-..."

3. Conéctate a WhatsApp

Usa tu TokenInstance de aquí en adelante.

Vía código QR
Vía código de emparejamiento

curl -X GET "https://ryzeapi.cloud/api/instance/connect/$Instance_Name" \
  -H "token: $Token_Instance"

La respuesta incluye:

data.qrCodes, cadenas que pueden convertirse en un QR
data.qrImages, PNG en base64 listos para mostrarse como imagen

Escanéalo en tu teléfono en WhatsApp → Dispositivos vinculados → Vincular un dispositivo.

Ideal para entornos sin cámara. Pasa tu número en el parámetro number:

curl -X GET "https://ryzeapi.cloud/api/instance/connect/$Instance_Name?number=5511999999999" \
  -H "token: $Token_Instance"

La respuesta incluye un código de 8 caracteres para ingresar en Dispositivos vinculados → Vincular con código.

4. Confirma que está conectada

curl -X GET "https://ryzeapi.cloud/api/instance/list?instanceName=$Instance_Name" \
  -H "token: $Token_Instance"

Espera a que el campo status de la instancia pase a "connected".

5. Envía tu primer mensaje

curl -X POST "https://ryzeapi.cloud/api/message/text/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "text": "Hello from RyzeAPI 👋"
  }'

6. Configura un webhook (opcional)

Para recibir eventos en tiempo real (mensajes entrantes, estado de entrega, etc.):

curl -X POST "https://ryzeapi.cloud/api/events/webhook/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "default",
    "enabled": true,
    "url": "https://your-server.com/webhook",
    "events": ["message.exchange", "group.flow", "instance.state"],
    "mediaBase64": false
  }'

Cada instancia acepta hasta 3 webhooks simultáneos (por ejemplo: producción, staging y uno de logs). Consulta Eventos para los 6 tipos disponibles.

Próximos pasos

Envía multimedia y funciones avanzadas

Imágenes, videos, audios, documentos, botones, carruseles, listas y formularios.

Gestiona contactos y etiquetas

Organiza conversaciones, crea etiquetas, archiva, bloquea y fija chats.

Autenticación

Comprende TokenAccount vs TokenInstance en detalle.

Tipos de error

Cómo interpretar y manejar cada código HTTP.

Primeros pasos

Fundamentos

MCP

Requisitos previos

1. Configura tu token

2. Crea una instancia

3. Conéctate a WhatsApp

4. Confirma que está conectada

5. Envía tu primer mensaje

6. Configura un webhook (opcional)

Próximos pasos

Envía multimedia y funciones avanzadas

Gestiona contactos y etiquetas

Autenticación

Tipos de error

​Requisitos previos

​1. Configura tu token

​2. Crea una instancia

​3. Conéctate a WhatsApp

​4. Confirma que está conectada

​5. Envía tu primer mensaje

​6. Configura un webhook (opcional)

​Próximos pasos

Envía multimedia y funciones avanzadas

Gestiona contactos y etiquetas

Autenticación

Tipos de error

Requisitos previos

1. Configura tu token

2. Crea una instancia

3. Conéctate a WhatsApp

4. Confirma que está conectada

5. Envía tu primer mensaje

6. Configura un webhook (opcional)

Próximos pasos