Workflows

Los Workflows son pasos conversacionales que definen el comportamiento del bot. Puedes consultar los workflows disponibles en tu bot y redirigir usuarios a un flujo específico.

Obtener Workflows

Consulta todos los workflows disponibles en tu bot.

GET https://api.jelou.ai/v1/bots/{botId}/skills

Parámetros de ruta

Campo	Ubicación	Tipo	Requerido	Descripción
botId	Path	string	Sí	Identificador único del bot.

Ejemplo de solicitud

curl --request GET \
  --url 'https://api.jelou.ai/v1/bots/BOT_ID/skills' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}'

Respuestas

200 - Respuesta exitosa

{
  "message": ["Skills retrieved successfully!"],
  "statusMessage": "success",
  "status": 1,
  "data": [
    {
      "id": 1,
      "name": "Skill Principal",
      "description": "Skill de bienvenida",
      "type": "BRAIN",
      "createdAt": "2024-10-24T11:18:05.000Z",
      "updatedAt": "2024-10-24T11:18:05.000Z",
      "state": true,
      "default": true
    },
    {
      "id": 2,
      "name": "Skill Ventas",
      "description": "Flujo de ventas",
      "type": "BRAIN",
      "createdAt": "2024-10-24T11:13:32.000Z",
      "updatedAt": "2024-10-24T11:17:44.000Z",
      "state": true,
      "default": false
    }
  ]
}

401 - Unauthorized

{
  "message": "Authentication failed"
}

404 - Not Found

{
  "message": ["Bot not found"],
  "status": "failed"
}

Detalle de la respuesta

Propiedad	Tipo	Descripción
id	integer	ID del flujo. Este ID debe usarse para configurar redirecciones.
name	string	Nombre del flujo.
description	string	Descripción del flujo.
type	string	Tipo de flujo.
state	boolean	Estado del flujo. Solo los workflows con estado `true` pueden ser utilizadas.
default	boolean	Indica si el flujo está seleccionada como predeterminada para el bot.
createdAt	date	Fecha de creación del flujo.
updatedAt	date	Fecha de última actualización del flujo.

Configurar Flujo de usuario

Redirige a un usuario a un flujo específico dentro del flujo conversacional.

POST https://api.jelou.ai/v1/bots/{botId}/users/{userId}/skill/{skillId}

Requisitos

El usuario debe tener una sesión activa.

Parámetros de ruta

Campo	Ubicación	Tipo	Requerido	Descripción
botId	Path	string	Sí	Identificador único del bot.
userId	Path	string	Sí	Identificador único del usuario.
skillId	Path	string	Sí	Identificador del flujo al que será redirigido el usuario.

Cuerpo de la solicitud

Campo	Ubicación	Tipo	Requerido	Descripción
memoryParams	Body	object	No	Parámetros opcionales que se pueden inyectar y utilizar posteriormente en el flujo.

Ejemplo de solicitud

curl --request POST \
  --url 'https://api.jelou.ai/v1/bots/BOT_ID/users/USER_ID/skill/SKILL_ID' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "memoryParams": {
      "test": 1
    }
  }'

Respuestas

200 - Respuesta exitosa

{
  "message": "Skill set successfully",
  "status": "success"
}

400 - Bad Request

{
  "message": "Invalid request",
  "status": "failed"
}

401 - Unauthorized

{
  "message": "Authentication failed"
}

404 - Not Found

{
  "message": "User or Skill not found",
  "status": "failed"
}

API reference

Envío de mensajes

Campañas

Conversaciones

Métricas

Usuarios

Recursos

Widget

Datum

Panel de Atención Externo

Gestión de Memoria

Obtener Workflows

Parámetros de ruta

Ejemplo de solicitud

Respuestas

Detalle de la respuesta

Configurar Flujo de usuario

Requisitos

Parámetros de ruta

Cuerpo de la solicitud

Ejemplo de solicitud

Respuestas

​Obtener Workflows

​Parámetros de ruta

​Ejemplo de solicitud

​Respuestas

​Detalle de la respuesta

​Configurar Flujo de usuario

​Requisitos

​Parámetros de ruta

​Cuerpo de la solicitud

​Ejemplo de solicitud

​Respuestas

Obtener Workflows

Parámetros de ruta

Ejemplo de solicitud

Respuestas

Detalle de la respuesta

Configurar Flujo de usuario

Requisitos

Parámetros de ruta

Cuerpo de la solicitud

Ejemplo de solicitud

Respuestas