Sign in
WebRTC

Establish a WebRTC leg via SDP offer/answer

post/webrtc/offer

Request body

sdpstring required

SDP offer from the browser

app_idstring

Application identifier. Carried through to all events emitted for this leg, and matched against the VSI app_id filter.

{"stackTrail":"components:schemas:WebRTCOfferRequest:properties:custom_data","oasType":"schema","type":"unknown","description":"Opaque application JSON attached to the leg. Any JSON value is accepted (object, array, string, number, boolean). It is echoed on the leg view and carried at the top level of every event published for this leg, so external state can be correlated without keeping a leg_id lookup table. Capped by CUSTOM_DATA_MAX_BYTES (default 1024 bytes, 0 = unlimited)."}

Response

SDP answer with leg ID

leg_idstring required
sdpstring required

Changes

Changed in 5 of the 67 revisions of this API.326

  • 89ff267f09581See the full diff
    • ○

      added the new optional request property custom_data

      new-optional-request-property

  • 1cf212b29f4e1See the full diff
    • ○

      added the new optional request property app_id

      new-optional-request-property

  • 7ab34b92424f112See the full diff
    • ▲

      removed the required property status from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property instance_id from the response with the 200 status

      response-optional-property-removed

    • ○

      added the required property leg_id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property sdp to the response with the 200 status

      response-required-property-added

  • d09c97c6ca8c11See the full diff
    • ●

      removed the request property app_id

      request-property-removed

    • ○

      added the optional property instance_id to the response with the 200 status

      response-optional-property-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 818619c99a1d21See the full diff
    • ▲

      removed the required property leg_id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property sdp from the response with the 200 status

      response-required-property-removed

    • ○

      added the required property status to the response with the 200 status

      response-required-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog