Batch Calling - Bolna Docs

Batch functionality is not active by default.
Please contact us at founders@bolna.dev for activation.

Batch structure

Create a CSV file of contact list

All phone numbers should include the country prefix in E.164 format
All phone numbers in the CSV file should have contact_number as the header
All other variables can be included in the CSV file

Example CSV file

contact_number,first_name,last_name
+11231237890,Bruce,Wayne
+91012345678,Bruce,Lee
+00021000000,Satoshi,Nakamoto
+44999999007,James,Bond

Using APIs to manage and control batches

1. Create a batch for agent

Once the CSV file is ready, upload it using the /create Batch API

curl --location 'https://api.bolna.dev/batches' \
--header 'Authorization: Bearer <api_key>' \
--form 'agent_id="aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"' \
--form 'file=@"/my-first-batch.csv"'

2. Scheduling the batch

After receiving your batch_id, you can schedule a batch using /schedule Batch API

The scheduled date and time should be in UTC ISO 8601 format.

curl --location 'https://api.bolna.dev/batches/schedule' \
--header 'Authorization: Bearer <api_key>' \
--form 'agent_id="aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"' \
--form 'batch_id="abcdefghijklmnopqrstuvwxyz012345"' \
--form 'scheduled_at="2024-03-20T18:01:03.040697"'

3. Retrieving batch status

Check the status of the batch using /get_batch Batch API

4. Retrieving all batch executions

Once the batch has run, you can check all executions by the agent using /executions Batch API

Get Started

​Batch structure

​Create a CSV file of contact list

​Example CSV file

​Using APIs to manage and control batches

​1. Create a batch for agent

​2. Scheduling the batch

​3. Retrieving batch status

​4. Retrieving all batch executions