Get Batch Call Details

GET

batch-calls

{id}

curl --request GET \
  --url https://api.dialnexa.com/v1/batch-calls/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialnexa.com/v1/batch-calls/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/batch-calls/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/v1/batch-calls/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/batch-calls/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "call_abc123",
    "agent_id": "agent_2g7Xy3tY53gRlp",
    "batch_id": "batch_abc123",
    "to_number": "919876543210",
    "phone_number_id": "phn_abc123",
    "duration": "42",
    "status": "completed",
    "end_reason": "user_disconnected",
    "llm_name": "gpt-4o"
  }
]

Read only Get Batch Call Details returns the calls created for one batch in your workspace, as a root JSON array of call records with the fields shown in the response panel. Page through them with page and limit (up to 200), or set export=true to receive every matching call in one response. An export above 5,000 rows is refused with 400; the limit is 10,000 when columns is sent and leaves out both transcript and summary. Paginated results leave out retry attempts; export=true includes them. An unknown batch ID, or one from another workspace, returns an empty array. List Calls with batch_call_id returns the same records.

When to use this

Operational dashboards: render the batch detail page with live progress.
Call progress: inspect the calls a waiting or running batch has produced so far. For the batch’s own status (waiting, running, paused, completed), poll List Batch Calls; an empty array here cannot tell a waiting batch from one with no matching calls.
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 investigate calls in the dashboard, use Call History and filter by the batch ID.

Path parameters

Parameter	Description
`id`	The batch call ID, for example `batch_q1r5sv9mdk3z`.

Common query parameters

The returned calls support 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. Ignored when `agent_version_id` is sent, and replaced by `agent_version_name` when that name matches a version.
`call_id`	Filter to one call ID or comma-separated call IDs inside the batch.
`from` / `to`	`from` is a partial match on the digits of the workspace number on the call. `to` is a partial match on the lead’s number as stored: it is not reduced to digits, and Indian lead numbers are stored as `91XXXXXXXXXX` without `+`, so send digits only. Retry attempts never match `to`.
`type`	Filter by `phone` or `web`, or both comma-separated. Any other value returns `400`.
`call_direction`	Filter by `inbound` or `outbound`, or both comma-separated. Any other value returns `400`.
`status`	Filter by one call status or comma-separated statuses: `initiated`, `received`, `sent`, `did_not_pick`, `busy`, `failed`, `no_answer`, `completed`, `created`, `cancelled`, `retry_expired`. Any other value returns `400`.
`sentiment`	Filter by one or more sentiment values: `positive`, `neutral`, `negative`, `unknown`. Values are lowercase; any other value returns `400`.
`end_reason`	Filter by one exact hang up reason or a comma-separated list: `agent_disconnected`, `user_disconnected`, `user_busy`, `user_did_not_pick_up`, `invalid_phone_number`, `unallocated_phone_number`, `unknown`, `network_failure`, `voicemail_detected`, `user_unreachable`, `destination_forbidden`, `system_failure`, `system_at_capacity`, `insufficient_balance`, `agent_not_found`, `sip_auth_failed`, `sip_trunk_unreachable`, `spend_cap_reached`, `dnc_blocked`. Unknown values are ignored; if none is known, no calls match.
`duration_min` / `duration_max`	Filter by an inclusive duration range in seconds. Send both: one sent alone is ignored.
`created_at` / `duration`	Sort by created time or duration with `asc` or `desc`.
`export`	Set to `true` to return every matching call in one JSON array without pagination, up to the applicable row limit, including retry attempts. Omit it or send `false` to receive pages. The row limit counts the original calls only; retry attempts are added on top, so the array can be longer.
`columns`	Export only. Comma-separated column keys. Excluding both `transcript` and `summary` raises the single-export limit from `5,000` to `10,000` rows.
`agent_version_id`	Filter by agent version, written as `<agent_id>-<version_number>` (for example `agent_2g7Xy3tY53gRlp-3`); one value or a comma-separated list. A value in any other format is ignored, and when no value is valid the filter is dropped. When it is sent, `agent_id` is not applied.
`agent_version_name`	Search by agent version name (partial match, case-insensitive).
`start_date`	Return calls created on or after the start of this day in UTC (ISO 8601). The value is converted to UTC first, then widened to 00:00:00 UTC of that day, so a time with an offset can move the day. Send a plain date (`YYYY-MM-DD`).
`end_date`	Return calls created on or before the end of this day in UTC (ISO 8601). The value is converted to UTC first, then widened to 23:59:59.999 UTC of that day, so a time with an offset can move the day. Send a plain date (`YYYY-MM-DD`).
`duration_greater_than`	Return calls longer than this many seconds. Minimum `0`.
`duration_less_than`	Return calls shorter than this many seconds. Minimum `0`.
`is_ivr`	Filter by whether the call was handled by an IVR agent (matched by the call’s agent and/or the IVR billing flag, so both promoted/transferred and pure menu calls count). true = IVR calls only; false = non-IVR calls only; omit for all.
`tags`	Filter by lead tags: the tags attached to the workflow lead when its leads file was uploaded, snapshotted onto the call when it was placed. Comma-separated for multiple values. Matching is case-insensitive because tags are normalized to lowercase on upload. Use tags_match to choose ANY (default) or ALL.
`tags_match`	How multiple `tags` values combine: “any” returns calls carrying at least one of them (default), “all” returns only calls carrying every one of them. One of `any`, `all`. Default: `any`.
`agent_type`	Filter by agent type. ivr is equivalent to is_ivr=true and includes IVR handoffs. Other types require an agent ID retained on the call; calls without one do not match those types. One of `single_prompt`, `conversational_flow`, `speech_to_speech`, `ivr`.

