Using URL parameters

With Whereby Embedded you can use URL parameters to customize the meeting experience for your users. It’s possible for each participant in a meeting to have different parameter combinations.

URL parameters are added to the roomURL when embedding a room in your web page or app.

Several parameters can be combined by using the ampersand symbol (&). For instance, the following URL parameters would open the room with the screenshare and people buttons hidden:

https://subdomain.whereby.com/room?screenshare=off&people=off

URL parameters

Property details

?aec=off

Turn off acoustic echo cancellation on audio.

Note: AEC must be on in order to use the in room "Noise Reduction" feature.

Use case: In situations where clearer audio is required, like music lessons, disabling echo cancellation can improve audio clarity overall.

?agc=off

Turn off automatic gain control on audio.

Note: AGC must be on in order to use the in room "Noise Reduction" feature.

Use case: In situations where clearer audio is required, like music lessons, disabling gain control can improve audio clarity overall by not auto adjusting volumes.

?audio=off

Participants join the meeting with their microphone off, they can turn it on whenever they want.

Use case: A presentation is being given in a big meeting where attendees are not expected to participate verbally.

?audioDenoiser=<on|off>

Enables/Disables the noise cancelation feature (disabled by default).

Note: Can increase CPU load, particularly for older/slower devices Use case: Apply this parameter to manually enable/disable our built-in noise cancelation feature. This is useful in environments with significant background noise.

?autoHideSelfView

Automatically hide the local users self view in the bottom right of the room. Self view can still be viewed with hovering and selecting arrow icon

Note: Floating the self view to the bottom right is required in order to hide the self view. So you must use ?floatSelf&autoHideSelfView together for this feature to work.

?autoSpotlight

Automatically spotlight the local participant on room join.

Note: Only works when the participant joining has host privileges. Use case: Apply this parameter to ensure focus is directed at the local participant by spotlighting them. The spotlight ensures everyone else in the meeting has a bigger view of this participant.

?avatarUrl=<url>

Set the avatar / profile picture of the participant instead of the automatically assigned name initials. The image can be a .png or .jpeg, and must be a square maximum of 64x64.

Note: You must make sure to list the origin of the image URL in the allowed domains section of the dashboard. The image URL must be https and cannot contain query params.

?background=off

Hide the default meeting background.

Use case: Hiding the meeting background allows the meeting to appear more integrated by allowing the app or service’s branding shine through as the new background.

?bottomToolbar=<on|off>

Show/hide the entire bottom tool bar.

User case: Hiding the bottom toolbar entirely can be useful in cases where you are hoping to control in room items like camera or microphone via your own websites UI. This can be achieved when embedding Whereby with our Web Component.

?breakout=<on|off>

Show/hide the Breakout Groups feature for the meeting host.

Use case: Combine bigger meetings with smaller, collaborative sessions. Your hosts can start breakout sessions where participants are split into smaller groups.

?cameraAccess=<on|off>

Whereby will not request access to participants' cameras when this is set to off, and there are no video controls.

Use case: A voice-only meeting where attendees are not expected to show themselves on camera.

?cameraEffect=<effect>

Set the default camera effect to be used.

Values: slight-blur, blur, image-cabin, image-concrete, image-brick, image-sunrise, image-day, image-night

Use case: For some users it can be nice to set a camera effect without user interaction. This might be to improve the user experience or set a background for privacy concerns.

?chat=<on|off>

Show/hide the chat button. Messages are not stored after the meeting has ended.

?displayName=<name>

Set the display name for a participant instead of prompting the user for this information.

This supports any characters except code characters $!<>:; and can be up to 100 characters long. Strings not in this format will be rejected and the user will be prompted to enter a different display name instead.

Use case: A participant’s name may be known before they join the meeting. Including this information as a parameter will save the user from entering their name again.

?externalId=<id>

Pass in a custom identifier for the participant. This will be propagated through and returned in Insights API requests and webhook data.

This supports alphanumeric characters (A-Za-z0-9-_) and can be up to 36 characters long. Strings not in this format will be rejected and return an error. We recommend the UUID v4 format.

Use case: Passing in the participant's ID used on a different platform to more easily retrieve & search through usage and insight data later on.

?floatSelf

Float the self view to the bottom right.

Use case: Floating the self view to the bottom right maximizes the space for other meeting participants.

?groups=Orange,Banana,Coconut

Predefine up to 20 groups for the breakout groups function.

Use case: Setting up groups ahead of time can save the host time during the meeting. Hosts will still be able to modify the group setup during the session using the in-room controls if needed.

?lang=<code>

Set the meeting UI language to match your product or service. Select from either English en, French fr, Italian it, German de, Norwegian nb, Danish da, Dutch nl, Portuguese pt, Polish pl, Spanish es, Hindi hi, Czech cs, Chinese (Complex) zh-hant or Japanese jp.

?leaveButton=off

Hide the leave button.

Use case: Can be used if you want to control the leave flow in other ways, like adding a custom link or button outside the embedded room to control what happens when users leave the call.

?localization=off

Hide the language picker.

Use case: Can be used to hide the language picker in the upper right portion of the pre-call flow, as well as room settings. This can be helpful if a specific language is desired in your app experience.

Note: Hiding the localization options means the user will not be able to change their language preference.

