Get Batch Call

GET

https://api.speechify.ai/v1/agents/batch-calls/:id

GET

/v1/agents/batch-calls/:id

$ curl https://api.speechify.ai/v1/agents/batch-calls/id \
>      -H "Authorization: Bearer <token>"

1 {
2   "batch": {
3     "id": "batch_01kj8fy7kphhchfcfc230hgv12",
4     "agent_id": "string",
5     "name": "string",
6     "status": "pending",
7     "total": 1,
8     "completed": 1,
9     "failed": 1,
10     "created_at": "2024-01-15T09:30:00Z",
11     "updated_at": "2024-01-15T09:30:00Z",
12     "phone_number_id": "string",
13     "error": "string",
14     "started_at": "2024-01-15T09:30:00Z",
15     "finished_at": "2024-01-15T09:30:00Z",
16     "scheduled_at": "2024-01-15T09:30:00Z",
17     "ringing_timeout_ms": 1
18   },
19   "recipients": [
20     {
21       "id": "rcpt_01k6eh45afqyypdnnz847wdwvg",
22       "batch_id": "string",
23       "phone": "string",
24       "status": "pending",
25       "dynamic_vars": {},
26       "conversation_id": "string",
27       "error": "string",
28       "attempted_at": "2024-01-15T09:30:00Z",
29       "completed_at": "2024-01-15T09:30:00Z"
30     }
31   ]
32 }

Returns the batch row plus all recipients so the detail view renders without a second round-trip.

Authentication

AuthorizationBearer

Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.

Path parameters

idstringRequired

Batch call ID.

Response

batchobject

A batch of outbound calls dispatched to a list of recipients.

recipientslist of objects

Errors

404

Not Found Error