Skip to main content
POST
Open a Web Calling session

Authorizations

Authorization
string
header
required

Your API key from the Wave dashboard. Sandbox keys start sk_sandbox_; production keys start sk_live_. Send as Authorization: Bearer <key>. Some endpoints require a production key and specific scopes.

Body

application/json
identity
string

The web-calling identity for an agent session. Omit it for a caller session.

Pattern: ^[A-Za-z0-9._-]{1,64}$
Example:

"1001"

Response

The session was opened

wcs
string
required

The session token. Refresh it with POST /v1/webrtc/config/refresh before it expires.

session_id
string<uuid>
required
call_id
string<uuid>
required
expires_at
string<date-time>
required
expires_in_seconds
integer
required
wss_url
string
required

The SIP-over-WebSocket URL.

sip_user
string
required

The SIP user to register as (the identity, for an agent session).

sip_password
string
required

The SIP password for this session. Returned once; never stored in plain text.

sip_domain
string
required
ice_servers
object[]
required
session_type
enum<string>
required

agent — registered as a web-calling identity, can receive calls. caller — can only call out.

Available options:
agent,
caller
identity
string

The identity of an agent session. Absent for a caller session.