GET
/
batches
/
{batch_id}
curl --request GET \
  --url https://api.bolna.dev/batches/{batch_id} \
  --header 'Authorization: Bearer <token>'
{
  "batch_id": "3c90c3cc0d444b5088888dd25736052a",
  "humanized_created_at": "5 minutes ago",
  "created_at": "2024-01-23T05:14:37Z",
  "updated_at": "2024-02-29T04:22:89Z",
  "status": "scheduled",
  "scheduled_at": "2024-01-29T08:30:00Z",
  "from_phone_number": "+19876543007",
  "file_name": "customers.csv",
  "valid_contacts": 7,
  "total_contacts": 11,
  "execution_status": {
    "completed": 1,
    "ringing": 10,
    "in-progress": 15
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
batch_id
string
required

The ID of the batch

Response

200
application/json
agent status response
​
batch_id
string

The ID of the batch

Example:

"3c90c3cc0d444b5088888dd25736052a"

​
humanized_created_at
string

Human-readable relative time since batch creation

Example:

"5 minutes ago"

​
created_at
string

Created timestamp of batch

Example:

"2024-01-23T05:14:37Z"

​
updated_at
string

Last updated timestamp of batch

Example:

"2024-02-29T04:22:89Z"

​
status
enum<string>

Current status of the batch

Available options:
scheduled,
created,
queued,
executed
Example:

"scheduled"

​
scheduled_at
string

The scheduled batch timestamp in UTC

Example:

"2024-01-29T08:30:00Z"

​
from_phone_number
string

Phone number of the sender alongwith country code (in E.164 format)

Example:

"+19876543007"

​
file_name
string

Name of the CSV batch file uploaded

Example:

"customers.csv"

​
valid_contacts
integer

Count of all valid contacts found in the CSV file

Example:

7

​
total_contacts
integer

Count of all contacts mentioned in the CSV file

Example:

11

​
execution_status
object

Provides a count-wise breakdown of executions based on their current status. View all possible statuses

Example:
{
  "completed": 1,
  "ringing": 10,
  "in-progress": 15
}
Previous
Create batch
Next