Individual Send (1-1)

Send Individual HSM

curl --request POST \
  --url https://api.jelou.ai/v2/whatsapp/{botId}/hsm \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "elementName": "<string>",
  "destinations": [
    "<string>"
  ],
  "mediaUrl": "<string>",
  "filename": "<string>",
  "type": "text",
  "parameters": [
    "<string>"
  ],
  "buttonPayloads": [
    {}
  ],
  "actions": {},
  "headerParameters": [
    "<string>"
  ],
  "buttonParameters": [
    {
      "payload": {},
      "param": 123
    }
  ],
  "ltoParams": {
    "expirationTime": 123
  },
  "cards": [
    {
      "mediaUrl": "<string>",
      "params": [
        "<string>"
      ],
      "buttonParameters": [
        {
          "payload": {},
          "param": 123
        }
      ]
    }
  ],
  "expirationTime": "<string>",
  "campaignId": "<string>"
}
'

import requests

url = "https://api.jelou.ai/v2/whatsapp/{botId}/hsm"

payload = {
    "elementName": "<string>",
    "destinations": ["<string>"],
    "mediaUrl": "<string>",
    "filename": "<string>",
    "type": "text",
    "parameters": ["<string>"],
    "buttonPayloads": [{}],
    "actions": {},
    "headerParameters": ["<string>"],
    "buttonParameters": [
        {
            "payload": {},
            "param": 123
        }
    ],
    "ltoParams": { "expirationTime": 123 },
    "cards": [
        {
            "mediaUrl": "<string>",
            "params": ["<string>"],
            "buttonParameters": [
                {
                    "payload": {},
                    "param": 123
                }
            ]
        }
    ],
    "expirationTime": "<string>",
    "campaignId": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    elementName: '<string>',
    destinations: ['<string>'],
    mediaUrl: '<string>',
    filename: '<string>',
    type: 'text',
    parameters: ['<string>'],
    buttonPayloads: [{}],
    actions: {},
    headerParameters: ['<string>'],
    buttonParameters: [{payload: {}, param: 123}],
    ltoParams: {expirationTime: 123},
    cards: [
      {
        mediaUrl: '<string>',
        params: ['<string>'],
        buttonParameters: [{payload: {}, param: 123}]
      }
    ],
    expirationTime: '<string>',
    campaignId: '<string>'
  })
};

