Enviar Mensagens

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": "Olá, esta é uma mensagem de texto",
    "userId": "PHONE_NUMBER_OR_BSUID"
  }'

{
  "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": "text",
    "text": "Olá, esta é uma mensagem de texto",
    "userId": "PHONE_NUMBER_OR_BSUID"
  }'

{
  "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": "text",
    "text": "Olá, esta é uma mensagem de texto",
    "userId": "PHONE_NUMBER_OR_BSUID"
  }'

Identificação do destinatário

O campo userId aceita dois formatos:

Número de telefone: formato E.164 sem o sinal + (ex.: 593999999999).
BSUID (Business-Scoped User ID): um identificador com o formato CC.alfanumérico (ex.: US.13491208655302741918).

O que é um BSUID? Quando um usuário ativa a proteção de número no WhatsApp, a Meta deixa de expor o número de telefone real e passa a identificar o usuário por meio de um BSUID único para o seu negócio. Se sua integração já conhece o BSUID de um usuário —por exemplo, porque o recebeu em um webhook de entrada—, você pode usá-lo diretamente em userId para enviar uma mensagem sem precisar do número de telefone dele.

Com número de telefone
Com BSUID

cURL

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": "Olá, esta é uma mensagem de texto",
    "userId": "593999999999"
  }'

cURL

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": "Olá, esta é uma mensagem de texto",
    "userId": "US.13491208655302741918"
  }'

Formato inválido: se userId não corresponder a um número de telefone válido nem a um BSUID com formato correto, a API responde com um erro 400 (INVALID_USER_ID).

Casos de Uso

Notificações simples
Confirmações
Mensagens informativas
Respostas automáticas básicas
Responder a um usuário que ativou a privacidade de número no WhatsApp, usando o BSUID recebido em um webhook de entrada
Enviar mensagens proativas a usuários identificados exclusivamente por BSUID, sem precisar armazenar ou conhecer o número de telefone real

Exemplos

Responder a uma mensagem de entrada identificada por BSUID

Quando um usuário com privacidade de número ativada escreve para você, o webhook de entrada traz o BSUID dele em vez de um telefone. Use esse mesmo valor para responder:

cURL

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": "Obrigado por entrar em contato! Em breve um agente vai te atender.",
    "userId": "US.13491208655302741918"
  }'

Enviar uma imagem para um destinatário identificado por BSUID

Os demais tipos de mensagem (imagem, documento, localização, etc.) funcionam da mesma forma: basta trocar o valor de userId pelo BSUID do destinatário.

cURL

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": "image",
    "mediaUrl": "https://example.com/catalogo.jpg",
    "userId": "US.13491208655302741918"
  }'

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"

Introdução

Mensagem de Texto

⌘I

Referência de API

Campanhas

Conversações

Métricas

Usuários

Recursos

Widget

Datum

Painel de Atendimento Externo

Gestão de Memória

Enviar Mensagens

Identificação do destinatário

Casos de Uso

Exemplos

Responder a uma mensagem de entrada identificada por BSUID

Enviar uma imagem para um destinatário identificado por BSUID

Autorizações

Parâmetros de caminho

Corpo

Resposta

​Identificação do destinatário

​Casos de Uso

​Exemplos

​Responder a uma mensagem de entrada identificada por BSUID

​Enviar uma imagem para um destinatário identificado por BSUID

Autorizações

Parâmetros de caminho

Corpo

Resposta

Identificação do destinatário

Casos de Uso

Exemplos

Responder a uma mensagem de entrada identificada por BSUID

Enviar uma imagem para um destinatário identificado por BSUID