REST ClientVideoVideoRoomSessions

get

View as MarkdownOpen in Claude

Retrieve a single room session by its unique identifier.

Path parameters

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

Response

idstringRequiredformat: "uuid"
Unique ID of the session.
room_idstring or nullRequiredformat: "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 nullRequired
The named identifier of the room session.
display_namestring or nullRequired
Display name of the room. Maximum of 200 characters. Defaults to the value of name.
max_membersinteger or nullRequired
The maximum number of members allowed in the room at a time.
qualityenum or nullRequired
The room session's resolution.
Allowed values:
fpsenum or nullRequired
The room session's frames per second.
Allowed values:
join_fromdatetime or nullRequired
Room Session does not accept new Members before this time.
join_untildatetime or nullRequired
Room Session stops accepting new Members at this time.
remove_atdatetime or nullRequired
Remove Members from the Room Session at this time.
remove_after_seconds_elapsedinteger or nullRequired
Remove Members after they are in the Room Session for N seconds.
layoutstring or nullRequired
The room session's initial layout.
record_on_startbooleanRequired
Whether a recording was automatically started when this Room Session began.
tone_on_entry_and_exitbooleanRequired
Whether a tone is played when a member enters or exits the room session.
room_join_video_offbooleanRequired
Whether participants join with video off by room setting.
user_join_video_offbooleanRequired
Whether participants join with video off by user setting.
lockedbooleanRequired
Whether the room session is locked.
start_timedatetime or nullRequired
Start time of the session.
end_timedatetime or nullRequired
End time of the session.
durationinteger or nullRequired
How long, in seconds, the Room Session lasted.
statusenum or nullRequired
Status of the session.
Allowed values:
created_atdatetimeRequired
Timestamp when the room session was created.
updated_atdatetimeRequired
Timestamp when the room session was last updated.
preview_urlstring or nullRequired
If room previews are enabled and the room session is in progress, this is the URL of the preview video.
prioritize_handraiseboolean or nullRequired
Whether raised hands are prioritized in the layout.
sync_audio_videoboolean or nullRequired
Enable/disable jitter buffer audio-video sync.

Response Example

Response
{
  "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
  "room_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
  "name": "my_example_room",
  "display_name": "My Room's Name",
  "max_members": 20,
  "quality": "720p",
  "fps": 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",
  "record_on_start": false,
  "tone_on_entry_and_exit": true,
  "room_join_video_off": false,
  "user_join_video_off": false,
  "locked": false,
  "start_time": "2022-01-01T10:00:00Z",
  "end_time": "2022-01-01T11:00:00Z",
  "duration": 120,
  "status": "completed",
  "created_at": "2022-01-01T10:00:00Z",
  "updated_at": "2022-01-01T11:00:00Z",
  "preview_url": "https://example.signalwire.com/preview/abc123",
  "prioritize_handraise": false,
  "sync_audio_video": true
}

Example

from signalwire.rest import RestClient
client = RestClient(
    project="your-project-id",
    token="your-api-token",
    host="your-space.signalwire.com",
)
session = client.video.room_sessions.get("session-id")