Skip to main content
GET
Get Batch Call Details
Read only
Recommended. This endpoint is part of the public /v1 API reference and is the supported path for new integrations. See the migration guide for versioning guidance.
Returns the call logs and progress envelope for a single batch call. The response includes the batch’s callLogs page plus pagination fields such as total, page, limit, and totalPages. Use this endpoint to inspect the calls generated by a batch, render a batch detail page, or verify progress after pausing, resuming, or cancelling a campaign.

When to use this

  • Operational dashboards: render the batch detail page with live progress.
  • Status polling: review the returned call log page and totals while a campaign is waiting or running.
  • Audit logs: inspect the calls created for the batch and their current outcomes.
  • Re-run preparation: compare previous call outcomes before creating a new batch with Create Batch Call.
To list every batch, use List Batch Calls. To search across call logs more broadly, use List Call Logs with the batch ID filter.

Path parameters

Common query parameters

The returned callLogs page supports the same operational filters used by call log browsing.

Errors

  • 404 Not Found is returned when the batch does not exist.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Batch call ID

Example:

"batch_abc123"

Query Parameters

agent_id
string

Filter by agent ID(s) - can be a single ID or comma-separated list (e.g., 1,2,3)

call_id
string

Filter by call ID - can be a single ID or comma-separated list (e.g., call_abc,call_def)

batch_call_id
string

Filter by batch call ID - can be a single ID or comma-separated list (e.g., batch_abc,batch_def)

from
string

Filter by sender phone number

to
string

Filter by recipient phone number

type
enum<string>

Filter by call type(s) - can be a single value or comma-separated list

Available options:
phone,
web
call_direction
enum<string>

Filter by call direction(s) - can be a single value or comma-separated list

Available options:
inbound,
outbound
latency_min
number

Filter by minimum latency (in milliseconds)

latency_max
number

Filter by maximum latency (in milliseconds)

agent_version_id
string

Filter by agent version ID(s) - can be a single ID or comma-separated list (e.g., 1,2,3)

agent_version_name
string

Search by agent version name (partial match, case-insensitive)

sentiment
enum<string>

Filter by sentiment(s) - can be a single value or comma-separated list

Available options:
positive,
neutral,
negative,
unknown
start_date
string

Filter by start date (ISO format)

end_date
string

Filter by end date (ISO format)

duration_greater_than
number

Filter by minimum call duration (in milliseconds)

duration_less_than
number

Filter by maximum call duration (in milliseconds)

duration_min
number

Filter by minimum duration range (in milliseconds)

duration_max
number

Filter by maximum duration range (in milliseconds)

page
number

Page number (starts from 1)

Example:

1

limit
number

Number of records per page (min: 1, default: 20, max: 200)

Example:

20

created_at
enum<string>

Sort by created_at (asc or desc)

Available options:
asc,
desc
duration
enum<string>

Sort by duration (asc or desc)

Available options:
asc,
desc
status
string

Filter by call status(es) - can be a single status or comma-separated list

export
boolean

Set to true to export all data without pagination

end_reason
string

Filter by end/hangup reason - exact match; comma-separate multiple values for OR filtering

Response

Calls in the batch returned successfully.

callLogs
object[]
total
number
page
number
limit
number
totalPages
number