Create room

End point: /room/create

Request parameters

Field	Type	Required	Description
room_id	string	Yes	Room Id should be unique for every room/session/meeting
max_participants	number	No	Limit number of participants that can be join in this room.
empty_timeout	number	No	Number of seconds to keep the room open if no one joins
metadata	object	Yes

Metadata

Field	Type	Required	Description
room_title	string	Yes	Title of the room/meeting
welcome_message	string	No	If you want to show some message at start up.
webhook_url	string	No	You can put webhook URL in where plugNmeet will send post request based on various events.
logout_url	string	No	You can put logout URL in where plugNmeet will redirect the users after meeting/session ended.
room_features	object	Yes	Various room features.
default_lock_settings	object	No	Default lock settings
copyright_conf	object	No	Copyright config
extra_data	string	No	You can store extra data.

Room Features

Field	Type	Required	Description
allow_webcams	boolean	Yes	If you want to enable webcam support.
mute_on_start	boolean	Yes	If you want to mute microphone automatically after share.
allow_screen_share	boolean	Yes	Enable or disable screen share for the meeting.
allow_rtmp	boolean	Yes	Enable or disable RTMP for the meeting.
admin_only_webcams	boolean	Yes	If you want to allow webcams only for admin
allow_view_other_webcams	boolean	Yes	If you want to disable to display other users camera except moderator.
allow_view_other_users_list	boolean	Yes	If you want to disable to display users list except moderator.
enable_analytics	boolean	No	Enable/Disable to create analytics report for the session. Later can fetch analytics. Default: false
allow_virtual_bg	boolean	No	Enable/disable virtual background option
allow_raise_hand	boolean	No	Enable/disable raise hand option
auto_gen_user_id	boolean	No	The system will automatically generate a user_id for each participant if the value is set to true. In this instance, any supplied user_id will be ignored, and the value will be stored in ex_user_id. Default: false
room_duration	number	No	If you want to set fixed room duration. Value should be in minutes. 1 hour = 60 minutes. 0 = unlimited
recording_features	object	Yes	Recording Settings
chat_features	object	Yes	Chat Settings
shared_note_pad_features	object	Yes	Shared note pad settings
whiteboard_features	object	Yes	Whiteboard settings
external_media_player_features	object	Yes	External media player settings
waiting_room_features	object	Yes	Waiting room settings
breakout_room_features	object	Yes	Breakout room settings
display_external_link_features	object	Yes	Display external link settings
ingress_features	object	No	RTMP ingress feature
speech_to_text_translation_features	object	No	Speech to text/translation features
end_to_end_encryption_features	object	No	End-to-End encryption (E2EE)

Recording features

Field	Type	Required	Description
is_allow	boolean	Yes	Enable or disable recording feature for the meeting.
is_allow_cloud	boolean	Yes	Enable or disable cloud recording option
is_allow_local	boolean	Yes	Enable or disable local recording option
enable_auto_cloud_recording	boolean	No	If enable then recording will be starting as soon as moderator/admin join the session

Chat features

Field	Type	Required	Description
allow_chat	boolean	Yes	Enable or disable chat for the meeting.
allow_file_upload	boolean	Yes	Enable or disable file upload in chat for the meeting.

Shared note pad features

Field	Type	Required	Description
allowed_shared_note_pad	boolean	Yes	Enable or disable shared notepad for the meeting.

Whiteboard features

Field	Type	Required	Description
allowed_whiteboard	boolean	Yes	Enable or disable whiteboard for the meeting.
preload_file	string	No	You 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

Field	Type	Required	Description
allowed_external_media_player	boolean	Yes	Enable or disable to allow to play video/audio from external source. Moderator can upload local video/audio too.

Waiting room features

Field	Type	Required	Description
is_active	boolean	Yes	Enable if you want to activate wating room feature. User will be in waiting room until moderator allow to join.

Breakout room features

Field	Type	Required	Description
is_allow	boolean	Yes	Enable or disable breakout room features.
allowed_number_rooms	number	No	Number of breakout rooms allowed to create at a same time. Default: 6

Display external link features

Field	Type	Required	Description
is_allow	boolean	Yes	Enable 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

Field	Type	Required	Description
is_allow	boolean	Yes	Ingress 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

Field	Type	Required	Description
is_allow	boolean	Yes	enable/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_translation	boolean	Yes	If you want to enable auto translation feature too.

End-to-End encryption (E2EE) features

Field	Type	Required	Description
is_enabled	boolean	Yes	enable/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.
included_chat_messages	boolean	No	enable/disable E2EE for chat messages.
included_whiteboard	boolean	No	enable/disable E2EE for whiteboard messages (SCENE_UPDATE, POINTER_UPDATE). This may use more CPU for the user end, do not enable it unless really necessary

Default lock settings

Field	Type	Required	Description
lock_microphone	boolean	No	Lock microphone for users.
lock_webcam	boolean	No	Lock webcam for users.
lock_screen_sharing	boolean	No	Lock screen share for users.
lock_chat	boolean	No	Lock chat for users.
lock_chat_send_message	boolean	No	Lock send message for users.
lock_chat_file_share	boolean	No	Lock send file for users.

Copyright config

This will only work if server's config client > copyright_conf > allow_override has been set true.

Field	Type	Required	Description
display	boolean	Yes	Enable or disable display copyright text
text	string	Yes	Do not make the text longer, supported html tags are: b, i, em, strong, a

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_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,
      "auto_gen_user_id": false,
      "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
    }
  }
}

Response

Field	Type	Description
status	boolean	The status of the request
msg	string	Response message
room_info	object