Get Batch Call

GET

batch-calls

{id}

List calls within a batch by ID

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

import requests

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

headers = {
    "x-organization-id": "<x-organization-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.dialnexa.com/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/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>",
    "x-organization-id: <x-organization-id>"
  ],
]);

$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/batch-calls/{id}"

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

	req.Header.Add("x-organization-id", "<x-organization-id>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.dialnexa.com/batch-calls/{id}")
  .header("x-organization-id", "<x-organization-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

Legacy endpoint - deprecated. Unversioned endpoints are scheduled for removal on July 31, 2026. Use the /v1 version for new integrations. This endpoint remains available for existing integrations until then.

Returns the full record for a single batch call job: the display name, the current status (queued, processing, completed, failed, cancelled), the assigned agent_id, progress counters (total_calls, completed_calls, failed_calls), and creation timestamps. Use this endpoint to poll a batch’s progress while it is running, render a batch detail page, or audit the configuration of a completed batch before kicking off a re-run.

When to use this

Operational dashboards: render the batch detail page with live progress.
Status polling: periodically check completed_calls to estimate when a batch will finish.
Audit logs: confirm which agent and configuration a batch ran with.
Re-run preparation: fetch a previous batch’s configuration before creating a new batch with Create Batch Call.

To list every batch, use List Batch Calls. For the call logs produced by a batch, fetch them through List Call Logs filtered by the batch ID.

Path parameters

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

Errors

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.

Headers

x-organization-id

string

required

RSA encrypted organization ID (base64 format)

Example:

"BASE64_ENCRYPTED_ORG_ID_HERE"

Path Parameters

string

required

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

string

Page number (starts from 1)

limit

string

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

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

Response

200

Calls in the batch fetched successfully

Create CampaignCreate a managed batch calling campaign with lifecycle controls.

List calls within a batch by ID

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

import requests

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

headers = {
    "x-organization-id": "<x-organization-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.dialnexa.com/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/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>",
    "x-organization-id: <x-organization-id>"
  ],
]);

$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/batch-calls/{id}"

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

	req.Header.Add("x-organization-id", "<x-organization-id>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.dialnexa.com/batch-calls/{id}")
  .header("x-organization-id", "<x-organization-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

Overview

Endpoints - v1

Endpoints - Legacy

Code Examples And SDK Status

When to use this

Path parameters

Errors

Authorizations

Headers

Path Parameters

Query Parameters

Response

​When to use this

​Path parameters

​Errors

​Related endpoints

Authorizations

Headers

Path Parameters

Query Parameters

Response

When to use this

Path parameters

Errors

Related endpoints