fetch('https://api.jelou.ai/v2/whatsapp/{botId}/hsm', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jelou.ai/v2/whatsapp/{botId}/hsm",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'elementName' => '<string>',
    'destinations' => [
        '<string>'
    ],
    'mediaUrl' => '<string>',
    'filename' => '<string>',
    'type' => 'text',
    'parameters' => [
        '<string>'
    ],
    'buttonPayloads' => [
        [
                
        ]
    ],
    'actions' => [
        
    ],
    'headerParameters' => [
        '<string>'
    ],
    'buttonParameters' => [
        [
                'payload' => [
                                
                ],
                'param' => 123
        ]
    ],
    'ltoParams' => [
        'expirationTime' => 123
    ],
    'cards' => [
        [
                'mediaUrl' => '<string>',
                'params' => [
                                '<string>'
                ],
                'buttonParameters' => [
                                [
                                                                'payload' => [
                                                                                                                                
                                                                ],
                                                                'param' => 123
                                ]
                ]
        ]
    ],
    'expirationTime' => '<string>',
    'campaignId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jelou.ai/v2/whatsapp/{botId}/hsm"

	payload := strings.NewReader("{\n  \"elementName\": \"<string>\",\n  \"destinations\": [\n    \"<string>\"\n  ],\n  \"mediaUrl\": \"<string>\",\n  \"filename\": \"<string>\",\n  \"type\": \"text\",\n  \"parameters\": [\n    \"<string>\"\n  ],\n  \"buttonPayloads\": [\n    {}\n  ],\n  \"actions\": {},\n  \"headerParameters\": [\n    \"<string>\"\n  ],\n  \"buttonParameters\": [\n    {\n      \"payload\": {},\n      \"param\": 123\n    }\n  ],\n  \"ltoParams\": {\n    \"expirationTime\": 123\n  },\n  \"cards\": [\n    {\n      \"mediaUrl\": \"<string>\",\n      \"params\": [\n        \"<string>\"\n      ],\n      \"buttonParameters\": [\n        {\n          \"payload\": {},\n          \"param\": 123\n        }\n      ]\n    }\n  ],\n  \"expirationTime\": \"<string>\",\n  \"campaignId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.jelou.ai/v2/whatsapp/{botId}/hsm")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"elementName\": \"<string>\",\n  \"destinations\": [\n    \"<string>\"\n  ],\n  \"mediaUrl\": \"<string>\",\n  \"filename\": \"<string>\",\n  \"type\": \"text\",\n  \"parameters\": [\n    \"<string>\"\n  ],\n  \"buttonPayloads\": [\n    {}\n  ],\n  \"actions\": {},\n  \"headerParameters\": [\n    \"<string>\"\n  ],\n  \"buttonParameters\": [\n    {\n      \"payload\": {},\n      \"param\": 123\n    }\n  ],\n  \"ltoParams\": {\n    \"expirationTime\": 123\n  },\n  \"cards\": [\n    {\n      \"mediaUrl\": \"<string>\",\n      \"params\": [\n        \"<string>\"\n      ],\n      \"buttonParameters\": [\n        {\n          \"payload\": {},\n          \"param\": 123\n        }\n      ]\n    }\n  ],\n  \"expirationTime\": \"<string>\",\n  \"campaignId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jelou.ai/v2/whatsapp/{botId}/hsm")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"elementName\": \"<string>\",\n  \"destinations\": [\n    \"<string>\"\n  ],\n  \"mediaUrl\": \"<string>\",\n  \"filename\": \"<string>\",\n  \"type\": \"text\",\n  \"parameters\": [\n    \"<string>\"\n  ],\n  \"buttonPayloads\": [\n    {}\n  ],\n  \"actions\": {},\n  \"headerParameters\": [\n    \"<string>\"\n  ],\n  \"buttonParameters\": [\n    {\n      \"payload\": {},\n      \"param\": 123\n    }\n  ],\n  \"ltoParams\": {\n    \"expirationTime\": 123\n  },\n  \"cards\": [\n    {\n      \"mediaUrl\": \"<string>\",\n      \"params\": [\n        \"<string>\"\n      ],\n      \"buttonParameters\": [\n        {\n          \"payload\": {},\n          \"param\": 123\n        }\n      ]\n    }\n  ],\n  \"expirationTime\": \"<string>\",\n  \"campaignId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

[
  {
    "id": "<string>",
    "destination": "<string>"
  }
]

{
  "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": {}
}

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

POST

{botId}

hsm

Send Individual HSM

curl --request POST \
  --url https://api.jelou.ai/v2/whatsapp/{botId}/hsm \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "elementName": "<string>",
  "destinations": [
    "<string>"
  ],
  "mediaUrl": "<string>",
  "filename": "<string>",
  "type": "text",
  "parameters": [
    "<string>"
  ],
  "buttonPayloads": [
    {}
  ],
  "actions": {},
  "headerParameters": [
    "<string>"
  ],
  "buttonParameters": [
    {
      "payload": {},
      "param": 123
    }
  ],
  "ltoParams": {
    "expirationTime": 123
  },
  "cards": [
    {
      "mediaUrl": "<string>",
      "params": [
        "<string>"
      ],
      "buttonParameters": [
        {
          "payload": {},
          "param": 123
        }
      ]
    }
  ],
  "expirationTime": "<string>",
  "campaignId": "<string>"
}
'

import requests

url = "https://api.jelou.ai/v2/whatsapp/{botId}/hsm"

