Legs

Get a SIPREC recording session

Changed on

Returns the RFC 7865 recording metadata of an inbound SIPREC session (leg type siprec_in): every recorded participant, every negotiated media stream, and the binding between them. A stream's a=label is what ties the m= section to a participant, so the streams entries carry both the leg stream ID and the participant identity. The raw metadata document is returned verbatim in metadata.

get/legs/{id}/siprec

Request

  • Base URL
    http://localhost:8080/v1
  • URL
    http://localhost:8080/v1/legs/{id}/siprec
  • Auth
    none declared

Response

Recording session state

leg_idstring required

Leg carrying the recording session.

session_idstring

Communication session being recorded, from the metadata's sessionrecordingassoc.

data_mode'complete' | 'partial'

Data mode of the most recently applied metadata document (RFC 7865 §6.1).

room_idstring

Room this session's streams were attached to, when SIPREC_ROOM_MODE placed them in one.

metadatastring

The raw rs-metadata XML document as most recently received.

warningsstring[]

What could be disproved about the metadata by the SDP it arrived with. Non-empty means the participant attributed to a stream may be wrong; the session is still recorded. Empty means nothing was disproved, which is not an assertion that the mapping is correct — an offer with no labels or no a=ssrc cname gives nothing to check against.

Changes