Typebot
Iniciar flujo
Inicia manualmente un flujo de Typebot para un número, disparando el startChat
POST
Iniciar flujo
Auth:
TokenAccount o TokenInstance • Rate limit: Global (100/min) • Idempotente: no
Descripción
Inicia manualmente un flujo de Typebot para un número, sin esperar por un mensaje de trigger. RyzeAPI dispara elstartChat del bot indicado y persiste la sesión. Útil para campañas de salida (outbound) y para retomar una conversación desde tu backend.
La instancia debe tener ya al menos un bot registrado (una integración activa).
Ejemplo
Respuesta exitosa
200 OK
Parámetros de ruta
string
requerido
Nombre de la instancia (p. ej.,
suporte).Cabeceras
string
requerido
TokenAccount o TokenInstance.string
requerido
application/jsonCuerpo de la solicitud
string
requerido
Número de destino en formato E.164 sin el
+ (p. ej., 5511999999999).string
requerido
UUID del bot a iniciar, obtenido en
GET /api/typebot/list/:instance.object
Variables prefilled pasadas a Typebot (mapa
string → string). Ej.: { "nome": "João", "plano": "premium" }.Errores
Siguiente
Listar bots
Descubre el
botId a usar con GET /api/typebot/list/:instance.Registrar bot
Configura un bot antes de iniciar flujos manualmente.