Whatsapp Flows

curl --request POST \
  --url https://api.jelou.ai/v1/bots/BOT_ID/users/593987654321/flow_message \
  --header 'Authorization: Basic <Base64Encoded clientId:clientSecret>' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Hola",
    "text": "Completa este flujo para comenzar",
    "caption": "Jelou",
    "parameters": {
      "flow_name": "flujo_de_bienvenida",
      "flow_cta": "Iniciar Flujo",
      "flow_action_payload": {
        "screen": "RECOMMEND"
      }
    }
  }'

{}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

POST

bots

{botId}

users

{userId}

flow_message

curl --request POST \
  --url https://api.jelou.ai/v1/bots/BOT_ID/users/593987654321/flow_message \
  --header 'Authorization: Basic <Base64Encoded clientId:clientSecret>' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Hola",
    "text": "Completa este flujo para comenzar",
    "caption": "Jelou",
    "parameters": {
      "flow_name": "flujo_de_bienvenida",
      "flow_cta": "Iniciar Flujo",
      "flow_action_payload": {
        "screen": "RECOMMEND"
      }
    }
  }'

{}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

El WhatsApp Flow debe existir previamente en Jelou para el bot indicado. Se referencia por su slug en parameters.flow_name. El botId y el número del destinatario (userId, sin el signo +) van ambos en la ruta. Disponible solo para bots con proveedor WhatsApp Cloud API, Gupshup CAPI o Aldeamo.

curl --request POST \
  --url https://api.jelou.ai/v1/bots/BOT_ID/users/593987654321/flow_message \
  --header 'Authorization: Basic <Base64Encoded clientId:clientSecret>' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Hola",
    "text": "Completa este flujo para comenzar",
    "caption": "Jelou",
    "parameters": {
      "flow_name": "flujo_de_bienvenida",
      "flow_cta": "Iniciar Flujo",
      "flow_action_payload": {
        "screen": "RECOMMEND"
      }
    }
  }'

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

Autorizaciones

Authorization

string

header

requerido

Basic authentication using Base64 encoded clientId:clientSecret

Parámetros de ruta

botId

string

requerido

Identifier of the bot whose WhatsApp channel sends the message.

userId

string

requerido

Recipient's phone number, without the + sign.

Parámetros de consulta

type

string

Type of WhatsApp Flow to send. Defaults to the standard flow type.

Cuerpo

application/json

title

string

requerido

Header shown above the Flow button.

Ejemplo:

"Hello"

text

string

requerido

Body text shown above the Flow button.

Ejemplo:

"Complete this flow to get started"

caption

string

requerido

Footer text shown below the Flow button.

Ejemplo:

"Jelou"

parameters

object

requerido

Show child attributes

payload

object

Optional extra context cached and returned with the Flow reply.

Respuesta

Flow message sent

The response is of type object.

URL Externa

Llamada

⌘I

API reference

Envío de mensajes

Campañas

Conversaciones

Métricas

Usuarios

Recursos

Widget

Datum

Panel de Atención Externo

Gestión de Memoria

Mejores Prácticas

Casos de Uso

Autorizaciones

Parámetros de ruta

Parámetros de consulta

Cuerpo

Respuesta

​Mejores Prácticas

​Casos de Uso

Autorizaciones

Parámetros de ruta

Parámetros de consulta

Cuerpo

Respuesta

Mejores Prácticas

Casos de Uso