> ## Documentation Index
> Fetch the complete documentation index at: https://dialnexa.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Batch Call Details
> Fetch calls and progress details for one batch call.
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](/docs/api-reference/v1/migrating-to-v1) 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](/docs/api-reference/v1/batches/create).
To list every batch, use [List Batch Calls](/docs/api-reference/v1/batches/list). To search across call logs more broadly, use [List Call Logs](/docs/api-reference/call-logs/list) with the batch ID filter.
## Path parameters
| Parameter | Description |
| --------- | ---------------------------------------------------- |
| `id` | The batch call ID, for example `batch_q1r5sv9mdk3z`. |
## Common query parameters
The returned `callLogs` page supports the same operational filters used by call log browsing.
| Parameter | Description |
| ------------------------------- | -------------------------------------------------------------------------- |
| `page` / `limit` | Paginate calls in the batch. |
| `agent_id` | Filter by one agent ID or comma-separated agent IDs. |
| `call_id` | Filter to one call ID or comma-separated call IDs inside the batch. |
| `from` / `to` | Filter by sender or recipient phone number. |
| `type` | Filter by `phone` or `web`. |
| `call_direction` | Filter by `inbound` or `outbound`. |
| `status` | Filter by one call status or comma-separated statuses. |
| `sentiment` | Filter by one or more sentiment values. |
| `end_reason` | Filter by one exact hang up reason or comma-separated `end_reason` values. |
| `duration_min` / `duration_max` | Filter by duration range in milliseconds. |
| `created_at` / `duration` | Sort by created time or duration with `asc` or `desc`. |
## Errors
* `404 Not Found` is returned when the batch does not exist.
## Related endpoints
* [List Batch Calls](/docs/api-reference/v1/batches/list): browse all batches.
* [Create Batch Call](/docs/api-reference/v1/batches/create): start a new batch.
* [Batch calling](/docs/batch-calls/overview): guidance on designing a batch.
* [Concurrency and limits](/docs/reference/limits): pacing batches against your workspace limits.
## OpenAPI
````yaml GET /v1/batch-calls/{id}
openapi: 3.0.0
info:
title: DialNexa API
description: >-
Public REST API for the DialNexa voice AI platform. Versioned endpoints are
under /v1; unversioned endpoints are legacy and deprecated.
version: 1.0.0
servers:
- url: https://api.dialnexa.com
description: DialNexa production API
security:
- bearer: []
tags:
- name: API Keys
- name: Agent Functions
- name: Agents V1
- name: Agents2
- name: Batch Calls
- name: Batch Calls V1
- name: Call Logs
- name: Calls
- name: Calls V1
- name: Campaign Leads
- name: Campaigns
- name: External Webhooks
- name: Knowledge Base
- name: Knowledge Base V1
- name: LLMs
- name: LLMs V1
- name: Languages
- name: Languages V1
- name: Organization Phone Numbers
- name: Organization Phone Numbers V1
- name: Phone Number Pricing
- name: Phone Number Pricing V1
- name: Transcribers
- name: Transcribers V1
- name: User Webhooks
- name: User Webhooks V1
- name: V1
- name: Voices
- name: Voices V1
- name: Webcall
- name: Workflow Leads
- name: Workflow Leads V1
- name: Workflows
- name: Workflows V1
paths:
/v1/batch-calls/{id}:
get:
tags:
- Batch Calls
- Batch Calls V1
- V1
summary: Get Batch Call Details
description: Returns one batch call job and its current processing details.
operationId: BatchCallsV1Controller_listCallsInBatch
parameters:
- name: id
required: true
in: path
description: Batch call ID
schema:
type: string
example: batch_abc123
- name: agent_id
required: false
in: query
description: >-
Filter by agent ID(s) - can be a single ID or comma-separated list
(e.g., 1,2,3)
schema:
type: string
- name: call_id
required: false
in: query
description: >-
Filter by call ID - can be a single ID or comma-separated list
(e.g., call_abc,call_def)
schema:
type: string
- name: batch_call_id
required: false
in: query
description: >-
Filter by batch call ID - can be a single ID or comma-separated list
(e.g., batch_abc,batch_def)
schema:
type: string
- name: from
required: false
in: query
description: Filter by sender phone number
schema:
type: string
- name: to
required: false
in: query
description: Filter by recipient phone number
schema:
type: string
- name: type
required: false
in: query
description: >-
Filter by call type(s) - can be a single value or comma-separated
list
schema:
type: string
enum:
- phone
- web
- name: call_direction
required: false
in: query
description: >-
Filter by call direction(s) - can be a single value or
comma-separated list
schema:
type: string
enum:
- inbound
- outbound
- name: latency_min
required: false
in: query
description: Filter by minimum latency (in milliseconds)
schema:
type: number
- name: latency_max
required: false
in: query
description: Filter by maximum latency (in milliseconds)
schema:
type: number
- name: agent_version_id
required: false
in: query
description: >-
Filter by agent version ID(s) - can be a single ID or
comma-separated list (e.g., 1,2,3)
schema:
type: string
- name: agent_version_name
required: false
in: query
description: Search by agent version name (partial match, case-insensitive)
schema:
type: string
- name: sentiment
required: false
in: query
description: >-
Filter by sentiment(s) - can be a single value or comma-separated
list
schema:
type: string
enum:
- positive
- neutral
- negative
- unknown
- name: start_date
required: false
in: query
description: Filter by start date (ISO format)
schema:
type: string
- name: end_date
required: false
in: query
description: Filter by end date (ISO format)
schema:
type: string
- name: duration_greater_than
required: false
in: query
description: Filter by minimum call duration (in milliseconds)
schema:
type: number
- name: duration_less_than
required: false
in: query
description: Filter by maximum call duration (in milliseconds)
schema:
type: number
- name: duration_min
required: false
in: query
description: Filter by minimum duration range (in milliseconds)
schema:
type: number
- name: duration_max
required: false
in: query
description: Filter by maximum duration range (in milliseconds)
schema:
type: number
- name: page
required: false
in: query
description: Page number (starts from 1)
schema:
type: number
example: 1
- name: limit
required: false
in: query
description: 'Number of records per page (min: 1, default: 20, max: 200)'
schema:
example: 20
type: number
- name: created_at
required: false
in: query
description: Sort by created_at (asc or desc)
schema:
type: string
enum:
- asc
- desc
- name: duration
required: false
in: query
description: Sort by duration (asc or desc)
schema:
type: string
enum:
- asc
- desc
- name: status
required: false
in: query
description: >-
Filter by call status(es) - can be a single status or
comma-separated list
schema:
type: string
- name: export
required: false
in: query
description: Set to true to export all data without pagination
schema:
type: boolean
- name: end_reason
required: false
in: query
description: >-
Filter by end/hangup reason - exact match; comma-separate multiple
values for OR filtering
schema:
type: string
responses:
'200':
description: Calls in the batch returned successfully.
content:
application/json:
examples:
success:
summary: Successful response
value:
callLogs:
- id: call_abc123
agent_id: agent_2g7Xy3tY53gRlp
to_number: '+919876543210'
from_number: '+14155552671'
status: initiated
call_direction: outbound
createdAt: '2026-07-03T10:30:00.000Z'
batch_id: batch_abc123
total: 1
page: 1
limit: 20
totalPages: 1
schema:
type: object
properties:
callLogs:
type: array
items:
type: object
properties:
id:
type: string
example: call_abc123
status:
type: string
example: completed
from_number:
type: string
example: '+14155552671'
to_number:
type: string
example: '+919876543210'
duration:
type: number
example: 42
createdAt:
type: string
format: date-time
total:
type: number
page:
type: number
limit:
type: number
totalPages:
type: number
'400':
description: Invalid batch call ID format.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 400 Bad Request
value:
statusCode: 400
message: Invalid batch call ID format
error: Bad Request
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 401 Unauthorized
value:
statusCode: 401
message: API key is missing or invalid
error: Unauthorized
'403':
description: Forbidden.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 403 Forbidden
value:
statusCode: 403
message: >-
Destination country or network prefix is not enabled for
this workspace
error: Forbidden
'404':
description: Batch call not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 404 Not Found
value:
statusCode: 404
message: Batch call not found
error: Not Found
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 500 Internal Server Error
value:
statusCode: 500
message: Internal server error
error: Internal Server Error
security:
- bearer: []
components:
schemas:
ErrorResponse:
type: object
properties:
statusCode:
type: integer
example: 400
message:
oneOf:
- type: string
- type: array
items:
type: string
example: phone_number must be a valid E.164 phone number
error:
type: string
example: Bad Request
required:
- statusCode
- message
- error
securitySchemes:
bearer:
scheme: bearer
bearerFormat: JWT
type: http
````