Filter Batch Calls By Agent Type

The endpoint accepts the same agent_type values as List Calls: single_prompt, conversational_flow, speech_to_speech, and ivr.

Errors

400 Bad Request is returned when query parameters are invalid, including a status, type, call_direction or sentiment value outside its list, or when an export exceeds the applicable row limit.

List Batch Calls: browse all batches.
Create Batch Call: start a new batch.
Batch calling: guidance on designing a batch.
Concurrency and limits: pacing batches against your workspace limits.

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Batch call ID

Example:

"batch_abc123"

Query Parameters

agent_id

string

Filter by agent ID: one ID or a comma-separated list (e.g., agent_abc,agent_def). Ignored when agent_version_id is sent, and replaced by agent_version_name when that name matches a version.

call_id

string

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

from

string

Filter by the workspace phone number on the call (the number dialled from, or for an inbound call the number that was called), as a partial match on its digits.

string

Filter by recipient phone number, as a partial match on the batch lead's number as stored. The value is not reduced to digits, and Indian lead numbers are stored as 91XXXXXXXXXX without +, so send digits only. Only batch calls carry a lead, so single calls and retry attempts never match this filter.

type

string

Filter by call type: one value or a comma-separated list of phone, web.

call_direction

string

Filter by call direction: one value or a comma-separated list of inbound, outbound.

agent_version_id

string

Filter batch calls by agent version, written as <agent_id>-<version_number> (for example agent_2g7Xy3tY53gRlp-3); one value or a comma-separated list. Only calls placed by a batch match. A value in any other format is ignored, and when no value is valid the whole filter is dropped. When this parameter is sent, agent_id is not applied.

Example:

"agent_2g7Xy3tY53gRlp-3"

agent_version_name

string

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

sentiment

string

Filter by user sentiment: one value or a comma-separated list of positive, neutral, negative, unknown.

start_date

string

Return calls created on or after the start of this day in UTC (ISO 8601). The value is converted to UTC first, then widened to 00:00:00 UTC of that day, so a time with an offset can move the day. Send a plain date (YYYY-MM-DD).

end_date

string

Return calls created on or before the end of this day in UTC (ISO 8601). The value is converted to UTC first, then widened to 23:59:59.999 UTC of that day, so a time with an offset can move the day. Send a plain date (YYYY-MM-DD).

duration_greater_than

number

Return calls longer than this many seconds.

Required range: x >= 0

duration_less_than

number

Return calls shorter than this many seconds.

Required range: x >= 0

duration_min

number

Lower bound of a duration range in seconds, inclusive. Applied only together with duration_max; sent alone it is ignored.

Required range: x >= 0

duration_max

number

Upper bound of a duration range in seconds, inclusive. Applied only together with duration_min; sent alone it is ignored.

