Create conference room

POST

https://{your_space_name}.signalwire.com/api/fabric/resources/conference_rooms

POST

/api/fabric/resources/conference_rooms

curl -X POST https://{your_space_name}.signalwire.com/api/fabric/resources/conference_rooms \
     -H "Content-Type: application/json" \
     -u "<project_id>:<api_token>" \
     -d '{
  "name": "coffee_cafe",
  "enable_room_previews": true
}'

{
  "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
  }
}

Creates a Fabric Conference Room resource that can be reached through resource addresses and used in call routing. Use it for a programmable, addressable video room; use Create video conference for a managed hosted conference, or Create room for an SDK-based Video Room configuration.

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.

Creates a Fabric Conference Room resource that can be reached through resource addresses and used in call routing. Use it for a programmable, addressable video room; use [Create video conference](/docs/apis/rest/video/video-conferences/create-video-conference) for a managed hosted conference, or [Create room](/docs/apis/rest/video/rooms/create-room) for an SDK-based Video Room configuration. #### 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](/docs/platform/your-signalwire-api-space).

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)

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 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

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

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

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error