payload = {
    "elementName": "<string>",
    "destinations": ["<string>"],
    "mediaUrl": "<string>",
    "filename": "<string>",
    "type": "text",
    "parameters": ["<string>"],
    "buttonPayloads": [{}],
    "actions": {},
    "headerParameters": ["<string>"],
    "buttonParameters": [
        {
            "payload": {},
            "param": 123
        }
    ],
    "ltoParams": { "expirationTime": 123 },
    "cards": [
        {
            "mediaUrl": "<string>",
            "params": ["<string>"],
            "buttonParameters": [
                {
                    "payload": {},
                    "param": 123
                }
            ]
        }
    ],
    "expirationTime": "<string>",
    "campaignId": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    elementName: '<string>',
    destinations: ['<string>'],
    mediaUrl: '<string>',
    filename: '<string>',
    type: 'text',
    parameters: ['<string>'],
    buttonPayloads: [{}],
    actions: {},
    headerParameters: ['<string>'],
    buttonParameters: [{payload: {}, param: 123}],
    ltoParams: {expirationTime: 123},
    cards: [
      {
        mediaUrl: '<string>',
        params: ['<string>'],
        buttonParameters: [{payload: {}, param: 123}]
      }
    ],
    expirationTime: '<string>',
    campaignId: '<string>'
  })
};

fetch('https://api.jelou.ai/v2/whatsapp/{botId}/hsm', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jelou.ai/v2/whatsapp/{botId}/hsm",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'elementName' => '<string>',
    'destinations' => [
        '<string>'
    ],
    'mediaUrl' => '<string>',
    'filename' => '<string>',
    'type' => 'text',
    'parameters' => [
        '<string>'
    ],
    'buttonPayloads' => [
        [
                
        ]
    ],
    'actions' => [
        
    ],
    'headerParameters' => [
        '<string>'
    ],
    'buttonParameters' => [
        [
                'payload' => [
                                
                ],
                'param' => 123
        ]
    ],
    'ltoParams' => [
        'expirationTime' => 123
    ],
    'cards' => [
        [
                'mediaUrl' => '<string>',
                'params' => [
                                '<string>'
                ],
                'buttonParameters' => [
                                [
                                                                'payload' => [
                                                                                                                                
                                                                ],
                                                                'param' => 123
                                ]
                ]
        ]
    ],
    'expirationTime' => '<string>',
    'campaignId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jelou.ai/v2/whatsapp/{botId}/hsm"

	payload := strings.NewReader("{\n  \"elementName\": \"<string>\",\n  \"destinations\": [\n    \"<string>\"\n  ],\n  \"mediaUrl\": \"<string>\",\n  \"filename\": \"<string>\",\n  \"type\": \"text\",\n  \"parameters\": [\n    \"<string>\"\n  ],\n  \"buttonPayloads\": [\n    {}\n  ],\n  \"actions\": {},\n  \"headerParameters\": [\n    \"<string>\"\n  ],\n  \"buttonParameters\": [\n    {\n      \"payload\": {},\n      \"param\": 123\n    }\n  ],\n  \"ltoParams\": {\n    \"expirationTime\": 123\n  },\n  \"cards\": [\n    {\n      \"mediaUrl\": \"<string>\",\n      \"params\": [\n        \"<string>\"\n      ],\n      \"buttonParameters\": [\n        {\n          \"payload\": {},\n          \"param\": 123\n        }\n      ]\n    }\n  ],\n  \"expirationTime\": \"<string>\",\n  \"campaignId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.jelou.ai/v2/whatsapp/{botId}/hsm")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"elementName\": \"<string>\",\n  \"destinations\": [\n    \"<string>\"\n  ],\n  \"mediaUrl\": \"<string>\",\n  \"filename\": \"<string>\",\n  \"type\": \"text\",\n  \"parameters\": [\n    \"<string>\"\n  ],\n  \"buttonPayloads\": [\n    {}\n  ],\n  \"actions\": {},\n  \"headerParameters\": [\n    \"<string>\"\n  ],\n  \"buttonParameters\": [\n    {\n      \"payload\": {},\n      \"param\": 123\n    }\n  ],\n  \"ltoParams\": {\n    \"expirationTime\": 123\n  },\n  \"cards\": [\n    {\n      \"mediaUrl\": \"<string>\",\n      \"params\": [\n        \"<string>\"\n      ],\n      \"buttonParameters\": [\n        {\n          \"payload\": {},\n          \"param\": 123\n        }\n      ]\n    }\n  ],\n  \"expirationTime\": \"<string>\",\n  \"campaignId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jelou.ai/v2/whatsapp/{botId}/hsm")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"elementName\": \"<string>\",\n  \"destinations\": [\n    \"<string>\"\n  ],\n  \"mediaUrl\": \"<string>\",\n  \"filename\": \"<string>\",\n  \"type\": \"text\",\n  \"parameters\": [\n    \"<string>\"\n  ],\n  \"buttonPayloads\": [\n    {}\n  ],\n  \"actions\": {},\n  \"headerParameters\": [\n    \"<string>\"\n  ],\n  \"buttonParameters\": [\n    {\n      \"payload\": {},\n      \"param\": 123\n    }\n  ],\n  \"ltoParams\": {\n    \"expirationTime\": 123\n  },\n  \"cards\": [\n    {\n      \"mediaUrl\": \"<string>\",\n      \"params\": [\n        \"<string>\"\n      ],\n      \"buttonParameters\": [\n        {\n          \"payload\": {},\n          \"param\": 123\n        }\n      ]\n    }\n  ],\n  \"expirationTime\": \"<string>\",\n  \"campaignId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

