VideoConferences

Create a Video Conference

View as Markdown

Create a Video Conference.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: 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.
display_namestringRequired<=200 characters
Display name of the video conference. Maximum of 200 characters.
namestringOptionalformat: "^[A-Za-z0-9_-]+$"<=100 characters

A named unique identifier for the conference. Allowed characters: A-Za-z0-9_-. Maximum of 100 characters.

descriptionstringOptional<=3000 characters
Description of the conference. Maximum of 3000 characters.
join_fromdatetimeOptional

Conference does not accept new participants before this time. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z.

join_untildatetimeOptional

Conference stops accepting new participants at this time, but keeps running until all participants leave. Expects RFC 3339 datetime: 2022-01-01T23:59:60Z. Date only: 2022-01-01 will be converted to 2022-01-01T00:00:00Z.

qualityenumOptional
The conference's resolution.
Allowed values:
layoutenumOptional
The conference's initial layout.
sizeenumOptional
The size of the video conference.
Allowed values:
record_on_startbooleanOptional
Whether to start recording when a conference session begins.
enable_room_previewsbooleanOptional
Whether a preview video of the conference content is generated.
enable_chatbooleanOptionalDefaults to true
Whether group chat is enabled for conference participants.
dark_primarystringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #044EF4

CTA buttons and selected items color (dark theme).

dark_backgroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #FFFFFF

Main background color (dark theme).

dark_foregroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #1D2127

Main foreground color (dark theme).

dark_successstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #17BB58

Success indication color (dark theme).

dark_negativestringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #F42C50

Error indication color (dark theme).

light_primarystringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #044EF4

CTA buttons and selected items color (light theme).

light_backgroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #FFFFFF

Main background color (light theme).

light_foregroundstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #1D2127

Main foreground color (light theme).

light_successstringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #17BB58

Success indication color (light theme).

light_negativestringOptionalformat: "^#[0-9a-fA-F]{6}$"Defaults to #F42C50

Error indication color (light theme).

Response

Conference response wrapper.
idstringformat: "uuid"
Unique ID of the video conference.
namestring

A named unique identifier for the conference. Allowed characters: A-Za-z0-9_-.

display_namestring or null
Display name of the video conference. Maximum of 200 characters.
descriptionstring or null
Description of the conference. Maximum of 3000 characters.
join_fromdatetime or null
Conference does not accept new participants before this time.
join_untildatetime or null
Conference stops accepting new participants at this time, but keeps running until all participants leave.
qualityenum
The conference's resolution.
Allowed values:
layoutenum
The conference's initial layout.
sizeenum or null
The size of the video conference.
Allowed values:
record_on_startboolean
Whether to start recording when a conference session begins.
tone_on_entry_and_exitboolean
Whether a tone is played when a member enters or exits the conference.
user_join_video_offboolean
Whether participants join with video off by user setting.
room_join_video_offboolean
Whether participants join with video off by room setting.
enable_chatboolean
Whether group chat is enabled for conference participants.
enable_room_previewsboolean or null
Whether a preview video of the conference content is generated.
dark_primarystring or null

CTA buttons and selected items color (dark theme).

dark_backgroundstring or null

Main background color (dark theme).

dark_foregroundstring or null

Main foreground color (dark theme).

dark_successstring or null

Success indication color (dark theme).

dark_negativestring or null

Error indication color (dark theme).

light_primarystring or null

CTA buttons and selected items color (light theme).

light_backgroundstring or null

Main background color (light theme).

light_foregroundstring or null

Main foreground color (light theme).

light_successstring or null

Success indication color (light theme).

light_negativestring or null

Error indication color (light theme).

metaobject or null

User-defined metadata for the conference.

created_atdatetime
Timestamp when the conference was created.
updated_atdatetime
Timestamp when the conference was last updated.
active_sessionobject or null

Active session information. Only present when requested via the include_active_session query parameter.

Errors