Send Bulk

Use this feature to message in bulk your customers. The API will handle the delivery to the recipients from a column-based file. Send bulk is useful to take a dynamic config from a specific source.

Sending bulk messages is used to send a preset template with different values related to each customer so that you can select dynamic information from a source like a file in order to automatize and send your campaign easily. Review the code below for more instructions.

Send outbound message from file

Send outbound message to Whatsapp users.

Create a New Campaign

Click on "Create." A modal will open where you must enter the campaign name.

Select Company and Template

Choose the company and template to use, along with the bot. If using a master company with access to other companies, you will see a company selector.

Attach Images

If the template includes images, click on the image section to attach one. Browse and select the desired image.

Upload CSV File

Select the CSV file containing the customer numbers to send the templates to. Click "Search File" and upload your CSV.

Template guidelines

The source (file) must be created following the next specification:

• Support files only with the "CSV" extension.

• You must define a header on the first row of the file

• The first column defines the phone number destination

• The remaining columns are used for parameter values

• Microsoft Excel application must have only one sheet

Your order {{1}} for a total of {{2}} is confirmed. The expected delivery is {{3}}.

phone number	param 1	param 2	param 3
18632557992	0001	5 chunks	December 9th
1865323999	0002	1 bottle	January 5th
1225468999	0003	3 boxes	March 3rd

The CSV file must be UTF-8 encoded

Configure Template Parameters

Match template parameters with CSV columns. For example, replace the "client" parameter with the "customer name" column from the CSV.

Configure Buttons (if applicable)

If the template includes buttons, configure them. Flow buttons trigger specific flows within WhatsApp.

Configure CRM Parameters

If your bot or company has CRM parameters, match these with CSV columns. For example, map the "Cedula" and "Surname" fields.

Schedule or Send Now

Review the configuration and schedule the campaign for a specific date and time, or send it immediately.

On the code:

POST https://api.jelou.ai/v2/hsm/file

Request Body

Name	Type	Description
file	string	Source file File extension should be csv.
fileUrl	string	Source file url File extension should be csv.
campaignName	string	Campaign name.
elementName	string	Element name.
params	object	Parameters.
botId	string	Array of strings containing the values to replace in the hsm template.
date	string	UTC date where campaign will be sent.

200

{
  "message": [
    "Campaign has been created."
  ],
  "status": "success"

400: Bad Request

Errors related to the file format and the number of parameters

{
  "message": [
    "File header is not valid."
  ],
  "status": "failed",
  "_metadata": {
    "error": {},
    "body": {
      "campaignName": "Prueba_01",
      "elementName": "test_01",
      "params": [
        {
          "param": 1,
          "column": "TelefonoInt Clean"
        },
        {
          "param": 3,
          "column": "valor"
        }
      ]
    }
  },
  "error": {}
}

404: Not Found

The botId used to send the template does not exist.

{
  "message": [
    "The Bot 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 Bot.",
    "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.",
      "pt": "A botId não é encontrada no banco de dados ou foi apagada."
    },
    "clientMessages": {
      "es": "El Bot no se pudo encontrar por el momento.",
      "en": "The Bot could not be found at the moment.",
      "pt": "A Bot não pôde ser encontrada no momento."
    }
  }
}

422: Unprocessable Entity

Validation error, occurs when the sent payload does not follow the format validations for each field of the payload.

{
  "message": [
    "Los valores ingresados no son correctos."
  ],
  "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": {
    "elementName": [
      "the elementName field is required",
      "the elementName field must be a string",
      "the elementName field must be non empty"
    ],
    "params": [
      "the params field is required",
      "the params field must be an array"
    ]
  }
}

500: Internal Server Error

Server error trying to process campaign submission request.

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