githubEdit

Waiting Rooms

Waiting rooms are a great way for your hosts to manage meeting access with ease.

Participants "knock" at the virtual door and hosts can allow entry, decline, or even send messages to communicate a delay.

Setup

You can create a waiting room experience for your participants by making sure the room is created as locked during the API request. You do this by setting the isLocked property to true:

circle-exclamation
// Example Request
{
  "isLocked": true,
  "roomNamePrefix": "waiting-room-example-",
  "roomNamePattern": "uuid",
  "roomMode": "group",
  "endDate": "2024-07-05T18:10:34.695Z",
  "fields": [
    "hostRoomUrl"
  ]
}
// Example Response
{
  "startDate": "2024-06-21T18:10:35.056Z",
  "endDate": "2024-07-05T18:10:34.695Z",
  "roomName": "/waiting-room-example-546f6c91-74b2-4597-b32a-6aeefa9ed90f",
  "roomUrl": "https://subdomain.whereby.com/waiting-room-example-546f6c91-74b2-4597-b32a-6aeefa9ed90f",
  "meetingId": "87673375",
  "hostRoomUrl": "https://subdomain.whereby.com/waiting-room-example-546f6c91-74b2-4597-b32a-6aeefa9ed90f?roomKey=eyJhbGciOiJIU..."
}

Managing the waiting room experience

After you've created a locked room, there are a variety of ways you can customize the experience:

  1. Choose the device review options that hosts and participants experience during the pre-call phase. We offer standard device reviews or full device and connectivity tests. These options can be managed globally via the dashboardarrow-up-right or various URL parametersarrow-up-right

  2. Add a unique background image for the waiting room precall flow with our API endpoint

Additional Information

End User Experience

When a participant knocks at a locked room, hosts receive a notification in the room. They can they choose to "Put on hold" and include a message, "Let in", or "Reject":

Host controls seen in the "People" tab

Users are then notified from the host, or let into the room accordingly:

Known Limitations

  • Due to privacy and security considerations, we have removed the ability for hosts to see the video feed of the guest who knocked in the Waiting Room.

Last updated

Was this helpful?