[
  {
    "id": "<string>",
    "destination": "<string>"
  }
]

{
  "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": {}
}

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

The WhatsApp API allows companies to automate and personalize communication with their customers, enabling efficient, scalable interactions enriched with multimedia content. It is ideal for managing inquiries, sending notifications, and providing immediate responses through AI Agents.

Message sending configuration

Step 1: Define the Endpoint

To send messages, use the following API endpoint:

POST https://api.jelou.ai/v2/whatsapp/{botId}/hsm

Step 2: Request Parameters

The key parameters for the request include:

Text: The message content.
Message type (type): Defines the type of template to be sent.
Template property: Template previously created and approved by META.
Media file: If the template requires a URL (image, document, etc.).
Bot ID: Unique bot identifier.
Parameters: Specific data for each send (name, order number, etc.).

Step 3: Send the request

Send the message using the POST method. Upon completing the send, you will receive a response that allows you to verify the delivery status.

Make sure to comply with WhatsApp policies to avoid restrictions.

Content restrictions

Remember that, to send messages through WhatsApp, you must use templates previously approved by META. Each template has specific limitations based on its format and content, such as message length or the type of information allowed. Make sure to review these restrictions before using them to ensure correct delivery. Keep in mind that:

URLs, emojis, and multimedia files are not allowed within authentication messages.
Parameters must have a maximum of 15 characters.

Request Body

Property	Type	Description	Required
mediaUrl	string	Public URL of the media file. Required if your template is of type video, image, or document.	Conditional
filename	string	File name for document-type templates.	Conditional
type	string	Message type: `text`, `hsm`, `image`, `document`, `video`, `catalog`, `carousel`. Defaults to `text`.	No
language	string	Template language: `en`, `es`, `pt`	No
elementName	string	Name of the approved template.	Yes
parameters	array	Set of strings that replace values in the template.	Yes
destinations	array	List of recipients. Each element can be a phone number (numeric format with country code, without `+` or spaces) or a BSUID.	Yes
buttonPayloads	array	Information for quick reply buttons.	No
actions	object	Template configuration and actions in payload format.	No
headerParameters	array	Header parameter, maximum 1 parameter.	No
thumbnailProduct	string	Thumbnail image URL. Required for catalog templates.	Conditional
expirationTime	string	Expiration time in timestamp format (milliseconds).	No
campaignId	string	Unique identifier of the associated campaign.	No
buttonParameters	array	Configuration for all button types.	No
ltoParams	object	Limited time offer (LTO) parameters.	No
cards	array	Content cards for carousel templates.	No

Template types

In this section, we share request examples for the different template types. These examples provide a clear guide so you can easily substitute the values with your own data.

