Embed Parameters

This is legacy documentation. We are no longer onboarding new Gruveo for Developers customers.

This section lists the parameters that can be passed to the Gruveo embed. The clientid parameter is required. Please refer to the Embedding the Widget section for more information.

chatSpecifies the behavior of the text chat. The accepted values are:

  • 0 – Disable the text chat functionality in the embed.
  • 1 – Make the chat sidebar closed initially. The user will need to click a controlbar button to open the chat.
  • 2 – Make the chat sidebar open initially. Has no effect for embed widths less than 1000 px.

The default value is 1.

chromelessAllows to specify a chromeless mode for the embed. The accepted values are:

  • 0 – The code input, the room name / Gruveo handle being called, as well as the in-call controls are shown.
  • 1 – The code input, the room name / Gruveo handle being called, as well as the in-call controls (including the recording indicator) are not shown.
  • 2 – The code input and the room name / Gruveo handle being called are not shown. The in-call controls and the recording indicator are shown.

The default value is 0.

clientidYour unique Gruveo API client identifier that you get as part of your API access credentials.
codeSpecifies the room name or Gruveo handle to pre-populate in the embed and makes the code field read-only for the user. For example: mycode123 or @hello
colorSpecifies a solid background color of the start screen. Format: Hexadecimal color code without a #, for example: 63b2de. If not supplied, then Gruveo’s default mountains landscape is used for the background.
enableedgesupportSetting the parameter’s value to 1 enables experimental support for the Microsoft Edge browser. Default value: 0
iosappurlThis parameter defines the App Store URL of the app, if any, that the users will be offered to download when attempting to use the embed on older versions of iOS (< 11.3). If this parameter is not supplied, such users will be shown a generic “your iOS version is not supported” message.
languageSpecifies the language of the embed. Format: ISO 639-1 code, for example: pl

Currently supported values: de, en, es, fr, ja, it, ko, nl, pt, ru, uk, zh. If this parameter is omitted, the embed will try to use the best matching language for each user.

Revision History

September 29, 2021

  • Clarified the behavior when the color parameter is not supplied.

January 7, 2019

  • If the iosappurl parameter is not supplied, the embed will now display a generic “your iOS version is not supported” message to iOS < 11.3 users (instead of prompting them to download the Gruveo app).

November 14, 2018

  • Deprecated the branding parameter.

January 16, 2018

  • Recording indicator is now hidden when the chromeless parameter is set to 1.

November 27, 2017

  • Added the enableedgesupport parameter for enabling experimental MS Edge support.
  • Added the iosappurl parameter for setting the App Store URL of the companion iOS app.

November 3, 2017

  • Extended the chromeless parameter with the value of 2 for keeping the in-call controls.

October 30, 2017

  • Extended the chat parameter with the value of 0 for disabling the text chat.

July 25, 2017

  • Removed the no longer used generated and signature parameters.
  • Updated the list of the currently supported values for the language parameter.

July 21, 2016

  • Added the branding parameter for disabling the Gruveo branding in the embed.
  • Added the chromeless parameter for activating the chromeless mode.
  • The API signing schema now uses the clientid parameter for identifying the API client.

May 2, 2016

  • Added the chat parameter for specifying whether the chat sidebar should be open or closed initially.

April 19, 2016

  • Supplying the code parameter now makes the code field in the embed read-only for the user.

March 14, 2016

  • The list of supported values for the language parameter has been extended to include values for Chinese (Simplified), Czech, Dutch, Finnish, Japanese and Korean.

December 22, 2015

  • The Insert a Gruveo Embed in Your Page section has been updated to note that Gruveo will not work if embedded in a non-secure HTTP page.

October 19, 2015

  • Initial version.