?locking=off

Hide the room lock button.

Use case: When set to off the lock button won’t be displayed in the room header. Also, hosts won’t be able to lock/unlock the room through the settings menu or the keyboard shortcut.

?logo=off

Hide the logo in the room header.

Use case: Control whether or not your company logo is displayed in the room header.

?lowData=<on|off>

Use a lower resolution by default

Use case: In some situations for users with poor network connections or devices with CPU constraints, it can be helpful to have lower resolution video feeds loading on the call. This can alleviate problems for users reporting issues with choppy video/audio or connecting to rooms.

?metadata=<string>

Can be used to pass any URL-encoded string so that it is included in the corresponding webhooks. The decoded string has a limit of 512 characters.

Use case: Set it to the user’s ID so that you can easily track through webhooks when a particular user joins or leaves a room.

?minimal

The minimal parameter applies a combination of UI adjustments to simplify the embedded meeting interface.

Hidden items: Status bar, chat button, screensharing button, leave button, and Whereby’s branding.

Shown items: Video, audio, and people buttons.

For further adjustments, additional parameters can be combined with ?minimal. For example ?minimal&chat=on will show the chat button.

?moreButton=off

Hide the “…” button.

Use case: Control whether or not the “…” button is displayed in the room header.

?screenshare=<on|off>

Show/hide the screensharing button for the meeting participant.

Screensharing is available on all browsers that support this natively. Currently no mobile browsers support screensharing.

?participantCount=off

Hide the participant counter.

Use case: Will display the current and maximum number of participants in the room, e.g. “2/4” or “13/200”.

?people=off

Hide the people button.

Use case: The people button shows the participant list, which can be useful for bulk management of participants in bigger meetings.

?pipButton=off

Hide the Picture in Picture button.

Use case: Control whether or not the Picture in Picture button is displayed in the room header. Picture in Picture lets you pop out your meeting guests’ faces while browsing other tabs or applications.

?precallCeremony=<on|off>

Determines if users see the pre-call device and connectivity test.

Note: This feature is a subset of the Pre-call review. This means in order for the pre-call tests to appear, pre-call cannot be turned off.

Use case: The pre-call test will provide users a test of each device; camera, microphone, and speakers, before joining the room. It will also run a connectivity test to assess the reliability of the participants network. This can be skipped by setting this parameter to “off”.

?precallCeremonyCanSkip=on

Adds functionality for participants to also skip the connectivity test. Hosts are already able to skip the test.

Note: This feature is a subset of the Pre-call review. This means in order for the pre-call tests to appear, pre-call cannot be turned off.

Use case: You have users without host privileges who will be attending multiple calls on your platform using Whereby. They may not need to test their device connectivity as often as they attend calls, so may be useful to give them the ability to skip the test.

Specify custom help link on the pre-call review step pointing users to additional support pages. This parameter should only be applied when pre-call review is enabled. This preference can also be set globally via the Dashboard.

Use case: Apply this parameter to point users with camera or mic permission problems to bespoke help pages published on your own domain and brand, rather than to Whereby's help docs.

?precallReview=<on|off>

Determines if users see the pre-call review step.

Use case: The pre-call review step will allow users to check their video/audio settings before joining the room, but this can be skipped by setting this parameter to “off”.

?roomIntegrations

Integrations are disabled for Whereby Embedded by default while using the ?minimal parameter. We set this by default because Content Security Policy restrictions can sometimes cause integrations to fail in unexpected ways. Currently only our YouTube and Miro integrations will work in an embedded setting.

It is recommended you do testing to verify these integrations behave as expected before releasing to your users.

?settingsButton=off

Hide the settings button.

Use case: Control whether or not the settings button is displayed in the room header.

?skipMediaPermissionPrompt

Skips the request permissions UI and asks for devices

Use case: This parameter will prevent the "Request Permissions" step during the pre-call phase and cause the browser to automatically request device permissions (if requested in the iFrame). This flag is required for Android app integration.

?subgridLabels=<on|off>

Used to toggle name labels for the participants in the subgrid.

Use case: Set this to “on” to show name labels for the participants that are rendered as small tiles in the subgrid. Makes it easier to distinguish participants with their camera off.

?timer=<on|off>

Show/hide the meeting timer within the room.

Use case: Set this to “on” to have the meeting timer be displayed in the room. When set to “off”, room hosts can still activate the meeting timer from the “…” button, unless this button has been hidden via the ?minimal or ?moreButton=off parameters.

?toolbarDarkText

Sets button icon labels color to black.

Use case: Helpful if you've either added a light background image to your room, or have turned off the background with ?background=off parameter and are embedding on a light colored web page.

?topToolbar=<on|off>

Used to toggle the entire top toolbar on/off.

Use case: When using the minimal parameter, the top toolbar is hidden along with many other UI elements. Using topToolbar=on will cause the top toolbar to display, which is required if you want to enable breakout groups using breakout=on.

?video=off

Participants join the meeting with their camera off, they can turn it on whenever they want.

Use case: A sales representative showcasing a product to a customer relaxing at home.

?virtualBackgroundUrl=<url>

Specify a image url to use as the virtual background for the participant. The image must be provided in 1280x720 resolution in either image/jpeg or image/png format. In addition, the image should be retrievable using CORS.

Last updated