Create a Video Conference
POST/conferences
Create a Video Conference.
Permissions
The API token must include the following scopes: Video.
Request
- application/json
Body
required
A named unique identifier for the room. Allowed characters: A-Za-z0-9_-
. Maximum of 100 characters.
my_room
Display name of the video conference. Maximum of 200 characters. Defaults to the value of name.
My Conference's Name
Description of the room. Maximum of 3000 characters.
This room will be used for full company all hands meetings
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
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
The conference's resolution. Allowed values are 720p
or 1080p
. Defaults to 720p
.
720p
The conference's initial layout. Defaults to grid-responsive
. See documentation for a full list of supported layouts.
grid-responsive
The size of the video conference. Allowed values are small
, medium
and large
. Defaults to medium
. See documentation for a list of size limitations.
small
Specifies whether to start recording a Conference Session when one is started for this Conference
Whether a video with a preview of the content of the conference is to be generated.
Enables group chat for all participants of the room. Defaults to true
.
Used for CTA buttons and selected items. Defaults to #044EF4
#044EF4
Main background color. Defaults to #FFFFFF
#FFFFFF
Main foreground color. Defaults to #1D2127
#1D2127
Used for success indications. Defaults to #17BB58
#17BB58
Used for error indications. Defaults to #F42C50
#F42C50
Used for CTA buttons and selected items. Defaults to #044EF4
#044EF4
Main background color. Defaults to #FFFFFF
#FFFFFF
Main foreground color. Defaults to #1D2127
#1D2127
Used for success indications. Defaults to #17BB58
#17BB58
Used for error indications. Defaults to #F42C50
#F42C50
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
Schema
A unique identifier for the video conference
A named unique identifier for the room. Allowed characters: A-Za-z0-9_-
. Maximum of 100 characters.
my_room
Display name of the video conference. Maximum of 200 characters. Defaults to the value of name.
My Conference's Name
Description of the room. Maximum of 3000 characters.
This room will be used for full company all hands meetings
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
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
The conference's resolution. Allowed values are 720p
or 1080p
. Defaults to 720p
.
720p
The conference's initial layout. Defaults to grid-responsive
. See documentation for a full list of supported layouts.
grid-responsive
The size of the video conference. Allowed values are small
, medium
and large
. Defaults to medium
. See documentation for a list of size limitations.
small
Specifies whether to start recording a Conference Session when one is started for this Conference
Whether a video with a preview of the content of the conference is to be generated.
Enables group chat for all participants of the room. Defaults to true
.
Used for CTA buttons and selected items. Defaults to #044EF4
#044EF4
Main background color. Defaults to #FFFFFF
#FFFFFF
Main foreground color. Defaults to #1D2127
#1D2127
Used for success indications. Defaults to #17BB58
#17BB58
Used for error indications. Defaults to #F42C50
#F42C50
Used for CTA buttons and selected items. Defaults to #044EF4
#044EF4
Main background color. Defaults to #FFFFFF
#FFFFFF
Main foreground color. Defaults to #1D2127
#1D2127
Used for success indications. Defaults to #17BB58
#17BB58
Used for error indications. Defaults to #F42C50
#F42C50
active_session
object
Unique ID of the session
Unique ID of the Room if the Session was created from a Room and was not an auto-created Session.
The named identifier of room session.
my_example_room
Display name of room, no character limitations. Maxium of 200 characters. Defaults to the value of name.
My Room's Name
Room Session does not accept new Members before this time.
Room Session stops accepting new Members at this time.
Remove Members from the Room Session at this time.
Remove Members after they are in the Room Session for N seconds.
120
The Room Session's initial layout. Defaults to grid-responsive
. See documentation for a full list of supported layouts.
grid-responsive
The maximum number of members allowed in the room at a time.
20
The Room Session's frames per second. Possible values are 20
or 30
.
20
The Room Session's resolution. Possible values are 720p
or 1080p
.
720p
How long, in seconds, the Room Session lasted.
120
completed
Whether a recording was automatically started when this Room Session began.
Whether a video with a preview of the content of the room is to be generated.
If room previews are enabled and the room session is in progress, this is the URL of the preview video.
https://...
Enable/disable jitter buffer audio-video sync.
false
true
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "my_room",
"display_name": "My Conference's Name",
"description": "This room will be used for full company all hands meetings",
"join_from": "2024-07-29T15:51:28.071Z",
"join_until": "2024-07-29T15:51:28.071Z",
"quality": "720p",
"layout": "grid-responsive",
"size": "small",
"record_on_start": true,
"enable_room_previews": true,
"enable_chat": true,
"dark_primary": "#044EF4",
"dark_background": "#FFFFFF",
"dark_foreground": "#1D2127",
"dark_success": "#17BB58",
"dark_negative": "#F42C50",
"light_primary": "#044EF4",
"light_background": "#FFFFFF",
"light_foreground": "#1D2127",
"light_success": "#17BB58",
"light_negative": "#F42C50",
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z",
"active_session": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"room_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "my_example_room",
"display_name": "My Room's Name",
"join_from": "2024-07-29T15:51:28.071Z",
"join_until": "2024-07-29T15:51:28.071Z",
"remove_at": "2024-07-29T15:51:28.071Z",
"remove_after_seconds_elapsed": 120,
"layout": "grid-responsive",
"max_members": 20,
"fps": 20,
"quality": "720p",
"start_time": "2024-07-29T15:51:28.071Z",
"end_time": "2024-07-29T15:51:28.071Z",
"duration": 120,
"status": "completed",
"record_on_start": true,
"enable_room_previews": true,
"preview_url": "https://...",
"audio_video_sync": true
}
}