If a template name or a button within the JSON differs from the already approved template, even by an accent mark, the send will fail. Precision is key to ensuring functionality.

Text message

curl --request POST \
  --url 'https://api.jelou.ai/v2/whatsapp/BOT_ID/hsm' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "parameters": ["PARAMETER_1", "PARAMETER_2"],
    "destinations": ["PHONE_NUMBER"],
    "elementName": "ELEMENT_NAME"
  }'

Message with image

curl --request POST \
  --url 'https://api.jelou.ai/v2/whatsapp/BOT_ID/hsm' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "parameters": ["PARAMETER_1", "PARAMETER_2"],
    "mediaUrl": "https://cdn.example.com/image.jpeg",
    "type": "image",
    "destinations": ["PHONE_NUMBER"],
    "elementName": "ELEMENT_NAME"
  }'

Message with video

curl --request POST \
  --url 'https://api.jelou.ai/v2/whatsapp/BOT_ID/hsm' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "parameters": ["PARAMETER_1", "PARAMETER_2"],
    "mediaUrl": "https://cdn.example.com/video.mp4",
    "type": "video",
    "destinations": ["PHONE_NUMBER"],
    "elementName": "ELEMENT_NAME"
  }'

Message with attached document

curl --request POST \
  --url 'https://api.jelou.ai/v2/whatsapp/BOT_ID/hsm' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "parameters": ["PARAMETER_1"],
    "mediaUrl": "https://cdn.example.com/document.pdf",
    "type": "document",
    "destinations": ["PHONE_NUMBER"],
    "elementName": "ELEMENT_NAME"
  }'

Text message with static URL action buttons

curl --request POST \
  --url 'https://api.jelou.ai/v2/whatsapp/BOT_ID/hsm' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "parameters": ["PARAMETER_1"],
    "destinations": ["PHONE_NUMBER"],
    "elementName": "ELEMENT_NAME"
  }'

Text message with dynamic URL action buttons

curl --request POST \
  --url 'https://api.jelou.ai/v2/whatsapp/BOT_ID/hsm' \
  --header 'Accept-Language: en' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "destinations": ["PHONE_NUMBER"],
    "parameters": ["PARAMETER_1"],
    "elementName": "ELEMENT_NAME",
    "buttonParameters": [
      {
        "type": "URL",
        "payload": {"param": "PARAM_URL"}
      }
    ]
  }'

Text message with Quick Reply buttons

curl --request POST \
  --url 'https://api.jelou.ai/v2/whatsapp/BOT_ID/hsm' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "elementName": "ELEMENT_NAME",
    "language": "en",
    "type": "text",
    "parameters": ["param1", "param2"],
    "destinations": ["PHONE_NUMBER"],
    "buttonParameters": [
      {
        "type": "QUICK_REPLY",
        "payload": {"type": "edge", "action": "BTN1", "skillId": "1"}
      },
      {
        "type": "QUICK_REPLY",
        "payload": {"type": "edge", "action": "BTN2", "skillId": "2"}
      },
      {
        "type": "QUICK_REPLY",
        "payload": {"type": "edge", "action": "BTN3", "skillId": "3"}
      }
    ]
  }'

Personalized text message with header parameters

curl --request POST \
  --url 'https://api.jelou.ai/v2/whatsapp/BOT_ID/hsm' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "elementName": "ELEMENT_NAME",
    "destinations": ["PHONE_NUMBER"],
    "parameters": ["PARAMETER_1", "PARAMETER_2"],
    "headerParameters": ["PARAMETER_VALUE"]
  }'

Full catalog

curl --request POST \
  --url 'https://api.jelou.ai/v2/whatsapp/BOT_ID/hsm' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "elementName": "ELEMENT_NAME",
    "destinations": ["PHONE_NUMBER"],
    "parameters": ["PARAMETER_1"],
    "type": "catalog",
    "buttonParameters": [
      {
        "type": "CATALOG",
        "payload": {"thumbnailProduct": "productId"}
      }
    ]
  }'

LTO with copy code button

