Update a Video Conference

Update a Video Conference.

Permissions

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

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

Path parameters

idstringRequiredformat: "uuid"

Unique ID of the video conference.

Request

This endpoint expects an object.

display_namestringRequired<=200 characters

Display name of the video conference. Maximum of 200 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.

tone_on_entry_and_exitbooleanOptional

Whether a tone is played when a member enters or exits the conference.

room_join_video_offbooleanOptional

Whether participants join with video off by room setting.

user_join_video_offbooleanOptional

Whether participants join with video off by user setting.

enable_room_previewsbooleanOptional

Whether a preview video of the conference content is generated.

enable_chatbooleanOptional

Whether group chat is enabled for conference participants.

dark_primarystringOptionalformat: "^#[0-9a-fA-F]{6}$"

CTA buttons and selected items color (dark theme).

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

Main background color (dark theme).

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

Main foreground color (dark theme).

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

Success indication color (dark theme).

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

Error indication color (dark theme).

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

CTA buttons and selected items color (light theme).

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

Main background color (light theme).

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

Main foreground color (light theme).

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

Success indication color (light theme).

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

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.

1	curl -X PUT https://{your_space_name}.signalwire.com/api/video/conferences/id \
2	-H "Content-Type: application/json" \
3	-u "<project_id>:<api_token>" \
4	-d '{
5	"display_name": "My Conference\'s Name"
6	}'

1	{
2	"id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
3	"name": "my_conference",
4	"display_name": "My Conference's Name",
5	"description": "This conference will be used for full company all hands meetings",
6	"join_from": "2022-01-01T00:00:00Z",
7	"join_until": "2022-12-31T23:59:59Z",
8	"quality": "720p",
9	"layout": "grid-responsive",
10	"size": "medium",
11	"record_on_start": false,
12	"tone_on_entry_and_exit": true,
13	"user_join_video_off": false,
14	"room_join_video_off": false,
15	"enable_chat": true,
16	"enable_room_previews": false,
17	"dark_primary": "#044EF4",
18	"dark_background": "#FFFFFF",
19	"dark_foreground": "#1D2127",
20	"dark_success": "#17BB58",
21	"dark_negative": "#F42C50",
22	"light_primary": "#044EF4",
23	"light_background": "#FFFFFF",
24	"light_foreground": "#1D2127",
25	"light_success": "#17BB58",
26	"light_negative": "#F42C50",
27	"meta": {},
28	"created_at": "2022-01-01T10:00:00Z",
29	"updated_at": "2022-01-01T11:00:00Z",
30	"active_session": {
31	"id": "c22d24f6-5a47-4597-9a23-c7d01e696b92",
32	"room_id": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
33	"name": "my_example_room",
34	"display_name": "My Room's Name",
35	"join_from": "2022-01-01T00:00:00Z",
36	"join_until": "2022-12-31T23:59:59Z",
37	"remove_at": "2022-12-31T23:59:59Z",
38	"remove_after_seconds_elapsed": 120,
39	"layout": "grid-responsive",
40	"max_members": 20,
41	"fps": 20,
42	"quality": "720p",
43	"start_time": "2022-01-01T10:00:00Z",
44	"end_time": "2022-01-01T11:00:00Z",
45	"duration": 120,
46	"status": "completed",
47	"record_on_start": true,
48	"enable_room_previews": true,
49	"preview_url": "https://example.signalwire.com/api/video/room_sessions/c22d24f6-5a47-4597-9a23-c7d01e696b92/preview",
50	"audio_video_sync": true
51	}
52	}

Permissions

Authentication

Path parameters

Request

Response

Errors