Schedule a new call

Queues an outbound call. Creates the record in QUEUED status (or NOT_STARTED if scheduled for a future time). Runs validation: phone format and country checks (rejects VOIP/premium/shared-cost numbers for US/CA), destination-country restriction (your phone numbers must match the destination country), rate limits, balance check against maxDurationMinutes, and a content safety review. If the goal is ambiguous, the response may be NEEDS_CLARIFICATION with a follow-up question instead of a scheduled call — set force: true to skip clarification.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Phone number to call

string
required

Goal of the call

string

ISO 8601 date-time for scheduling the call

string
Defaults to America/Los_Angeles

Timezone for scheduling the call (e.g. America/Los_Angeles)

string

Additional context for the call

number
≥ 1
Defaults to 15

Maximum duration of the call in minutes

boolean
Defaults to false

Do we need to retry the call

string

Voice to use for the call

number
1 to 30
Defaults to 5

Number of minutes to wait before retrying if call fails

boolean
Defaults to false

Force call creation without clarification

boolean
Defaults to false

Allow to ask for clarification (if user is online)

boolean
Defaults to false

Include private data in the call prompt

string

Agent ID to use for the call

boolean
Defaults to false

Allow to transfer the call to another number

string

Number to transfer the call to

string

Title of the call (for campaign)

string

First message to use for the call (for campaign)

string

Cron expression for recurring calls (e.g., "0 9 * * MON" for every Monday at 9 AM)

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json