Mensagem com Opções

Documentation Index

Fetch the complete documentation index at: https://docs.jelou.ai/llms.txt

Use this file to discover all available pages before exploring further.

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": "text",
    "text": "Por favor selecione uma opção",
    "userId": "USER_ID",
    "title": "Escolha uma opção",
    "buttonText": {
      "type": "text",
      "text": "Ver Opções"
    },
    "options": [
      {
        "id": "option_1",
        "title": "Opção 1",
        "description": "Esta é a primeira opção"
      },
      {
        "id": "option_2",
        "title": "Opção 2",
        "description": "Esta é a segunda opção"
      },
      {
        "id": "option_3",
        "title": "Opção 3",
        "description": "Esta é a terceira opção"
      }
    ]
  }'

​

Estrutura do Payload

• title (opcional): Título exibido acima da lista de opções.
• buttonText (opcional): Objeto do botão que abre a lista. Aceita os campos:
  • type: tipo do conteúdo do botão (padrão "text").
  • text: rótulo visível do botão (padrão "Opções").
• options[] (obrigatório): Lista de opções selecionáveis. Cada opção aceita:
  • id (opcional): Identificador estável retornado quando o usuário seleciona a opção. Se omitido, é gerado automaticamente um UUID.
  • title (obrigatório): Texto visível da opção.
  • description (opcional): Texto secundário exibido abaixo do título.

​

Restrições

• Opções: Mínimo 1, máximo 10 opções por mensagem
• Título da Opção: Máximo de 24 caracteres
• Descrição da Opção: Máximo de 72 caracteres
• Texto do Botão (buttonText.text): Padrão é “Opções” se não especificado

​

Casos de Uso

• Criação de menus de navegação
• Fornecimento de opções de múltipla escolha
• Guiar usuários por um fluxo
• Coleta de respostas estruturadas