Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

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

Path Parameters

agent_id
string<uuid>
required

The ID of the agent

Response

list batches response

batch_id
string

The ID of the batch

Pattern: ^[0-9a-fA-F]{32}$
Example:

"3c90c3cc0d444b5088888dd25736052a"

humanized_created_at
string

Human-readable relative time since batch creation

Example:

"5 minutes ago"

created_at
string<date-time>

Created timestamp of batch

Example:

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

updated_at
string<date-time>

Last updated timestamp of batch

Example:

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

status
enum<string>

Current status of the batch. Progression: created → scheduled → running → completed. stopped means manually halted; failed means an error prevented execution.

Available options:
created,
scheduled,
running,
completed,
stopped,
failed
Example:

"scheduled"

scheduled_at
string<date-time>

The scheduled batch timestamp in UTC

Example:

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

from_phone_number
string
deprecated

Deprecated. Use from_phone_numbers instead. Phone number of the sender along with country code (in E.164 format).

Example:

"+19876543007"

from_phone_numbers
string[]

List of phone numbers from which the batch calls are made. Each number includes the country code in E.164 format.

Example:
file_name
string

Name of the CSV batch file uploaded

Example:

"customers.csv"

valid_contacts
integer<int32>

Count of all valid contacts found in the CSV file

Example:

7

total_contacts
integer<int32>

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: