Pular para o conteúdo principal
POST
/
v1
/
bots
/
{botId}
/
messages
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": "Please select an option",
    "userId": "USER_ID",
    "buttons": {
      "title": "Choose an option",
      "buttonText": {
        "type": "text",
        "text": "View Options"
      },
      "options": [
        {
          "title": "Option 1",
          "description": "This is the first option",
          "payload": "OPTION_1"
        },
        {
          "title": "Option 2",
          "description": "This is the second option",
          "payload": "OPTION_2"
        },
        {
          "title": "Option 3",
          "description": "This is the third option",
          "payload": "OPTION_3"
        }
      ]
    }
  }'
{
  "success": true,
  "messageId": "msg_123456789"
}
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": "Please select an option",
    "userId": "USER_ID",
    "buttons": {
      "title": "Choose an option",
      "buttonText": {
        "type": "text",
        "text": "View Options"
      },
      "options": [
        {
          "title": "Option 1",
          "description": "This is the first option",
          "payload": "OPTION_1"
        },
        {
          "title": "Option 2",
          "description": "This is the second option",
          "payload": "OPTION_2"
        },
        {
          "title": "Option 3",
          "description": "This is the third option",
          "payload": "OPTION_3"
        }
      ]
    }
  }'

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: 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

Autorizações

Authorization
string
header
obrigatório

Basic authentication using Base64 encoded clientId:clientSecret

Parâmetros de caminho

botId
string
obrigatório

The unique identifier of the bot

Corpo

application/json

Message payload. The structure varies based on the message type.

type
enum<string>
obrigatório

Type of message to send

Opções disponíveis:
text
Exemplo:

"text"

userId
string
obrigatório

Unique identifier of the user receiving the message

Exemplo:

"USER_ID"

text
string
obrigatório

Text content of the message

Exemplo:

"Hello, this is a text message"

botId
string

Unique identifier of the bot sending the message

Exemplo:

"BOT_ID"

Resposta

Message sent successfully

success
boolean
Exemplo:

true

messageId
string
Exemplo:

"msg_123456789"