List Batch Calls

GET

batch-calls

List Batch Calls

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

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

fetch('https://api.dialnexa.com/v1/batch-calls', 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",
  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"

	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")

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": "batch_abc123",
    "status": "waiting",
    "title": "Q3 Follow-up Batch"
  }
]

Read only Returns every batch call job in your workspace, paginated and sorted by creation date with the newest first. The current list handler returns each batch’s ID, title, status, and creation time to API-key callers. Use List Calls for call-level progress; do not expect recipient totals, From numbers, or scheduling-conflict warnings in this list. Use List Batch Calls to power a batch history dashboard, build automation that watches for new batches, or audit which jobs have run in a given period.

When to use this

Operational dashboards: render a batch history view with each batch’s status.
Compliance audits: list every batch run in a quarter for review.
Reporting pipelines: sync batch metadata into a data warehouse alongside call logs.
Automation triggers: detect newly created batches and start downstream reporting jobs.

Query parameters

Parameter	Description
`page`	Page number, starting from 1.
`limit`	Results per page. Minimum `1`. Default: `30`.
`sortBy`	Field to sort by. One of `created_at`, `updated_at`, `createdAt`, `updatedAt`, `title`, `status`, `id`. Default: `created_at`.
`sortOrder`	Sort direction, `ASC` or `DESC` (case-insensitive). Default: `DESC`.
`status`	Filter by one batch status or comma-separated statuses. Supported values include `draft`, `waiting`, `scheduled`, `running`, `paused`, `completed`, `cancelled`, `deleted`, and compatibility `active`.

List Batch Calls response

The API-key response is a root JSON array. Pagination metadata and dashboard counters such as attempt_stages, picked_up_calls, and last_call_sent_at are not included. Request successive pages until a page contains fewer records than your requested limit.

Verify the result

Locate the expected batch ID and check its status. For call-level evidence, use List Calls with batch_call_id.

Errors

400 Bad Request is returned for a status value outside the batch statuses (the message lists the allowed ones), a sortBy or sortOrder value outside its list, or a page or limit below 1.

Get Batch Call: fetch a single batch’s detail.
Create Batch Call: start a new batch.
API pagination: how DialNexa list endpoints paginate.
Batch calling: guidance on designing a batch.

Authorizations

Authorization

string

header

required

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

Query Parameters

page

integer

default:1

Page number, starting from 1.

Required range: x >= 1

limit

integer

default:30

Results per page.

Required range: x >= 1

sortBy

enum<string>

default:created_at

Field to sort by.

Available options:

created_at,

updated_at,

createdAt,

updatedAt,

title,

status,

id

sortOrder

enum<string>

default:DESC

Sort direction.

Available options:

ASC,

DESC

status

string

Filter by batch status. One value or a comma-separated list of: draft, active, running, paused, completed, cancelled, deleted, scheduled, waiting.

Example:

"running,paused"

Response

Batch calls returned successfully.

string

Example:

"batch_abc123"

status

string

Current batch status, for example waiting, scheduled, running, paused, completed or cancelled.

title

string

created_at

string<date-time>

When the batch was created.

List Batch Calls

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

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

fetch('https://api.dialnexa.com/v1/batch-calls', 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",
  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"

	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")

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": "batch_abc123",
    "status": "waiting",
    "title": "Q3 Follow-up Batch"
  }
]

Overview

Endpoints

When to use this

Query parameters

List Batch Calls response

Verify the result

Errors

Authorizations

Query Parameters

Response

​When to use this

​Query parameters

​List Batch Calls response

​Verify the result

​Errors

​Related endpoints

Authorizations

Query Parameters

Response

When to use this

Query parameters

List Batch Calls response

Verify the result

Errors

Related endpoints