New Session

Create a session

With no request body, this operation returns a sessionId without establishing a WebRTC connection. Create the session when ready to begin SDP negotiation. An unconnected session can expire before its first use.

post/apps/{appId}/sessions/new

Request

Base URL: https://rtc.live.cloudflare.com/v1
URL: https://rtc.live.cloudflare.com/v1/apps/{appId}/sessions/new
Auth: HTTP bearer

Path parameters

appIdstring required

WebRTC application ID

Query parameters

thirdpartyboolean

Session is intended to connect to an ICE-lite peer like a third party SFU/server

correlationIdstring

Associate a diagnostic label with the new session. This is not an idempotency key: repeating a request with the same value creates a separate session. The Connection API does not provide lookup by correlationId. Retain the returned sessionId.

Response

Created

errorCodestring

errorDescriptionstring

sessionIdstring required

Example response

{
  "sessionId": "e017a2629c754fedc1f7d8587e06d126"
}

Changes

No recorded changes to this operation across all 1 revision of this API.