curl --request POST \
  --url 'https://api.jelou.ai/v2/whatsapp/BOT_ID/hsm' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "buttonOptions": {},
    "elementName": "ELEMENT_NAME",
    "destinations": ["PHONE_NUMBER"],
    "parameters": ["PARAMETER_1", "PARAMETER_2"],
    "type": "image",
    "mediaUrl": "https://cdn.example.com/image.jpeg",
    "ltoParams": {"expirationTime": 1733260800000},
    "buttonParameters": [
      {
        "type": "COPY_CODE",
        "param": 1,
        "payload": {"param": "20OFF"}
      }
    ]
  }'

Authentication

curl --request POST \
  --url 'https://api.jelou.ai/v2/whatsapp/BOT_ID/hsm' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "buttonOptions": {},
    "elementName": "ELEMENT_NAME",
    "destinations": ["PHONE_NUMBER"],
    "parameters": ["PARAMETER_1"],
    "type": "hsm"
  }'

Carousel with 2 cards

curl --request POST \
  --url 'https://api.jelou.ai/v2/whatsapp/BOT_ID/hsm' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "elementName": "ELEMENT_NAME",
    "destinations": ["PHONE_NUMBER"],
    "parameters": [],
    "type": "carousel",
    "cards": [
      {
        "mediaUrl": "https://cdn.example.com/product1.jpg",
        "params": ["PARAMETER_VALUE"],
        "buttonParameters": [
          {
            "type": "QUICK_REPLY",
            "payload": {"action": "Button 1", "type": "edge", "skillId": "45515", "cardIndex": 0}
          }
        ]
      },
      {
        "mediaUrl": "https://cdn.example.com/product2.jpg",
        "params": ["PARAMETER_VALUE_1", "PARAMETER_VALUE_2"],
        "buttonParameters": [
          {
            "type": "QUICK_REPLY",
            "payload": {"action": "Button 2", "type": "edge", "skillId": "10192", "cardIndex": 1}
          }
        ]
      }
    ]
  }'

Common use cases

1. Personalized messages

Use templates with variables to send messages tailored to each user’s needs (for example, payment reminders or order updates).

2. Automation with Webhooks

Personalized interactions based on user responses, allowing for a more dynamic and efficient conversation. Campaign examples:

Personalized promotions: Exclusive offers based on customer preferences.
Payment reminders: Automatic notifications for invoice due dates.
Service quotes: Quick inquiries about insurance, loans, etc.

Advanced configuration

Phone number

Since this is an individual send, the phone number of the recipient must be in the correct format for the send to be successful. The + sign must be omitted, the country code must be included, and only numeric characters are allowed. Dashes or spaces are not accepted.

For users in Ecuador: The ”+” sign and the first 0 of the phone number must be omitted for it to be entered correctly.

✅ Correct format	❌ Incorrect format	❌ Incorrect format
PHONE_NUMBER	+PHONE_NUMBER	09XXXXXXXX

Specific parameters

Depending on the campaign, you can use personalized data such as the message type or additional customer information.

Sending to recipients identified by BSUID

In addition to a phone number, destinations accepts a BSUID (Business-Scoped User ID): an identifier with the format CC.alphanumeric (e.g.: US.13491208655302741918) that Meta assigns when a user enables number privacy in WhatsApp, replacing their real phone number. If you already know a user’s BSUID —for example, because you received it in an incoming webhook—, you can use it directly to send them a template without needing their phone number.

curl --request POST \
  --url 'https://api.jelou.ai/v2/whatsapp/BOT_ID/hsm' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "parameters": ["PARAMETER_1", "PARAMETER_2"],
    "destinations": ["BSUID"],
    "elementName": "ELEMENT_NAME"
  }'

BSUID cannot be used to send AUTHENTICATION (OTP) templates; that recipient must be sent as a phone number. If you send a BSUID for an AUTHENTICATION template, that specific recipient is skipped from the send —the rest of the batch continues normally— and if every recipient in the request fails resolution, the response is an empty array [].

Message personalization

Linking with Workflows

