Skip to main content
GET
/
batch-calls
/
{id}
Get a batch call
curl --request GET \
  --url https://api.dialnexa.com/v1/batch-calls/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "batch_abc123",
  "name": "May Follow-Up Campaign",
  "status": "completed",
  "total_leads": 250,
  "completed": 235,
  "failed": 15,
  "agent_id": "agt_abc123",
  "created_at": "2024-03-01T10:00:00.000Z"
}
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

ParameterDescription
idThe batch call ID, for example bat_q1r5sv9mdk3z.

​
Errors

  • 404 Not Found is returned when the batch does not exist.

​
Request

curl "https://api.dialnexa.com/v1/batch-calls/bat_q1r5sv9mdk3z" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

{
  "id": "bat_q1r5sv9mdk3z",
  "name": "May Follow-Up Run",
  "status": "processing",
  "agent_id": "agt_k7m2nq9xw4p8",
  "total_calls": 250,
  "completed_calls": 0,
  "created_at": "2024-05-01T11:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Pass your API key as a Bearer token in the Authorization header.

Path Parameters

​
id
string
required

Response

Success.

​
id
string
Example:

"batch_abc123"

​
name
string
Example:

"May Follow-Up Campaign"

​
status
enum<string>

Batch campaign lifecycle status.

Available options:
draft,
active,
running,
paused,
completed,
cancelled
Example:

"completed"

​
total_leads
integer
Example:

250

​
completed
integer
Example:

235

​
failed
integer
Example:

15

​
agent_id
string
Example:

"agt_abc123"

​
created_at
string<date-time>
Example:

"2024-03-01T10:00:00.000Z"