REST ClientFabricConference Rooms

create

View as MarkdownOpen in Claude

Create a new conference room resource.

Request

namestringRequired
The name of the Conference Room
enable_room_previewsbooleanRequired
Enables live video room previews for the conference.
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 video quality of the Conference Room.
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.
sync_audio_videobooleanOptional
Syncs the participants audio and video.
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
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 result = await client.fabric.conferenceRooms.create({
  name: "my-room",
  enable_room_previews: true,
});
console.log(`Created: ${result.display_name}`);