Skip to main content

Join room

End point: /room/getJoinToken

FieldTypePositionRequiredDescription
room_idstringrootYesRoom Id that you created before to join.
user_infostringrootYes
namestringuser_infoYesUser name
user_idstringuser_infoYesUser unique ID. Should be unquie for every user.
is_adminbooleanuser_infoYesIf true then user will be treated as an admin for this room.
is_hiddenbooleanuser_infoYesIf true then user will be invisible in the room.
user_metadatastringuser_infoYes
profile_picstringuser_metadataNOIf you want to set user's avatar. Should be https URL.
lock_settingsstringuser_metadataNO
lock_microphonebooleanlock_settingsNOLock microphone for users.
lock_webcambooleanlock_settingsNOLock webcam for users.
lock_screen_sharingbooleanlock_settingsNOLock screen share for users.
lock_chatbooleanlock_settingsNOLock chat for users.
lock_chat_send_messagebooleanlock_settingsNOLock send message for users.
lock_chat_file_sharebooleanlock_settingsNOLock send file for users.

Example:

{
"room_id": "room01",
"user_info": {
"name": "Your name",
"user_id": "Your-Unique-User-Id",
"is_admin": true,
"is_hidden": false,
"user_metadata": {
"profile_pic": "https://profile.pic/im.jpg",
"lock_settings": {
"lock_microphone": false,
"lock_webcam": false,
"lock_screen_sharing": true,
"lock_chat": false,
"lock_chat_send_message": false,
"lock_chat_file_share": false
}
}
}
}

Response

FieldTypePositionDescription
statusbooleanrootThe status of the request
msgstringrootResponse message
tokenstringrootJoin token

When you'll receive token during that time you can pass that token to plugNmeet-client. If you've setup it with plugNmeet-server then:

https://Your-Plug-N-Meet-Server.com/?access_token=<TOKEN HERE>

If you are using plugNmeet-client build static files in somewhere else then you'll require to pass token like that too. For example you've uploaded build static files inside conference directory. In this case:

https://Your-Domain.com/conference/?access_token=<TOKEN HERE>

Custom design

It's possible to add extra query parameter custom_design with the join link. This way you can use seperate design for indivisual user. The value of custom_design will need to be url encoded json value. You can view supported parameters from design-parameters. Example:

https://Your-Domain.com/conference/?access_token=<TOKEN HERE>&custom_design=%7B%22primary_color%22%3A%22%23004D90%22%2C%22secondary_color%22%3A%22%2324AEF7%22%7D