Response
id string Required format: "uuid"
Unique ID of the session.
room_id string or null Required format: "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.
name string or null Required
The named identifier of the room session.
display_name string or null Required
Display name of the room. Maximum of 200 characters. Defaults to the value of name.
max_members integer or null Required
The maximum number of members allowed in the room at a time.
quality enum or null Required
The room session's resolution.
Allowed values: 720p 1080p
fps enum or null Required
The room session's frames per second.
Allowed values: 20 30
join_from datetime or null Required
Room Session does not accept new Members before this time.
join_until datetime or null Required
Room Session stops accepting new Members at this time.
remove_at datetime or null Required
Remove Members from the Room Session at this time.
remove_after_seconds_elapsed integer or null Required
Remove Members after they are in the Room Session for N seconds.
layout string or null Required
The room session's initial layout.
record_on_start boolean Required
Whether a recording was automatically started when this Room Session began.
tone_on_entry_and_exit boolean Required
Whether a tone is played when a member enters or exits the room session.
room_join_video_off boolean Required
Whether participants join with video off by room setting.
user_join_video_off boolean Required
Whether participants join with video off by user setting.
locked boolean Required
Whether the room session is locked.
start_time datetime or null Required
Start time of the session.
end_time datetime or null Required
End time of the session.
duration integer or null Required
How long, in seconds, the Room Session lasted.
status enum or null Required
Status of the session.
Allowed values: in-progress completed
created_at datetime Required
Timestamp when the room session was created.
updated_at datetime Required
Timestamp when the room session was last updated.
preview_url string or null Required
If room previews are enabled and the room session is in progress, this is the URL of the preview video.
prioritize_handraise boolean or null Required
Whether raised hands are prioritized in the layout.
sync_audio_video boolean or null Required
Enable/disable jitter buffer audio-video sync.
SignalWire Docs