Skip to main content

Create room

End point: /room/create

FieldTypePositionRequiredDescription
room_idstringrootYesRoom Id should be unique for every room/session/meeting
max_participantsnumberrootNoLimit number of participants that can be join in this room.
empty_timeoutnumberrootNoNumber of seconds to keep the room open if no one joins
metadatastringrootYes
room_titlestringmetadataYesTitle of the room/meeting
welcome_messagestringmetadataNoIf you want to show some message at start up.
room_featuresstringmetadataYesVarious room features.
allow_webcamsbooleanroom_featuresYesIf you want to enable webcam support.
mute_on_startbooleanroom_featuresYesIf you want to mute microphone automatically after share.
allow_screen_sharebooleanroom_featuresYesEnable or disable screen share for the meeting.
allow_recordingbooleanroom_featuresYesEnable or disable recording for the meeting.
allow_rtmpbooleanroom_featuresYesEnable or disable RTMP for the meeting.
admin_only_webcamsbooleanroom_featuresYesIf you want to allow webcams only for admin
allow_view_other_webcamsbooleanroom_featuresYesIf you want to disable to display other users camera except moderator.
allow_view_other_users_listbooleanroom_featuresYesIf you want to disable to display users list except moderator.
chat_featuresstringroom_featuresYes
allow_chatbooleanchat_featuresYesEnable or disable chat for the meeting.
allow_file_uploadbooleanchat_featuresYesEnable or disable file upload in chat for the meeting.
shared_note_pad_featuresstringroom_featuresYes
allowed_shared_note_padbooleanshared_note_pad_featuresYesEnable or disable shared notepad for the meeting.
whiteboard_featuresstringroom_featuresYes
allowed_whiteboardbooleanwhiteboard_featuresYesEnable or disable whiteboard for the meeting.
external_media_player_featuresstringroom_featuresYes
allowed_external_media_playerbooleanexternal_media_player_featuresYesEnable or disable to allow to play video/audio from external source. Moderator can upload local video/audio too.
waiting_room_featuresstringroom_featuresYes
is_activebooleanwaiting_room_featuresYesEnable if you want to activate wating room feature. User will be in waiting room until moderator allow to join.
breakout_room_featuresstringroom_featuresYes
is_activebooleanbreakout_room_featuresYesEnable or disable breakout room features.
allowed_number_roomsnumberbreakout_room_featuresNoNumber of breakout rooms allowed to create at a same time. Default: 6
display_external_link_featuresstringroom_featuresYes
is_activebooleandisplay_external_link_featuresYesEnable or disable to allow to display external links inside a iframe. This feature is helpful if your session to require to display other website, quiz, games etc. The website must be allow to load inside an iframe. Moderator can pass various values like name, userId, role, meetingId etc.
default_lock_settingsstringroom_featuresNO
lock_microphonebooleandefault_lock_settingsNOLock microphone for users.
lock_webcambooleandefault_lock_settingsNOLock webcam for users.
lock_screen_sharingbooleandefault_lock_settingsNOLock screen share for users.
lock_chatbooleandefault_lock_settingsNOLock chat for users.
lock_chat_send_messagebooleandefault_lock_settingsNOLock send message for users.
lock_chat_file_sharebooleandefault_lock_settingsNOLock send file for users.

Example:

{
"room_id": "room01",
"metadata": {
"room_title": "Test room",
"welcome_message": "Welcome to room",
"room_features": {
"allow_webcams": true,
"mute_on_start": false,
"allow_screen_share": true,
"allow_recording": true,
"allow_rtmp": true,
"allow_view_other_webcams": true,
"allow_view_other_users_list": true,
"admin_only_webcams": false,
"room_duration": 0
},
"chat_features": {
"allow_chat": true,
"allow_file_upload": true
},
"shared_note_pad_features": {
"allowed_shared_note_pad": true
},
"whiteboard_features": {
"allowed_whiteboard": true
},
"external_media_player_features": {
"allowed_external_media_player": true
},
"waiting_room_features": {
"is_active": false
},
"breakout_room_features": {
"is_allow": true,
"allowed_number_rooms": 5
},
"display_external_link_features": {
"is_allow": true
},
"default_lock_settings": {
"lock_microphone": false,
"lock_webcam": false,
"lock_screen_sharing": true,
"lock_whiteboard": true,
"lock_shared_notepad": true,
"lock_chat": false,
"lock_chat_send_message": false,
"lock_chat_file_share": false,
"lock_private_chat": false
}
}
}

Response

FieldTypePositionDescription
statusbooleanrootThe status of the request
msgstringrootResponse message
roomInfostringroot
sidstringroomInfoRoom sid
namestringroomInfoRoom Id
max_participantsnumberroomInfoMaximum participants for this room
empty_timeoutnumberroomInfoMaximum duration before closing empty room
creation_timenumberroomInfoRoom creation time in unix time format
turn_passwordstringroomInfoTurn password
enabled_codecsArrayroomInfoVideo codecs for this room
metadatastringroomInfoRoom metadata