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

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
ref
string
required

The ref returned by voice.browser-session.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
to
string
required

Number to dial, E.164, e.g. +14155550100.

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

Your own id for this call (a ticket). Carried on every event of the call.

Required string length: 1 - 128
maxDurationSeconds
integer
default:1800

The call ends at this many seconds, 60 to 3600. Default 1800. Sets the credit held.

Required range: 60 <= x <= 3600

Response

The result

callRef
string
required

The call's reference. Pass it as ref to accept, reject, voice.call.end or get.

state
enum<string>
required

The call's state in this session.

Available options:
dialing,
ringing,
connected,
rejected,
failed,
ended
direction
enum<string>
required

Who called whom.

Available options:
inbound,
outbound
from
string
required

Calling number, E.164.

to
string
required

Called number, E.164.

connectedSeconds
integer
required

Seconds connected so far.

Required range: 0 <= x <= 9007199254740991
muted
boolean
required

The agent's audio is held back by Pramaan.

reason
enum<string>

Why the call ended.

Available options:
completed,
no_answer,
busy,
failed,
rejected,
answered_elsewhere,
agent_disconnected,
time_limit,
session_closed
correlationId
string

Your id for this call.