Sessions

Accept call

POST/live/sessions/{session_id}/accept

Download recording

GET/live/sessions/{session_id}/content

Fork session

POST/live/sessions/{session_id}/fork

Hang up session

POST/live/sessions/{session_id}/hangup

Transfer call

POST/live/sessions/{session_id}/refer

Reject call

POST/live/sessions/{session_id}/reject

ModelsExpand Collapse

SessionForkResponse object { session, transport }

The created Live session identifier and WebRTC answer. Apply transport.sdp as the peer’s remote answer and wait for session.started on the data channel before sending commands.

session: object { id }

The newly created Live session. Use its ID for session controls and sideband connections.

id: string

Opaque session identifier. Preserve the returned value unchanged, including its prefix.

transport: object { sdp, type }

WebRTC transport with the SDP answer.

sdp: string

Session Description Protocol message for the WebRTC connection.

minLength1

type: "webrtc"

The transport used for the Live session. Always webrtc.

Suggested