Workflows

Workflows são fluxos conversacionais que definem o comportamento do canal. Você pode consultar os workflows disponíveis no seu canal e redirecionar usuários para um fluxo específico.

Obter Workflows

Consulte todas os workflows disponíveis no seu canal.

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

Parâmetros de Path

Campo	Localização	Tipo	Obrigatório	Descrição
botId	Path	string	Sim	Identificador único do canal.

Exemplo de Requisição

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

Respostas

200 - Resposta bem-sucedida

{
  "message": ["Skills retrieved successfully!"],
  "statusMessage": "success",
  "status": 1,
  "data": [
    {
      "id": 1,
      "name": "Main Skill",
      "description": "Welcome skill",
      "type": "BRAIN",
      "createdAt": "2024-10-24T11:18:05.000Z",
      "updatedAt": "2024-10-24T11:18:05.000Z",
      "state": true,
      "default": true
    },
    {
      "id": 2,
      "name": "Sales Skill",
      "description": "Sales flow",
      "type": "BRAIN",
      "createdAt": "2024-10-24T11:13:32.000Z",
      "updatedAt": "2024-10-24T11:17:44.000Z",
      "state": true,
      "default": false
    }
  ]
}

401 - Não Autorizado

{
  "message": "Authentication failed"
}

404 - Não Encontrado

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

Detalhes da Resposta

Propriedade	Tipo	Descrição
id	integer	ID do fluxo. Este ID deve ser usado para configurar redirecionamentos.
name	string	Nome do fluxo.
description	string	Descrição do fluxo.
type	string	Tipo do fluxo.
state	boolean	Estado do fluxo. Somente workflows com estado `true` podem ser usadas.
default	boolean	Indica se o fluxo está selecionada como padrão para o canal.
createdAt	date	Data de criação do fluxo.
updatedAt	date	Data da última atualização do fluxo.

Configurar Fluxo do Usuário

Redirecione um usuário para um fluxo específico dentro do fluxo conversacional.

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

Requisitos

O usuário deve ter uma sessão ativa.

Parâmetros de Path

Campo	Localização	Tipo	Obrigatório	Descrição
botId	Path	string	Sim	Identificador único do canal.
userId	Path	string	Sim	Identificador único do usuário.
skillId	Path	string	Sim	Identificador do fluxo para a qual o usuário será redirecionado.

Corpo da Requisição

Campo	Localização	Tipo	Obrigatório	Descrição
memoryParams	Body	object	Não	Parâmetros opcionais que podem ser injetados e usados posteriormente no fluxo.

Exemplo de Requisição

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
    }
  }'

Respostas

200 - Resposta bem-sucedida

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

400 - Requisição Inválida

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

401 - Não Autorizado

{
  "message": "Authentication failed"
}

404 - Não Encontrado

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

Referência de API

Enviar Mensagens

Campanhas

Conversações

Métricas

Usuários

Recursos

Widget

Datum

Painel de Atendimento Externo

Canal Personalizado

Gestão de Memória

Obter Workflows

Parâmetros de Path

Exemplo de Requisição

Respostas

Detalhes da Resposta

Configurar Fluxo do Usuário

Requisitos

Parâmetros de Path

Corpo da Requisição

Exemplo de Requisição

Respostas

​Obter Workflows

​Parâmetros de Path

​Exemplo de Requisição

​Respostas

​Detalhes da Resposta

​Configurar Fluxo do Usuário

​Requisitos

​Parâmetros de Path

​Corpo da Requisição

​Exemplo de Requisição

​Respostas

Obter Workflows

Parâmetros de Path

Exemplo de Requisição

Respostas

Detalhes da Resposta

Configurar Fluxo do Usuário

Requisitos

Parâmetros de Path

Corpo da Requisição

Exemplo de Requisição

Respostas