REretellai

POST /create-batch-call

Changed on

Create a batch call

Request

  • Base URL
    https://api.retellai.com
  • Auth
    HTTP bearer

Request body

namestring

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

trigger_timestampnumber

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

from_numberstring required

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

reserved_concurrencyinteger

Number of concurrency reserved for all other calls that are not triggered by batch calls, such as inbound calls.

Response

Successfully created a batch call.

batch_call_idstring required

Unique id of the batch call.

namestring required
from_numberstring required
scheduled_timestampnumber required
total_task_countnumber required

Number of tasks within the batch call

Example response

{
  "batch_call_id": "batch_call_dbcc4412483ebfc348abb",
  "name": "First batch call",
  "from_number": "+14157774444",
  "scheduled_timestamp": 1735718400,
  "call_time_window": {
    "windows": [
      {
        "start": 540,
        "end": 1020
      }
    ]
  }
}

Changes

  • de3a1d542da5Revision changes
    • warning

      removed the request property /////////

    • warning

      removed the request property /////////

  • 5d018ad1bc4dRevision changes
    • info

      added to the //// request property anyOf list

    • info

      added to the //// request property anyOf list