Get batch call

Read one batch call with every task, its status and the call it created.

GEThttps://api.tried.com.au/get-batch-call/{id}

Returns one batch call with its tasks in the order you sent them. Use it to see which numbers were dialled, which failed and why, and which call each task created.

Request#

Field	Type	Required	Description
`id`	string	Yes	Path parameter. The `batch_call_id`.

Example request#

curl https://api.tried.com.au/get-batch-call/batch_call_5f2a9c1e7b3d4a6f8e0b1c2d \
  -H "Authorization: Bearer $TRIED_API_KEY"

const id = "batch_call_5f2a9c1e7b3d4a6f8e0b1c2d";
const res = await fetch(`https://api.tried.com.au/get-batch-call/${id}`, {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const batch = await res.json();

import os, requests

batch_id = "batch_call_5f2a9c1e7b3d4a6f8e0b1c2d"
res = requests.get(
    f"https://api.tried.com.au/get-batch-call/{batch_id}",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
batch = res.json()

Response#

200 OK

{
  "batch_call_id": "batch_call_5f2a9c1e7b3d4a6f8e0b1c2d",
  "name": "Appointment reminders",
  "from_number": "+61291234567",
  "scheduled_timestamp": 1760850000000,
  "status": "ongoing",
  "total_task_count": 3,
  "sent": 2,
  "picked_up": 1,
  "successful": 1,
  "reserved_concurrency": 2,
  "call_time_window": {
    "windows": [{ "start": 540, "end": 1020 }],
    "timezone": "Australia/Sydney"
  },
  "tasks": [
    {
      "to_number": "+61412345678",
      "retell_llm_dynamic_variables": { "first_name": "Sam" },
      "metadata": {},
      "status": "dispatched",
      "call_id": "call_7c1d2e3f4a5b6c7d8e9f0a1b",
      "error": null
    },
    {
      "to_number": "+61498765432",
      "retell_llm_dynamic_variables": { "first_name": "Priya" },
      "metadata": {},
      "status": "failed",
      "call_id": null,
      "error": "+61498765432 is on the do-not-call list"
    },
    {
      "to_number": "+61400111222",
      "retell_llm_dynamic_variables": { "first_name": "Alex" },
      "metadata": { "crm_id": "8812" },
      "override_agent_id": "agent_3e4f5a6b7c8d9e0f1a2b3c4d",
      "status": "pending",
      "call_id": null,
      "error": null
    }
  ]
}

The batch fields are described in Create batch call. Each item in tasks:

Field	Type	Description
`to_number`	string	Number to call.
`retell_llm_dynamic_variables`	object	Variables sent with the task.
`metadata`	object	Metadata sent with the task.
`override_agent_id`	string	Present only when the task names its own agent.
`status`	string	`pending` (not dialled yet), `dispatched` (a call was created), `failed` (see `error`) or `cancelled` (the batch was stopped).
`call_id`	string or null	Call created for the task. A task refused for lack of credit can also have a `call_id`: a `not_connected` call with `disconnection_reason` `no_valid_payment`.
`error`	string or null	Why the dial failed, for example a do-not-call match, a number outside the from number's allowed countries, or no credit.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `calls` scope.
`404`	`Batch call <id> not found`.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.

Retell compatibility#

Retell's API reference documents only Create batch call. This endpoint is a Tried addition.