List batch call recipients

Lists every recipient in the batch with its outcome, in the order they were added. Unlike listing calls filtered by batch_call_id, this includes recipients that are still queued and recipients that failed before a call was placed, with the reason in error_message.

Authentication

AuthorizationBearer

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

Path parameters

batch_call_idstringRequired

Query parameters

limitintegerOptional1-100Defaults to 20

Number of recipients per page, between 1 and 100.

offsetintegerOptional>=0Defaults to 0

Number of recipients to skip.

statusenumOptional

Only return recipients with this status.

Allowed values:

Response

200

statusstringOptional

responseobjectOptional

Errors

401

Unauthorized Error

404

Not Found Error

1	{
2	"status": "ok",
3	"response": {
4	"pagination": {
5	"total_records": 250,
6	"limit": 20,
7	"offset": 0
8	},
9	"tasks": [
10	{
11	"task_id": "7c3d1f7e-8f7b-4f6e-9a3e-5d2c8b1a4e70",
12	"to_phone_number": "+12025551234",
13	"lead_name": "John Doe",
14	"lead_email": "john.doe@example.com",
15	"status": "dispatched",
16	"error_message": "string",
17	"call_id": "1d9a1c8e-2b7f-4a6d-8c3e-9f5b2d7a1c40",
18	"created_at": {},
19	"updated_at": {}
20	}
21	]
22	}
23	}

$	curl https://api.synthflow.ai/v2/calls/batch/batch_call_id/tasks \
>	-H "Authorization: Bearer <token>"