Skip to main content
POST
voice.browser-session.create

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

Your own id for the agent who uses this browser session.

Required string length: 1 - 128
from
string
required

One of your voice-capable numbers (phone.numbers.list). Calls go out from it and ring in on it.

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

The exact origin of the page that connects, like https://desk.example.com. http://localhost is allowed for development.

Maximum string length: 253
lifetimeSeconds
integer
default:900

How long the credential lasts, 60 to 3600 seconds. Default 900.

Required range: 60 <= x <= 3600

Response

The result

connectUrl
string
required

The wss link the page connects to. On Pramaan's host.

credential
string
required

Short-lived browser credential. Give it to the page only; send it as the first message, never in a URL.

expiresAt
string
required

When the session and this credential expire, ISO 8601.

number
string
required

The session's number, E.164.

ref
string

Reference to what this call created. Pass it as ref to voice.browser-session.refresh, .close, .events and voice.browser-call.start.