v1
latestOpenAPI 3.0.12026-07-2696152184.1 KBCreate Call Batch
Queues a batch of outbound calls. Calls are issued gradually, subject to the organization's and the batch's concurrency limits.
Headers
API version header.
Request body
A label for the batch.
The identifier of the agent that handles the batch's calls.
The identifier of the phone number to place calls from. The attached provider handles outbound calling for this number.
Maximum number of calls from this batch to dial concurrently. Must not exceed the organization's concurrency limit. Omit to default to half of the organization's agent-call concurrency limit, leaving headroom for other calls.
Seconds to wait for the callee to answer before giving up. Omit to use the default (60 seconds).
Maximum call duration in minutes. Omit to use the default (480 minutes).
When to start dispatching the batch, as an RFC3339 timestamp with a timezone offset (e.g. 2026-06-15T16:00:00Z). Must be in the future and within 30 days. Omit to dispatch immediately.
The region from which the batch's outbound calls are dispatched. Valid only when from_number_id is a SIP-trunk number; rejected for other telephony account types. Omit to derive the region from the telephony account.
Response
The created batch, with all of its call requests queued.
The unique identifier for the batch.
The batch's label.
The identifier of the agent that handles the batch's calls.
The identifier of the phone number the batch dials from.
The deployment region whose dispatcher drains the batch.
Maximum number of calls from this batch dialed concurrently.
The lifecycle status of a batch, derived at read time from dispatch progress.
Total recipients queued in the batch.
Recipients handed to the dialer so far, including those that failed before a call could be placed.
Recipients whose latest call attempt reached a terminal state (completed or failed), including pre-dial failures.
Number of times the batch has been retried. 0 until the first retry.
When the batch was created.
When the batch was last updated.
The scheduled dispatch time, in RFC3339 UTC format. Omitted for batches that dispatch immediately.
The actual dispatch time, in RFC3339 UTC format. The batch may stay unadmitted in the queue due to scheduling or unavailable concurrency.