Calls

Batches

Create, manage, and control groups of calls
View as Markdown

Batches let you manage multiple calls as a single calling job.

Create a batch

POST /v1/call/create-batch

Creates a new batch of calls.

$curl -X POST https://api.hollr.ai/v1/call/create-batch \
>  -H "hollr-api-key: $HOLLR_API_KEY" \
>  -H "Content-Type: application/json" \
>  -d '{
>    "...": "..."
>  }'

The exact request fields are not documented here because the supplied route definition does not expose the controller’s request schema.

List batches

GET /v1/call/batches
$curl https://api.hollr.ai/v1/call/batches \
>  -H "hollr-api-key: $HOLLR_API_KEY"

Get a batch

GET /v1/call/batches/{batch_id}
$curl https://api.hollr.ai/v1/call/batches/BATCH_ID \
>  -H "hollr-api-key: $HOLLR_API_KEY"

Get batch status

GET /v1/call/batches/{batch_id}/status
$curl https://api.hollr.ai/v1/call/batches/BATCH_ID/status \
>  -H "hollr-api-key: $HOLLR_API_KEY"

Pause a batch

POST /v1/call/batches/{batch_id}/pause
$curl -X POST https://api.hollr.ai/v1/call/batches/BATCH_ID/pause \
>  -H "hollr-api-key: $HOLLR_API_KEY"

Resume a batch

POST /v1/call/batches/{batch_id}/resume
$curl -X POST https://api.hollr.ai/v1/call/batches/BATCH_ID/resume \
>  -H "hollr-api-key: $HOLLR_API_KEY"

Reschedule a batch

POST /v1/call/batches/{batch_id}/reschedule
$curl -X POST https://api.hollr.ai/v1/call/batches/BATCH_ID/reschedule \
>  -H "hollr-api-key: $HOLLR_API_KEY" \
>  -H "Content-Type: application/json" \
>  -d '{
>    "...": "..."
>  }'

The exact request fields are not documented here because the supplied route definition does not expose the controller’s request schema.

Update a batch

PATCH /v1/call/batches/{batch_id}
$curl -X PATCH https://api.hollr.ai/v1/call/batches/BATCH_ID \
>  -H "hollr-api-key: $HOLLR_API_KEY" \
>  -H "Content-Type: application/json" \
>  -d '{
>    "...": "..."
>  }'

The exact request fields are not documented here because the supplied route definition does not expose the controller’s request schema.

Delete a batch

DELETE /v1/call/batches/{batch_id}
$curl -X DELETE https://api.hollr.ai/v1/call/batches/BATCH_ID \
>  -H "hollr-api-key: $HOLLR_API_KEY"

Authentication

All batch endpoints require the hollr-api-key header.

The supplied route definitions show request rate limiting on create-batch, pause, resume, and reschedule. See Errors and rate limits for the API’s documented limits.