Typebot
Iniciar fluxo
Inicia manualmente um fluxo do Typebot para um número, disparando o startChat
POST
Iniciar fluxo
Auth:
TokenAccount ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: não
Descrição
Inicia manualmente um fluxo do Typebot para um número, sem esperar por uma mensagem de trigger. A RyzeAPI dispara ostartChat do bot indicado e persiste a sessão. Útil para campanhas de saída (outbound) e para retomar uma conversa a partir do seu backend.
A instância precisa já ter pelo menos um bot cadastrado (uma integração ativa).
Exemplo
Resposta de sucesso
200 OK
Parâmetros de rota
string
obrigatório
Nome da instância (ex.:
suporte).Headers
string
obrigatório
TokenAccount ou TokenInstance.string
obrigatório
application/jsonRequest body
string
obrigatório
Número de destino no formato E.164 sem o
+ (ex.: 5511999999999).string
obrigatório
UUID do bot a iniciar, obtido em
GET /api/typebot/list/:instance.object
Variáveis prefilled passadas ao Typebot (mapa
string → string). Ex.: { "nome": "João", "plano": "premium" }.Erros
Próximo
Listar bots
Descubra o
botId a usar com GET /api/typebot/list/:instance.Sessões ao vivo
Acompanhe e controle a conversa iniciada com
GET/POST /api/typebot/sessions/:instance.