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

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

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

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

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

Pattern: ^\+[1-9]\d{6,14}$
destination
object
required

Sources decline destination kinds they cannot serve.

greeting
string

Greeting spoken on answer.

Maximum string length: 1000
recording
boolean
default:false

Record this call; extra usage charges apply.

transcription
boolean
default:false

Transcribe this call; extra usage charges apply.

transcriptionLanguage
enum<string>
default:auto

Speech transcription language.

Available options:
auto,
en,
es
answeringMachineDetection
boolean
default:false

Detect voicemail before bridging.

voicemailMessage
string

Message for detected voicemail; implies detection.

Maximum string length: 1000
ringTimeoutSeconds
integer
default:30

Ring timeout, 5 to 120 seconds.

Required range: 5 <= x <= 120
maxDurationSeconds
integer
default:300

Connected duration cap, 60 to 600 seconds. Polled at most every 30 seconds; the platform absorbs overshoot.

Required range: 60 <= x <= 600
maxCostUsd
number
default:1

Maximum charge in USD; default 1, explicit upper limit 100.

Required range: 0.01 <= x <= 100

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.