Each message can be associated with a specific workflow that defines how the user’s response should be handled. This is useful for creating more complex and targeted interactions, such as interactive menus or surveys.

Button configuration

Button Payload

You can use the following structure in the buttonPayloads field when your template includes quick reply buttons using workflows; this will allow you to activate additional flows within the conversation based on the action selected by the user.

[
  {"type": "edge", "action": "Yes", "skillId": "1"},
  {"type": "edge", "action": "Reschedule", "skillId": "2"},
  {"type": "edge", "action": "Cancel", "skillId": "3"}
]

In this case, each button must have the keys type, action, and skillId. The action key defines the text that will appear on the button, while skillId indicates the ID of the workflow that the button will activate.

To get the skillId of a workflow, hover over the workflow name in Brain Studio. A tooltip will appear showing the corresponding ID.

Actions Payload

Redirect users to specific workflows based on their choice or interaction.Templates allow the following configurations:

{
  "actions": {
    "setSkill": {"id": 2222}
  }
}

To get the skillId of the workflow, hover over the workflow name in Brain Studio. A tooltip will appear showing the corresponding ID.

{
  "actions": {
    "setMemoryParams": {
      "url": "https://apps.jelou.ai"
    }
  }
}

Cache Parameters

This function is used to save additional information in the cache for later use. It will depend on the desired configuration for the template. If a URL is sent, it can be used by a workflow to redirect that URL for marketing purposes. All parameters to be stored in cache must go in setMemoryParams with their respective key-value fields.

This configuration will be valid for 3 months.

{
  "actions": {
    "setMemoryParams": {
      "url": "https://apps.jelou.ai"
    }
  }
}

API Responses

200 - Successful response

[
  {
    "id": "msg-12345-67890-abcde-fghij-klmno",
    "destination": "PHONE_NUMBER"
  }
]

400 - Bad Request

{
  "message": ["Template does not exist"],
  "status": "failed",
  "_metadata": {
    "error": {},
    "body": {
      "destinations": [{"destination": "PHONE_NUMBER"}],
      "parameters": ["John", "example_value"],
      "elementName": "sample_template",
      "code": "en",
      "type": "text",
      "botId": "BOT_ID",
      "botName": "Your Channel"
    }
  },
  "error": {}
}

401 - Unauthorized

{
  "message": "Authentication failed"
}

404 - Not Found

{
  "message": ["The Channel could not be found at the moment."],
  "statusMessage": "failed",
  "status": 0,
  "error": {
    "code": "E1019",
    "key": "BOT_NOT_FOUND",
    "description": "Error to be thrown when trying to get a channel.",
    "developerMessages": {
      "es": "El botId no se encuentra en la base de datos o ha sido eliminado.",
      "en": "The botId is not found in the database or has been deleted."
    },
    "clientMessages": {
      "es": "El canal no se pudo encontrar por el momento.",
      "en": "The Channel could not be found at the moment."
    }
  }
}

422 - Unprocessable Entity

{
  "message": ["The values entered are not correct."],
  "statusMessage": "failed",
  "status": 0,
  "error": {
    "code": "E0422",
    "key": "VALIDATOR_ERROR",
    "description": "Error to be thrown when cannot process request because of incoming values",
    "developerMessages": {
      "es": "Los valores del request no son correctos para ser procesados.",
      "en": "The request values are not correct for processing."
    },
    "clientMessages": {
      "es": "Los valores ingresados no son correctos.",
      "en": "The values entered are not correct."
    }
  },
  "validationError": {
    "parameters": [
      {
        "en": "The number of parameters is incorrect.",
        "es": "El número de parámetros es incorrecto."
      }
    ]
  }
}

500 - Internal Server Error

{
  "message": ["We are having trouble processing your request. Please try again later."],
  "statusMessage": "failed",
  "status": 0,
  "error": {
    "code": "E0000",
    "key": "UNKNOWN_ERROR",
    "description": "Error to be thrown when it couldn't be determined the reason of failure",
    "developerMessages": {
      "es": "Error inesperado occurido, revisar logs.",
      "en": "Unexpected error occurred, check logs."
    },
    "clientMessages": {
      "es": "Estamos teniendo problemas procesando la solicitud. Por favor intenta mas tarde.",
      "en": "We are having trouble processing your request. Please try again later."
    }
  }
}

