Skip to main content

Create room

End point: /room/create

Request parameters

room_idstringYesRoom Id should be unique for every room/session/meeting
max_participantsnumberNoLimit number of participants that can be join in this room.
empty_timeoutnumberNoNumber of seconds to keep the room open if no one joins


room_titlestringYesTitle of the room/meeting
welcome_messagestringNoIf you want to show some message at start up.
webhook_urlstringNoYou can put webhook URL in where plugNmeet will send post request based on various events.
logout_urlstringNoYou can put logout URL in where plugNmeet will redirect the users after meeting/session ended.
room_featuresobjectYesVarious room features.
default_lock_settingsobjectNoDefault lock settings
extra_datastringNoYou can store extra data.

Room Features

allow_webcamsbooleanYesIf you want to enable webcam support.
mute_on_startbooleanYesIf you want to mute microphone automatically after share.
allow_screen_sharebooleanYesEnable or disable screen share for the meeting.
allow_rtmpbooleanYesEnable or disable RTMP for the meeting.
admin_only_webcamsbooleanYesIf you want to allow webcams only for admin
allow_view_other_webcamsbooleanYesIf you want to disable to display other users camera except moderator.
allow_view_other_users_listbooleanYesIf you want to disable to display users list except moderator.
enable_analyticsbooleanNoEnable/Disable to create analytics report for the session. Later can fetch analytics. Default: false
allow_virtual_bgbooleanNoEnable/disable virtual background option
allow_raise_handbooleanNoEnable/disable raise hand option
room_durationnumberNoIf you want to set fixed room duration. Value should be in minutes. 1 hour = 60 minutes. 0 = unlimited
recording_featuresobjectYesRecording Settings
chat_featuresobjectYesChat Settings
shared_note_pad_featuresobjectYesShared note pad settings
whiteboard_featuresobjectYesWhiteboard settings
external_media_player_featuresobjectYesExternal media player settings
waiting_room_featuresobjectYesWaiting room settings
breakout_room_featuresobjectYesBreakout room settings
display_external_link_featuresobjectYesDisplay external link settings
ingress_featuresobjectNoRTMP ingress feature
speech_to_text_translation_featuresobjectNoSpeech to text/translation features
end_to_end_encryption_featuresobjectNoEnd-to-End encryption (E2EE)

Recording features

is_allowbooleanYesEnable or disable recording feature for the meeting.
is_allow_cloudbooleanYesEnable or disable cloud recording option
is_allow_localbooleanYesEnable or disable local recording option
enable_auto_cloud_recordingbooleanNoIf enable then recording will be starting as soon as moderator/admin join the session

Chat features

allow_chatbooleanYesEnable or disable chat for the meeting.
allow_file_uploadbooleanYesEnable or disable file upload in chat for the meeting.

Shared note pad features

allowed_shared_note_padbooleanYesEnable or disable shared notepad for the meeting.

Whiteboard features

allowed_whiteboardbooleanYesEnable or disable whiteboard for the meeting.
preload_filestringNoYou can preload a remote (http/https) presentation file for the whiteboard. Ensure that it can be fetched directly without being redirected; otherwise, downloading will fail.

External media player features

allowed_external_media_playerbooleanYesEnable or disable to allow to play video/audio from external source. Moderator can upload local video/audio too.

Waiting room features

is_activebooleanYesEnable if you want to activate wating room feature. User will be in waiting room until moderator allow to join.

Breakout room features

is_allowbooleanYesEnable or disable breakout room features.
allowed_number_roomsnumberNoNumber of breakout rooms allowed to create at a same time. Default: 6
is_allowbooleanYesEnable 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.

Ingress features

is_allowbooleanYesIngress RTMP streaming right into the session. This capability is really useful if you want to display external video directly streaming in the session.

Speech to text/translation features

is_allowbooleanYesenable/disable Speech to text feature. This feature will use microsoft azure under the hood. Make sure that you've configured API info correctly.
is_allow_translationbooleanYesIf you want to enable auto translation feature too.

End-to-End encryption (E2EE) features

is_enabledbooleanYesenable/disable E2EE. Supported browsers: browser based on Chromium 83+, Google Chrome, Microsoft Edge, Safari. Firefox: 117+ Note: Users will be unable to join the session if their browser does not support it.

Default lock settings

lock_microphonebooleanNoLock microphone for users.
lock_webcambooleanNoLock webcam for users.
lock_screen_sharingbooleanNoLock screen share for users.
lock_chatbooleanNoLock chat for users.
lock_chat_send_messagebooleanNoLock send message for users.
lock_chat_file_sharebooleanNoLock send file for users.


"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_rtmp": true,
"admin_only_webcams": false,
"allow_view_other_webcams": true,
"allow_view_other_users_list": true,
"allow_polls": true,
"enable_analytics": true,
"allow_virtual_bg": true,
"allow_raise_hand": true,
"room_duration": 0,
"recording_features": {
"is_allow": true,
"is_allow_cloud": true,
"is_allow_local": true,
"enable_auto_cloud_recording": false
"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": 2
"display_external_link_features": {
"is_allow": true
"ingress_features": {
"is_allow": true
"speech_to_text_translation_features": {
"is_allow": true,
"is_allow_translation": true
"end_to_end_encryption_features": {
"is_enabled": false
"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


statusbooleanThe status of the request
msgstringResponse message

Room Info

sidstringRoom sid
namestringRoom Id
max_participantsnumberMaximum participants for this room
empty_timeoutnumberMaximum duration before closing empty room
creation_timenumberRoom creation time in unix time format
turn_passwordstringTurn password
enabled_codecsArrayVideo codecs for this room
metadatastringRoom metadata