Room Sessions

Get room session

Retrieves one past or in-progress Room Session by ID. Use it to inspect the session associated with an event, member, or recording; use Get room when you need the reusable room configuration rather than an occurrence of activity.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Video.

Learn more about API scopes.

get/api/video/room_sessions/{id}

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/video/room_sessions/{id}
  • Auth
    HTTP basic

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the Room Session.

Response

Room session response.

idstring uuid required

Universal Unique Identifier.

room_idstring uuid required

Universal Unique Identifier.

namestring nullable required

The named identifier of the room session.

display_namestring nullable required

Display name of the room. Maximum of 200 characters. Defaults to the value of name.

max_membersinteger nullable required

The maximum number of members allowed in the room at a time.

quality'720p' | '1080p' required

Video quality resolution.

fps20 | 30 required

Video frames per second.

join_fromstring date-time nullable required

Room Session does not accept new Members before this time.

join_untilstring date-time nullable required

Room Session stops accepting new Members at this time.

remove_atstring date-time nullable required

Remove Members from the Room Session at this time.

remove_after_seconds_elapsedinteger nullable required

Remove Members after they are in the Room Session for N seconds.

layoutstring nullable required

The room session's initial layout.

record_on_startboolean required

Whether a recording was automatically started when this Room Session began.

tone_on_entry_and_exitboolean required

Whether a tone is played when a member enters or exits the room session.

room_join_video_offboolean required

Whether participants join with video off by room setting.

user_join_video_offboolean required

Whether participants join with video off by user setting.

lockedboolean required

Whether the room session is locked.

start_timestring date-time nullable required

Start time of the session.

end_timestring date-time nullable required

End time of the session.

durationinteger nullable required

How long, in seconds, the Room Session lasted.

status'in-progress' | 'completed' required

Status of a room session.

created_atstring date-time required

Timestamp when the room session was created.

updated_atstring date-time required

Timestamp when the room session was last updated.

preview_urlstring nullable required

If room previews are enabled and the room session is in progress, this is the URL of the preview video.

prioritize_handraiseboolean nullable required

Whether raised hands are prioritized in the layout.

sync_audio_videoboolean nullable required

Enable/disable jitter buffer audio-video sync.

Example response

{
  "name": "my_example_room",
  "display_name": "My Room's Name",
  "max_members": 20,
  "join_from": "2022-01-01T00:00:00Z",
  "join_until": "2022-12-31T23:59:59Z",
  "remove_at": "2022-12-31T23:59:59Z",
  "remove_after_seconds_elapsed": 120,
  "layout": "grid-responsive",
  "tone_on_entry_and_exit": true,
  "start_time": "2022-01-01T10:00:00Z",
  "end_time": "2022-01-01T11:00:00Z",
  "duration": 120,
  "created_at": "2022-01-01T10:00:00Z",
  "updated_at": "2022-01-01T11:00:00Z",
  "preview_url": "https://example.signalwire.com/preview/abc123",
  "sync_audio_video": true
}

Changes

No operation changes found yet. Some revisions have not been checked.