GET
/
batches
/
{batch_id}

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
batch_id
string

The ID of the batch

created_at
string

Created timestamp of batch

execution_status
object

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

file_name
string

Name of the CSV batch file uploaded

from_phone_number
string

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

humanized_created_at
string

Human-readable relative time since batch creation

scheduled_at
string

The scheduled batch timestamp in UTC

status
enum<string>

Current status of the batch

Available options:
scheduled,
created,
queued,
executed
total_contacts
integer

Count of all contacts mentioned in the CSV file

updated_at
string

Last updated timestamp of batch

valid_contacts
integer

Count of all valid contacts found in the CSV file