FabricConference Rooms

Create Conference Room

View as Markdown

Creates a Conference Room

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Request

This endpoint expects an object.
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 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.
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

The request has succeeded.
idstringformat: "uuid"
Unique ID of the Conference Room.
project_idstringformat: "uuid"
Unique ID of the Project.
display_namestring
Display name of the Conference Room Fabric Resource
typeenum
Type of the Fabric Resource
Allowed values:
created_atdatetime
Date and time when the resource was created.
updated_atdatetime
Date and time when the resource was updated.
conference_roomobject
Conference Room data.

Errors