Contato

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": "contacts",
    "userId": "USER_ID",
    "contacts": [
      {
        "name": {
          "formatted_name": "John Smith",
          "first_name": "John",
          "last_name": "Smith"
        },
        "phones": [
          {
            "phone": "+PHONE_NUMBER",
            "type": "Mobile",
            "wa_id": "PHONE_NUMBER"
          }
        ],
        "emails": [
          {
            "email": "[email protected]",
            "type": "Work"
          }
        ],
        "addresses": [
          {
            "street": "123 Main Street",
            "city": "New York",
            "state": "NY",
            "zip": "10001",
            "country": "United States",
            "country_code": "US",
            "type": "Office"
          }
        ]
      }
    ]
  }'

{
  "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": "contacts",
    "userId": "USER_ID",
    "contacts": [
      {
        "name": {
          "formatted_name": "John Smith",
          "first_name": "John",
          "last_name": "Smith"
        },
        "phones": [
          {
            "phone": "+PHONE_NUMBER",
            "type": "Mobile",
            "wa_id": "PHONE_NUMBER"
          }
        ],
        "emails": [
          {
            "email": "[email protected]",
            "type": "Work"
          }
        ],
        "addresses": [
          {
            "street": "123 Main Street",
            "city": "New York",
            "state": "NY",
            "zip": "10001",
            "country": "United States",
            "country_code": "US",
            "type": "Office"
          }
        ]
      }
    ]
  }'

{
  "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": "contacts",
    "userId": "USER_ID",
    "contacts": [
      {
        "name": {
          "formatted_name": "John Smith",
          "first_name": "John",
          "last_name": "Smith"
        },
        "phones": [
          {
            "phone": "+PHONE_NUMBER",
            "type": "Mobile",
            "wa_id": "PHONE_NUMBER"
          }
        ],
        "emails": [
          {
            "email": "[email protected]",
            "type": "Work"
          }
        ],
        "addresses": [
          {
            "street": "123 Main Street",
            "city": "New York",
            "state": "NY",
            "zip": "10001",
            "country": "United States",
            "country_code": "US",
            "type": "Office"
          }
        ]
      }
    ]
  }'

Notas Importantes

Formato de Telefone: Sempre use o formato E.164 para números de telefone (ex.: +PHONE_NUMBER) para garantir a compatibilidade entre diferentes regiões.

Completude do Contato: Embora todos os campos sejam opcionais, fornecer informações completas de contato (nome, telefone, e-mail) melhora a experiência do usuário e torna os contatos mais úteis.

Casos de Uso

Compartilhar informações de contato de suporte
Encaminhar usuários para membros específicos da equipe
Fornecer informações de cartão de visita
Compartilhar contatos de emergência

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"

Localização

Solicitação de Localização

⌘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

Notas Importantes

Casos de Uso

Autorizações

Parâmetros de caminho

Corpo

Resposta

​Notas Importantes

​Casos de Uso

Autorizações

Parâmetros de caminho

Corpo

Resposta

Notas Importantes

Casos de Uso