Submit and manage batch phone calls for automated outreach campaigns.
import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";
const client = new ElevenLabsClient({ apiKey: "your-api-key" });
// Access this API via: client.conversationalAi.batchCalls/**
* Submit batch call request
*/
client.conversationalAi.batchCalls.create(
request: BodySubmitABatchCallRequestV1ConvaiBatchCallingSubmitPost,
requestOptions?: RequestOptions
): HttpResponsePromise<SubmitBatchCallResponseModel>;
/**
* List batch calls
*/
client.conversationalAi.batchCalls.list(
request?: BatchCallsListRequest,
requestOptions?: RequestOptions
): HttpResponsePromise<WorkspaceBatchCallsResponse>;
/**
* Get batch call details
*/
client.conversationalAi.batchCalls.get(
batch_id: string,
requestOptions?: RequestOptions
): HttpResponsePromise<BatchCallDetailedResponse>;
/**
* Cancel a running batch call
* @param batch_id - The batch call ID to cancel
* @param requestOptions - Optional request configuration
* @returns Updated batch call response
* @throws UnprocessableEntityError if request fails
*/
client.conversationalAi.batchCalls.cancel(
batch_id: string,
requestOptions?: RequestOptions
): HttpResponsePromise<BatchCallResponse>;
/**
* Retry failed and no-response recipients in a batch call
* @param batch_id - The batch call ID to retry
* @param requestOptions - Optional request configuration
* @returns Updated batch call response
* @throws UnprocessableEntityError if request fails
*/
client.conversationalAi.batchCalls.retry(
batch_id: string,
requestOptions?: RequestOptions
): HttpResponsePromise<BatchCallResponse>;
interface BatchCallResponse {
/** Batch call ID */
batch_id: string;
/** Status of the batch call */
status: string;
/** Call statistics */
stats?: {
total: number;
completed: number;
failed: number;
pending: number;
};
}