REST ClientFabricConference Rooms

update

View as MarkdownOpen in Claude

Replace a conference room resource. Uses PUT for full replacement.

Path parameters

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

Request

enable_room_previewsbooleanRequired
Enables live video room previews for the conference.
sync_audio_videobooleanRequired
Syncs the participants audio and video.
namestringOptional
The name of the Conference Room
display_namestringOptional<=200 characters
Display name of the Conference Room
descriptionstringOptional<=3000 characters
The descrption of the Conference Room
join_fromdatetimeOptional
The time users are allowed to start joining the conference. Joining before this time will result in failure to join the conference.
join_untildatetimeOptional
The time users are allowed to until the conference is locked. Attempting to join the conference after the set time will result in failure to join the conference.
max_membersintegerOptional0-300
Maximum number of members allowed in the conference room
qualityenumOptionalDefaults to 720p
The viudeo quality of the Conference Room.
Allowed values:
remove_atdatetimeOptional
The time to remove all participants from the conference.
remove_after_seconds_elapsedintegerOptional0-200000
The amount of time in seconds to remove a particpant from a conference after they join.
layoutenumOptional
The video layout of the conference.
record_on_startbooleanOptional
Starts recording when the conference starts.
metaobjectOptional
Metadata of the conference.
tone_on_entry_and_exitbooleanOptional
Plays a tone when a participant joins or leaves the conference.
room_join_video_offbooleanOptional
Turns the conference video off when the participant joins the room if `true`.
user_join_video_offbooleanOptional
Turns the participants video off when the participant joins the room if `true`.

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
Allowed values:
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
1{
2  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
3  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
4  "display_name": "Reception",
5  "type": "video_room",
6  "created_at": "2024-05-06T12:20:00Z",
7  "updated_at": "2024-05-06T12:20:00Z",
8  "conference_room": {
9    "id": "1bd571e4-5ea4-4a70-a3c8-2bab5d20e754",
10    "name": "coffee_cafe",
11    "description": "This room is for coffee, no shop talk",
12    "display_name": "Reception",
13    "max_members": 30,
14    "quality": "1080p",
15    "fps": 30,
16    "join_from": "2024-05-06T12:20:00Z",
17    "join_until": "2024-05-06T12:20:00Z",
18    "remove_at": "2024-05-06T12:20:00Z",
19    "remove_after_seconds_elapsed": 1,
20    "layout": "grid-responsive",
21    "record_on_start": true,
22    "tone_on_entry_and_exit": true,
23    "room_join_video_off": true,
24    "user_join_video_off": true,
25    "enable_room_previews": true,
26    "sync_audio_video": true,
27    "meta": {
28      "foo": "bar"
29    },
30    "prioritize_handraise": false
31  }
32}

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 updated = await client.fabric.conferenceRooms.update("room-id", {
10  name: "updated-name",
11  enable_room_previews: true,
12  sync_audio_video: true,
13});
14console.log(`Updated: ${updated.display_name}`);