Whatsapp Flows

Envía un mensaje con un botón que abre un WhatsApp Flow

Endpoint

POST https://api.jelou.ai/v1/bots/{botId}/messages

Parámetros de Ruta

botId · string · required

Identificador único del bot que envía el mensaje.

Cuerpo de la Solicitud

type · string · required

Debe ser "flow".

title · string · required

Encabezado del mensaje.

text · string · required

Contenido del mensaje.

caption · string · required

Texto de pie de página.

userId · string · required

Identificador único del usuario que recibirá el mensaje.

parameters · object · required

Configuración del botón de flujo.

Show Parámetros del Flujo

parameters.flow_id · string · required

Identificador único del flujo a abrir.

parameters.flow_cta · string · required

Texto de llamada a la acción mostrado en el botón del flujo.

parameters.flow_name · string · required

Nombre del flujo.

parameters.flow_action_payload · object · required

Datos de carga útil para la acción del flujo. Este objeto puede contener cualquier dato que quieras pasar al flujo.

Show Ejemplo de Payload

{
  "screen": "RECOMMEND"
}

parameters.mode · string · required

Modo del flujo. Debe ser "draft" o "published".

parameters.flow_action · string · required

Acción a realizar. Actualmente solo se soporta "navigate".

parameters.flow_message_version · string · required

Versión del mensaje de flujo. Usa "3" para la versión más reciente.

Ejemplos de Solicitud

cURL

curl --request POST \
  --url https://api.jelou.ai/v1/bots/BOT_ID/messages \
  --header 'Authorization: Basic <Base64Encoded clientId:clientSecret>' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "flow",
    "title": "Hola",
    "text": "Completa este flujo para comenzar",
    "caption": "Jelou",
    "userId": "USER_ID",
    "parameters": {
      "flow_id": "FLOW_ID",
      "flow_cta": "Iniciar Flujo",
      "flow_name": "Flujo de Bienvenida",
      "flow_action_payload": {
        "screen": "RECOMMEND"
      },
      "mode": "draft",
      "flow_action": "navigate",
      "flow_message_version": "3"
    }
  }'

Respuesta

success · boolean

Indica si el mensaje fue enviado exitosamente.

messageId · string

Identificador único del mensaje enviado.

Ejemplo de Respuesta

{
  "success": true,
  "messageId": "msg_123456789"
}

Mejores Prácticas

Flujos Complejos: Usa botones de flujo para interacciones complejas de múltiples pasos que requieren entradas de formulario, selecciones o experiencias guiadas. Los flujos proporcionan una experiencia nativa de WhatsApp sin salir del chat.

Casos de Uso

• Formularios de registro o encuestas
• Procesos de compra multi-paso
• Configuraciones guiadas
• Experiencias interactivas complejas