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

{}

{
  "statusCode": 400,
  "message": "Invalid batch call ID format",
  "error": "Bad Request"
}

{
  "statusCode": 401,
  "message": "API key is missing or invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 403,
  "message": "Destination country or network prefix is not enabled for this workspace",
  "error": "Forbidden"
}

{
  "statusCode": 404,
  "message": "Batch call not found",
  "error": "Not Found"
}

{
  "statusCode": 500,
  "message": "Internal server error",
  "error": "Internal Server Error"
}

Read only Get Batch Call Details selects calls belonging to a batch in your workspace. The current API-key response for a normal paginated request is an empty object because batch detail fields are filtered out. Use List Calls with batch_call_id for paginated call records, or set export=true on this endpoint for a root array of matching call records.

When to use this

Operational dashboards: render the batch detail page with live progress.
Status polling: use List Calls with the batch ID 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 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 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`.
`export`	Set to `true` to bypass pagination up to the applicable row limit.
`columns`	Export only. Comma-separated column keys. Excluding both `transcript` and `summary` raises the single-export limit from `5,000` to `10,000` rows.

Errors

400 Bad Request is returned when query parameters are invalid or an export exceeds the applicable row limit.
404 Not Found is returned when the batch does not exist.

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(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

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

columns

string

Export only: comma-separated column keys. Omitting both transcript and summary raises the single-export limit from 5000 to 10000 rows. Omit this parameter to include all columns.

Example:

"duration,status,agent_name"

is_ivr

boolean

Filter by whether the call was handled by an IVR agent. Both promoted or transferred calls and pure menu calls count. Set true for IVR calls only, false for non-IVR calls only, or omit for all.

Response

Calls in the batch returned successfully.

The response is of type object.

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

{}

{
  "statusCode": 400,
  "message": "Invalid batch call ID format",
  "error": "Bad Request"
}

{
  "statusCode": 401,
  "message": "API key is missing or invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 403,
  "message": "Destination country or network prefix is not enabled for this workspace",
  "error": "Forbidden"
}

{
  "statusCode": 404,
  "message": "Batch call not found",
  "error": "Not Found"
}

{
  "statusCode": 500,
  "message": "Internal server error",
  "error": "Internal Server Error"
}

Overview

Endpoints

When to use this

Path parameters

Common query parameters

Errors

Authorizations

Path Parameters

Query Parameters

Response

​When to use this

​Path parameters

​Common query parameters

​Errors

​Related endpoints

Authorizations

Path Parameters

Query Parameters

Response

When to use this

Path parameters

Common query parameters

Errors

Related endpoints