batchCalls

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.

get/calls/batch/{batch_call_id}/tasks

Path parameters

batch_call_idstring required

The batch returned by POST /calls/batch, a UUID.

Query parameters

limitinteger

Number of recipients per page, between 1 and 100.

offsetinteger

Number of recipients to skip.

status'pending' | 'claimed' | 'dispatched' | 'failed' | 'canceled'

Only return recipients with this status.

Headers

Authorizationstring required

Bearer authentication

Response

200

statusstring

Changes