POST
/
create-batch-call
import Retell from 'retell-sdk';

const client = new Retell({
  apiKey: 'YOUR_RETELL_API_KEY',
});

async function main() {
  const batchCallResponse = await client.batchCall.createBatchCall({
    from_number: '+14157774444',
    tasks: [{ to_number: '+12137774445' }],
  });

  console.log(batchCallResponse.batch_call_id);
}

main();
{
  "batch_call_id": "batch_call_dbcc4412483ebfc348abb",
  "name": "First batch call",
  "from_number": "+14157774444",
  "scheduled_timestamp": 1735718400,
  "total_task_count": 123
}

Authorizations

​
Authorization
string
header
required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Body

application/json
​
from_number
string
required

The number you own in E.164 format. Must be a number purchased from Retell or imported to Retell.

Example:

"+14157774444"

​
tasks
object[]
required

A list of individual call tasks to be executed as part of the batch call. Each task represents a single outbound call and includes details such as the recipient's phone number and optional dynamic variables to personalize the call content.

​
name
string

The name of the batch call. Only used for your own reference.

Example:

"First batch call"

​
trigger_timestamp
number

The scheduled time for sending the batch call, represented as a Unix timestamp in milliseconds. If omitted, the call will be sent immediately.

Example:

1735718400000

Response

201
application/json
Successfully created a batch call.
​
batch_call_id
string
required

Unique id of the batch call.

Example:

"batch_call_dbcc4412483ebfc348abb"

​
name
string
required
Example:

"First batch call"

​
from_number
string
required
Example:

"+14157774444"

​
scheduled_timestamp
number
required
Example:

1735718400

​
total_task_count
number
required

Number of tasks within the batch call

Was this page helpful?