Pular para o conteúdo principal

​
Descrição

Gerencie o armazenamento de dados associados a um usuário dentro do seu bot.
O cache do usuário armazena informações únicas sobre cada pessoa que interage com sua experiência conversacional e pode ser usado dentro das suas skills para:
  • Associar dados operacionais, como um número de pedido, a um user.
  • Permitir que o bot conheça as propriedades do usuário antes do início da conversa.
  • Armazenar informações necessárias para consultar serviços internos ou externos de skills específicas.
Além disso, o cache habilita atalhos para ações padrão do bot, como:
  • Definir reações ou executar uma skill antes que o usuário inicie a conversa (em breve).

​
Obter Cache do Usuário

​
Endpoint

GET https://api.jelou.ai/v1/users/{userId}/cache

​
Parâmetros de Path

​
userId
string
obrigatório
Número de telefone do usuário (sem o sinal +).

​
Exemplo de Resposta

A resposta pode incluir quaisquer dados previamente armazenados no cache do usuário.
{
  "groupId": "grp-67890",
  "orderNumber": "ORD-12345"
}

​
Definir cache do usuário

​
Endpoint

POST https://api.jelou.ai/v1/users/{userId}/cache

​
Parâmetros de Path

​
userId
string
obrigatório
Número de telefone do usuário (sem o sinal +).

​
Corpo da Requisição

​
params
object
Objeto com os dados que serão mesclados com o cache atual do usuário.
​
botId
string
obrigatório
Identificador do bot associado ao usuário.

​
Exemplo de Requisição

curl --request POST \
  --url https://api.jelou.ai/v1/users/{userId}/cache \
  --header 'Authorization: Basic <Base64Encoded clientId:clientSecret>' \
  --header 'Content-Type: application/json' \
  --data '{
    "params": {
      "groupId": "grp-67890",
      "orderNumber": "ORD-12345"
    },
    "botId": "bot-12345"
  }'

​
Exemplo de Resposta

{
  "message": [
    "User cache set successfully."
  ],
  "status": "success"
}

​
Erros Comuns

  • 400 - Não foi possível obter ou atualizar o status do usuário.
  • 401 - Credenciais inválidas ou ausentes.
  • 404 - Usuário ou bot não encontrado.
  • 200 - Erro lógico ao obter o cache (quando o status é “failed”).
O cache é mesclado com os dados existentes. Se você reutilizar chaves já definidas, seu valor será sobrescrito. Certifique-se de manter uma estrutura consistente para evitar comportamentos inesperados nas suas skills.