Search…
User roles and privileges
Whereby Embedded allows your participants to join a video meeting without creating accounts or logins. If you want some users to have altered privileges in the meeting, you can use different URL types

Hosts

Users joining via the hostRoomURL become meeting hosts and have the following features available:
  • Lock and unlock the room.
  • Remove, mute, and spotlight meeting participants.
  • Enter locked rooms without knocking.
Host privileges are valid immediately on room creation and persist for an hour after the endDate.
A hostRoomURL is only available if the hostRoomURL is included in the fields parameter when creating the room via the API.
Example request body:
1
{
2
"endDate": "2099-03-25T13:30:00.000Z",
3
"fields": ["hostRoomUrl"]
4
}
Copied!
Response:
1
{
2
"meetingId": "1234",
3
"startDate": "2022-03-09T13:50:00.000Z",
4
"endDate": "2099-03-25T13:30:00.000Z",
5
"roomUrl": "https://example.whereby.com/room",
6
"hostRoomUrl": "https://example.whereby.com/room?roomKey=eFhcG...i00ZG"
7
}
Copied!
Now that you have both a roomUrl and a hostRoomUrl, you can ensure that both your guests and hosts get the right privileges by using the corresponding URL when embedding rooms in your own webpage or app.

Viewers

In Viewer Mode, participants joining as Viewers have their camera and microphone disabled by default. Viewers can only interact with Hosts and Speakers by using the Chat.
This is a beta feature and might change in the future.
Meetings created in "group" mode can support up to 100 hosts or participants. Viewer mode can support an additional 400 viewers for a total of 500 viewers, hosts, and participants.
Example request body:
1
{
2
"endDate": "2099-03-25T13:30:00.000Z",
3
"templateType": "viewerMode"
4
}
Copied!
Response:
1
{
2
"meetingId": "1234",
3
"startDate": "2022-03-09T13:50:00.000Z",
4
"endDate": "2099-03-25T13:30:00.000Z",
5
"roomUrl": "https://example.whereby.com/room",
6
"hostRoomUrl": "https://example.whereby.com/room?roomKey=eFhcG...i00ZG"
7
"viewerRoomUrl": "https://example.whereby.com/room?roomKey=eFhcG...VTQIE"
8
}
Copied!
Copy link
Contents
Hosts
Viewers