REST ClientFabricConference Rooms

get

View as MarkdownOpen in Claude

Retrieve a single conference room resource.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a Conference Room.

Response

idstringRequiredformat: "uuid"
Unique ID of the Conference Room.
project_idstringRequiredformat: "uuid"
Unique ID of the Project.
display_namestringRequired
Display name of the Conference Room Fabric Resource
typeenumRequired
Type of the Fabric Resource
created_atdatetimeRequired
Date and time when the resource was created.
updated_atdatetimeRequired
Date and time when the resource was updated.
conference_roomobjectRequired
Conference Room data.

Response Example

Response
{
  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Reception",
  "type": "video_room",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "conference_room": {
    "id": "1bd571e4-5ea4-4a70-a3c8-2bab5d20e754",
    "name": "coffee_cafe",
    "description": "This room is for coffee, no shop talk",
    "display_name": "Reception",
    "max_members": 30,
    "quality": "1080p",
    "fps": 30,
    "join_from": "2024-05-06T12:20:00Z",
    "join_until": "2024-05-06T12:20:00Z",
    "remove_at": "2024-05-06T12:20:00Z",
    "remove_after_seconds_elapsed": 1,
    "layout": "grid-responsive",
    "record_on_start": true,
    "tone_on_entry_and_exit": true,
    "room_join_video_off": true,
    "user_join_video_off": true,
    "enable_room_previews": true,
    "sync_audio_video": true,
    "meta": {
      "foo": "bar"
    },
    "prioritize_handraise": false
  }
}

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.fabric.conferenceRooms.get("room-id");
console.log(`Conference Room: ${room.display_name}, ID: ${room.id}`);