URL Externa

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": "cta_url",
    "title": "Welcome",
    "text": "Visit our website to learn more",
    "caption": "Jelou",
    "userId": "USER_ID",
    "parameters": {
      "url": "https://apps.jelou.ai",
      "display_text": "Visit Website"
    }
  }'

{
  "success": true,
  "messageId": "msg_123456789"
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

POST

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": "cta_url",
    "title": "Welcome",
    "text": "Visit our website to learn more",
    "caption": "Jelou",
    "userId": "USER_ID",
    "parameters": {
      "url": "https://apps.jelou.ai",
      "display_text": "Visit Website"
    }
  }'

{
  "success": true,
  "messageId": "msg_123456789"
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

{
  "message": "<string>",
  "statusMessage": "<string>",
  "status": 123,
  "error": {
    "code": "<string>",
    "key": "<string>",
    "description": "<string>",
    "developerMessages": {},
    "clientMessages": {}
  },
  "validationError": {}
}

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": "cta_url",
    "title": "Welcome",
    "text": "Visit our website to learn more",
    "caption": "Jelou",
    "userId": "USER_ID",
    "parameters": {
      "url": "https://apps.jelou.ai",
      "display_text": "Visit Website"
    }
  }'

Boas Práticas

URLs Seguras: Certifique-se de que as URLs são HTTPS e forneça um texto de botão claro e orientado para a ação.

Casos de Uso

Direcionar usuários para sites externos
Vincular a aplicações web
Compartilhar recursos online
Redirecionar para formulários ou páginas de cadastro

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. Accepts either a phone number in E.164 format without the leading '+' (e.g. '593999999999') or a BSUID (Business-Scoped User ID, e.g. 'US.13491208655302741918') for users who have enabled phone number privacy in WhatsApp.

Exemplo:

"593999999999"

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"

Solicitação de Localização

Whatsapp Flows

⌘I

Referência de API

Enviar Mensagens

Campanhas

Conversações

Métricas

Usuários

Recursos

Widget

Datum

Painel de Atendimento Externo

Gestão de Memória

Boas Práticas

Casos de Uso

Autorizações

Parâmetros de caminho

Corpo

Resposta

​Boas Práticas

​Casos de Uso

Autorizações

Parâmetros de caminho

Corpo

Resposta

Boas Práticas

Casos de Uso