List Batch Call Recipients

Beta

GET

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

GET

/v1/agents/batch-calls/:batch_call_id/recipients

$ curl https://api.speechify.ai/v1/agents/batch-calls/batch_01jqr8x9zg5k2m3n4p5q6r7s8t/recipients \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

1 {
2   "next_cursor": "rcpt_01k6eh45afqyypdnnz847wdwvh",
3   "has_more": true,
4   "recipients": [
5     {
6       "id": "rcpt_01k6eh45afqyypdnnz847wdwvg",
7       "batch_id": "batch_01jqr8x9zg5k2m3n4p5q6r7s8t",
8       "phone": "+15555550123",
9       "status": "pending",
10       "dynamic_variables": {
11         "company": "Acme Inc",
12         "recipient_name": "Cliff Weitzman"
13       },
14       "conversation_id": "conv_01jqr8x9zg5k2m3n4p5q6r7s8t",
15       "custom_id": "acme_inc_2024_campaign_001",
16       "error": null,
17       "attempted_at": "2024-01-15T09:30:00Z",
18       "ended_at": null
19     }
20   ]
21 }

Returns one page of recipients for a batch call, ordered by id. Paginate by passing cursor from the previous response.

Authentication

AuthorizationBearer

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

Path parameters

batch_call_idstringRequired

Batch call ID.

Query parameters

cursorstringOptional

Opaque pagination cursor from a previous response.

limitintegerOptional1-200Defaults to 50

Max items per page (default 50, max 200).

Response headers

X-Request-IDstring

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an X-Request-ID request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify’s server-side logs, and it matches the request_id field in the error envelope.

Unique identifier for this request, present on every response (2xx and non-2xx alike). If the caller sends an `X-Request-ID` request header the server echoes it back (sanitized and length-capped) so one logical request can be traced end-to-end; otherwise the server generates a fresh value. Log it on every response and quote it in support requests - it is the stable handle that ties your observation to Speechify's server-side logs, and it matches the `request_id` field in the error envelope.

Response

next_cursorstring or null

Opaque keyset cursor for the next page. Pass back as the cursor request parameter. null when the caller has reached the end of the list (has_more is also false in that case).

has_moreboolean

True when more rows exist beyond this page.

recipientslist of objects

Errors

401

Unauthorized Error

404

Not Found Error