Recommended tools for testing

To facilitate testing and sending requests, we recommend using tools such as:

Postman
Insomnia

These tools allow you to make HTTP requests easily, test different configurations, and review API responses.

Frequently asked questions

How many characters are allowed?

There is currently no defined character limit per message; however, you should be mindful of the size of files that are part of the message, such as: image, video, or document. These are shared via mediaUrl.At Jelou, we have the following size and format limitations to follow:

DOCUMENT: Up to 15MB - Format: .pdf
VIDEO: Up to 15MB - Format: .mp4
IMAGE: Up to 5MB - Formats: .jpg, .jpeg, .png

How is the API consumed?

Both the bulk and 1-1 send cURLs can be consumed in any HTTPS client such as Insomnia or Postman. Simply create an HTTPS request using the cURL (just paste it), then change the data and execute.Here is an example with basic-auth:

curl --request POST \
  --url 'https://api.jelou.ai/v2/whatsapp/BOT_ID/hsm' \
  --header 'Accept-Language: en' \
  --header 'Authorization: Basic {{Base64EncodedUsername:Password}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "destinations": ["PHONE_NUMBER"],
    "parameters": [],
    "elementName": "your_template_name"
  }'

Authorizations

Authorization

string

header

required

Basic authentication using Base64 encoded clientId:clientSecret

Path Parameters

botId

string

required

The unique identifier of the bot

Body

application/json

elementName

string

required

Approved template name

destinations

string[]

required

Recipients: phone numbers with country code and no + sign, or BSUIDs (Business-Scoped User IDs)

mediaUrl

string<uri>

Public URL for media (required for image/video/document templates)

filename

string

Filename for document templates

type

enum<string>

default:text

Available options:

text,

hsm,

image,

document,

video,

catalog,

carousel

language

enum<string>

Available options:

en,

es,

pt

parameters

string[]

Template parameter values

buttonPayloads

object[]

actions

object

headerParameters

string[]

Maximum array length: 1

buttonParameters

object[]

Show child attributes

ltoParams

object

Show child attributes

cards

object[]

Show child attributes

expirationTime

string

Expiration timestamp in milliseconds

campaignId

string

Response

HSM sent successfully

string

destination

string

⌘I

API reference

Send Messages

Campaigns

Conversations

Metrics

Users

Resources

Widget

Datum

External Support Panel

Custom Channel

Memory Management

Message sending configuration

Step 1: Define the Endpoint

Step 2: Request Parameters

Step 3: Send the request

Content restrictions

Request Body

Template types

Common use cases

1. Personalized messages

2. Automation with Webhooks

Advanced configuration

Phone number

Specific parameters

Sending to recipients identified by BSUID

Message personalization

Linking with Workflows

Button configuration

Cache Parameters

API Responses

Recommended tools for testing

Frequently asked questions

Authorizations

Path Parameters

Body

Response

​Message sending configuration

​Step 1: Define the Endpoint

​Step 2: Request Parameters

​Step 3: Send the request

​Content restrictions

​Request Body

​Template types

​Common use cases

​1. Personalized messages

​2. Automation with Webhooks

​Advanced configuration

​Phone number

​Specific parameters

​Sending to recipients identified by BSUID

​Message personalization

​Linking with Workflows

​Button configuration

​Cache Parameters

​API Responses

​Recommended tools for testing

​Frequently asked questions

Authorizations

Path Parameters

Body

Response

Message sending configuration

Step 1: Define the Endpoint

Step 2: Request Parameters

Step 3: Send the request

Content restrictions

Request Body

Template types

Common use cases

1. Personalized messages

2. Automation with Webhooks

Advanced configuration

Phone number

Specific parameters

Sending to recipients identified by BSUID

Message personalization

Linking with Workflows

Button configuration

Cache Parameters

API Responses

Recommended tools for testing

Frequently asked questions