Required range: x >= 0

page

integer

Page number (starts from 1)

Required range: x >= 1

Example:

1

limit

integer

default:20

Number of records per page. Minimum 1, maximum 200.

Required range: 1 <= x <= 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: one value or a comma-separated list, for example completed,failed. Values: initiated, received, sent, did_not_pick, busy, failed, no_answer, completed, created, cancelled, retry_expired. An unknown value returns 400.

export

boolean

Set to true to return every matching call in one JSON array without pagination, up to the export row limit, including retry attempts. Omit it or send false to receive pages. For a batch export, the row limit counts the original calls only; retry attempts are added on top, so the array can be longer.

end_reason

string

Filter by why the call ended: one value or a comma-separated list of agent_disconnected, user_disconnected, user_busy, user_did_not_pick_up, invalid_phone_number, unallocated_phone_number, unknown, network_failure, voicemail_detected, user_unreachable, destination_forbidden, system_failure, system_at_capacity, insufficient_balance, agent_not_found, sip_auth_failed, sip_trunk_unreachable, spend_cap_reached, dnc_blocked. Unknown values are ignored; if no value is known, no calls match.

is_ivr

boolean

Filter by whether the call was handled by an IVR agent (matched by the call's agent and/or the IVR billing flag, so both promoted/transferred and pure menu calls count). true = IVR calls only; false = non-IVR calls only; omit for all.

Response

Calls in the batch returned successfully.

string

Signed call ID.

Example:

"call_abc123"

agent_id

string | null

Agent that handled the call.

Example:

"agent_2g7Xy3tY53gRlp"

batch_id

string | null

Signed batch ID of the batch the call belongs to; null for single calls and for retry attempts.

Example:

"batch_abc123"

to_number

string | null

Destination number as recorded on the call: the number as sent for a single call, and the lead's number as stored for a batch call, where an Indian number appears as 91XXXXXXXXXX without +.

Example:

"919876543210"

phone_number_id

string | null

ID of the workspace phone number the call was placed from.

Example:

"phn_abc123"

called_time

string<date-time> | null

When the call was placed.

duration

string | null

Call duration in seconds, serialized as a string (the column is a 64-bit integer); null until a duration is recorded.

Example:

"42"

status

string

Current call status.

Example:

"completed"

initiated_time

string<date-time> | null

When the call was initiated on the telephony side.

end_reason

string | null

Why the call ended; unknown until the call ends. One of agent_disconnected, user_disconnected, user_busy, user_did_not_pick_up, invalid_phone_number, unallocated_phone_number, unknown, network_failure, voicemail_detected, user_unreachable, destination_forbidden, system_failure, system_at_capacity, insufficient_balance, agent_not_found, sip_auth_failed, sip_trunk_unreachable, spend_cap_reached, dnc_blocked.

Example:

"user_disconnected"

postcallanalysis

object | null

Post-call analysis fields extracted for this call, keyed by field name. An empty object until analysis has run.

llm_name

string | null

Display name of the language model used on the call.

Example:

"gpt-4o"

voice_model_name

string | null

Display name of the voice used on the call.

recording_sas_url

string | null

Time-limited link to the recording. Absent from the response unless export=true.

Get Batch Call Details

curl --request GET \
  --url https://api.dialnexa.com/v1/batch-calls/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialnexa.com/v1/batch-calls/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/batch-calls/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/v1/batch-calls/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/batch-calls/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "call_abc123",
    "agent_id": "agent_2g7Xy3tY53gRlp",
    "batch_id": "batch_abc123",
    "to_number": "919876543210",
    "phone_number_id": "phn_abc123",
    "duration": "42",
    "status": "completed",
    "end_reason": "user_disconnected",
    "llm_name": "gpt-4o"
  }
]

Overview

Endpoints

When to use this

Path parameters

Common query parameters

Filter Batch Calls By Agent Type

Errors

Authorizations

Path Parameters

Query Parameters

Response

​When to use this

​Path parameters

​Common query parameters

​Filter Batch Calls By Agent Type

​Errors

​Related endpoints

Authorizations

Path Parameters

Query Parameters

Response

When to use this

Path parameters

Common query parameters

Filter Batch Calls By Agent Type

Errors

Related endpoints