Skip to main content
POST
voice.call.start-agent

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
to
string
required

Telephone number in E.164 format, such as +14155550100.

Pattern: ^\+[1-9]\d{7,14}$
from
string
required

One of your outbound-enabled numbers from voice.number.create.

Pattern: ^\+[1-9]\d{7,14}$
assistant
string

Your unique name for this configuration, up to 40 letters, digits, underscores or hyphens.

Required string length: 1 - 40
Pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$
squad
string

Your unique name for this configuration, up to 40 letters, digits, underscores or hyphens.

Required string length: 1 - 40
Pattern: ^[a-zA-Z][a-zA-Z0-9_-]*$
variables
object

Flat map of up to 30 scalar variables; 10,000 characters in total.

maxDurationSeconds
integer
default:120

Maximum call length, 10 to 600 seconds.

Required range: 10 <= x <= 600
tier
enum<string>
default:standard

Service tier. Premium must be selected explicitly.

Available options:
standard,
premium
recording
boolean
default:false

Copy the recording to your file storage when true.

scheduleAt
string<date-time>

Start time in the next 24 hours.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.