get

Retrieve a single video room by ID.

Path parameters

idstringRequiredformat: "uuid"

Unique ID of the room.

Query parameters

include_active_sessionbooleanOptional

Specifies whether or not to include information about the room's active session (if any).

Response

idstringRequiredformat: "uuid"

A unique identifier for the room.

namestringRequired

A named unique identifier for the room.

display_namestring or nullRequired

Display name of the room.

descriptionstring or nullRequired

Description of the room.

max_membersintegerRequired

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

qualityenumRequired

The room's resolution.

fpsintegerRequired

Frames per second parameter of room video quality.

join_fromdatetime or nullRequired

Room does not accept new participants before this time.

join_untildatetime or nullRequired

Room stops accepting new participants at this time.

remove_atdatetime or nullRequired

Remove users from the room at this time.

remove_after_seconds_elapsedinteger or nullRequired

Remove users after they are in the room for N seconds.

layoutenumRequired

The room's initial layout.

record_on_startbooleanRequired

Specifies whether to start recording a Room Session when one is started for this Room.

tone_on_entry_and_exitbooleanRequired

Whether a tone is played when participants enter or exit the room.

room_join_video_offbooleanRequired

Whether the room's video is turned off when participants join.

user_join_video_offbooleanRequired

Whether a user's video is turned off when they join the room.

enable_room_previewsboolean or nullRequired

Whether a video with a preview of the content of the room is to be generated.

sync_audio_videoboolean or nullRequired

Enable/disable jitter buffer audio-video sync.

metaobject or nullRequired

User-defined metadata for the room.

prioritize_handraisebooleanRequired

Whether hand raises are prioritized in the room layout.

created_atdatetimeRequired

Timestamp when the room was created.

updated_atdatetimeRequired

Timestamp when the room was last updated.

active_sessionobjectOptional

Active session information for the room.

Response Example

Response

{
  "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
  "name": "my_room",
  "display_name": "My Room's Name",
  "description": "This room will be used for full company all hands meetings",
  "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,
  "enable_room_previews": false,
  "sync_audio_video": true,
  "meta": {},
  "prioritize_handraise": false,
  "created_at": "2022-01-01T10:00:00Z",
  "updated_at": "2022-01-01T11:00:00Z",
  "active_session": {
    "id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
    "room_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
    "name": "my_example_room",
    "display_name": "My Room's Name",
    "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",
    "max_members": 20,
    "fps": 20,
    "quality": "720p",
    "start_time": "2022-01-01T10:00:00Z",
    "end_time": "2022-01-01T11:00:00Z",
    "duration": 120,
    "status": "completed",
    "record_on_start": true,
    "enable_room_previews": true,
    "preview_url": "https://example.signalwire.com/api/video/room_sessions/c22d24f6-5a47-4597-9a23-c7d01e696b92/preview",
    "audio_video_sync": true
  }
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com",
});
const room = await client.video.rooms.get("room-id");
console.log("Room:", room.name, "ID:", room.id);