Provide Live WebRTC Offer and Get Answer

Provide an external WebRTC Offer and synchronously wait for an Answer to be generated. Optionally allows for the caller to specify an external sessionId along with the Offer. This is the one and only call in the synchronous WebRTC connection establishment process.

Once established, it can be renegotiated using the sessionId via Renegotiate Live WebRTC or ended via Stop Live WebRTC.

📘

Note

Using this endpoint isn't recommended unless you provide your own iceServers with STUN, TURN and TURNS capabilities. If none or STUN only are provided, the call setup can fail in many network topologies.

Permissions

Requires a Permissions scope of: circle:live

Response Body

Name

Type

Description

sdp

string

A full WebRTC compliant SDP blob. This should be passed directly to the Javascript or Native API's which consume Offers such as RTCPeerConnection.setRemoteDescription()

sessionId

string

The session_id generated for this call. Is the same value as in the Request Body if sent, otherwise an opaque string is generated. This value is required to invoke Renegotiate Live WebRTC or Stop Live WebRTC.

Language
Authentication
OAuth2