REST ClientFabricConference Rooms

list

View as MarkdownOpen in Claude

List conference room resources in the project.

Response

datalist of objectsRequired
An array of objects containing the Conference Room data

Response Example

Response
1{
2  "links": {
3    "self": "https://example.signalwire.com/api/fabric/resources/conference_room/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&type=conference_room",
4    "first": "https://example.signalwire.com/api/fabric/resources/conference_room/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&type=conference_room",
5    "next": "https://example.signalwire.com/api/fabric/resources/conference_room/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=1&page_size=50&page_token=PA6581c1fa-d985-4c8f-b53e-2fee11b579ad&type=conference_room",
6    "prev": "https://example.signalwire.com/api/fabric/resources/conference_room/016e5773-c197-4446-bcc2-9c48f14e2d0a/addresses?page_number=0&page_size=50&page_token=PA6581c1fa-d985-4c8f-b53e-2fee11b579ad&type=conference_room"
7  },
8  "data": [
9    {
10      "id": "993ed018-9e79-4e50-b97b-984bd5534095",
11      "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
12      "display_name": "Reception",
13      "type": "video_room",
14      "created_at": "2024-05-06T12:20:00Z",
15      "updated_at": "2024-05-06T12:20:00Z",
16      "conference_room": {
17        "id": "1bd571e4-5ea4-4a70-a3c8-2bab5d20e754",
18        "name": "coffee_cafe",
19        "description": "This room is for coffee, no shop talk",
20        "display_name": "Reception",
21        "max_members": 30,
22        "quality": "1080p",
23        "fps": 30,
24        "join_from": "2024-05-06T12:20:00Z",
25        "join_until": "2024-05-06T12:20:00Z",
26        "remove_at": "2024-05-06T12:20:00Z",
27        "remove_after_seconds_elapsed": 1,
28        "layout": "grid-responsive",
29        "record_on_start": true,
30        "tone_on_entry_and_exit": true,
31        "room_join_video_off": true,
32        "user_join_video_off": true,
33        "enable_room_previews": true,
34        "sync_audio_video": true,
35        "meta": {
36          "foo": "bar"
37        },
38        "prioritize_handraise": false
39      }
40    }
41  ]
42}

Example

1import { RestClient } from "@signalwire/sdk";
2
3const client = new RestClient({
4  project: "your-project-id",
5  token: "your-api-token",
6  host: "your-space.signalwire.com"
7});
8
9const response = await client.fabric.conferenceRooms.list();
10for (const room of response.data ?? []) {
11  console.log(`${room.display_name}: ${room.id}`);
12}