VideoRoom Sessions

Find a Room Session by ID

View as Markdown

Find a Room Session by ID.

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.

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the Room Session.

Response

Room session response.
idstringformat: "uuid"
Unique ID of the session.
room_idstring or nullformat: "uuid"

Unique ID of the Room if the Session was created from a Room and was not an auto-created Session. Null if the room was set to delete on end.

namestring or null
The named identifier of the room session.
display_namestring or null
Display name of the room. Maximum of 200 characters. Defaults to the value of name.
max_membersinteger or null
The maximum number of members allowed in the room at a time.
qualityenum or null
The room session's resolution.
Allowed values:
fpsenum or null
The room session's frames per second.
Allowed values:
join_fromdatetime or null
Room Session does not accept new Members before this time.
join_untildatetime or null
Room Session stops accepting new Members at this time.
remove_atdatetime or null
Remove Members from the Room Session at this time.
remove_after_seconds_elapsedinteger or null
Remove Members after they are in the Room Session for N seconds.
layoutstring or null
The room session's initial layout.
record_on_startboolean
Whether a recording was automatically started when this Room Session began.
tone_on_entry_and_exitboolean
Whether a tone is played when a member enters or exits the room session.
room_join_video_offboolean
Whether participants join with video off by room setting.
user_join_video_offboolean
Whether participants join with video off by user setting.
lockedboolean
Whether the room session is locked.
start_timedatetime or null
Start time of the session.
end_timedatetime or null
End time of the session.
durationinteger or null
How long, in seconds, the Room Session lasted.
statusenum or null
Status of the session.
Allowed values:
created_atdatetime
Timestamp when the room session was created.
updated_atdatetime
Timestamp when the room session was last updated.
preview_urlstring or null
If room previews are enabled and the room session is in progress, this is the URL of the preview video.
prioritize_handraiseboolean or null
Whether raised hands are prioritized in the layout.
sync_audio_videoboolean or null

Enable/disable jitter buffer audio-video sync.

Errors