Skip to main content
GET
Get batch call

Authorizations

Authorization
string
header
default:<auth-token>
required

Your API token, sent raw (no Bearer prefix).

Path Parameters

batchId
string
required

Response

The batch.

batchId
string
Example:

"btcl_k3x9q2"

batchName
string

The name you sent.

Example:

"October renewals"

description
string
phoneNumberId
string

The number calls are made from.

phoneNumber
string

That number in E.164.

Example:

"+14155550100"

routingRuleId
string

The outbound routing rule in use.

Example:

"rr_2554md"

status
enum<string>

Without a schedule, a batch goes straight from parsing to running.

  • parsing: the file is being read. No calls yet.
  • parse_failed: the file couldn't be used, and parseError says why. Fix the file and create a new batch.
  • scheduled: parsed, waiting for its start time.
  • running: calls are being placed.
  • cancelling: a cancel is in progress.
  • cancelled: stopped before every number was called.
  • completed: every number has been called, retries included.
Available options:
parsing,
parse_failed,
scheduled,
running,
cancelling,
cancelled,
completed
timing
enum<string>

scheduled when you sent a schedule, otherwise immediate.

Available options:
immediate,
scheduled
timezone
string
Example:

"Asia/Kolkata"

scheduledDate
string

schedule.date.

Example:

"2026-10-14"

scheduledTime
string

schedule.time.

Example:

"10:00"

retry
object
recordsUploaded
integer

Phone numbers read from the file. 0 until parsing finishes.

parseError
string | null

Why parsing failed. Set when status is parse_failed.

file
object

The uploaded file.

timestamp
integer

Start time as a Unix timestamp in seconds. For an immediate batch

createdAt
string<date-time>
updatedAt
string<date-time>