Configuring RingCentral Embeddable
Listed below are all supported parameters that can be configured for RingCentral Embeddable. For those parameters that warrant greater explanation a link has been provided to content where you can learn more about using the parameter properly.
Parameter | Default | Description |
---|---|---|
appServer |
production | Sets the environment in which Embeddable will run. See Setting your environment. |
authorizationCode |
null | See Alternative auth methods. |
authorizationCodeVerifier |
null | See Alternative auth methods. |
clientId |
null | Sets the client Id credential of your Embeddable application. Useful in removing the FOR DEMO PURPOSES ONLY banner. See Using a custom client ID. |
clientSecret |
None | Deprecated. Sets the client secret of your application when using Authorization code grant type. See Alternative auth methods. |
defaultCallWith |
browser |
See Calling features. |
defaultDirection |
right |
Allowed values are "left" and "right". See Embeddable Badge. |
disableMessages |
False | Disable messages feature. |
disableReadText |
False | Disable SMS and read text feature. |
disableCall |
False | Disable call-related features. |
disableCallHistory |
False | Disable call history. |
disableContacts |
False | Disable contacts feature. |
disableMeeting |
False | Disable meeting feature. |
disableGlip |
True | Before we start to use Glip API, need to add Glip or Team Messaging permission to your app in RingCentral Developer website. Also, for testing with a sandbox user, user needs to first login to https://app.devtest.ringcentral.com |
disableMinimize |
False | By default, we provide Minimize button at app header to minimize the widget. |
disconnectInactiveWebphone |
False | See Working with multiple tabs. |
enableAnalytics |
False | See Custom analytics. |
enableNoiseReductionSetting |
False | See Noise reduction. |
enablePopup |
False | See Customize pop-up window. |
enableRingtoneSettings |
False | For when call is ringing, app will play default ringtone. But we also support to customize ringtone. By enabled, user can get ringtone settings at settings page. Supported after v1.6.3 |
enableSMSTemplate |
False | See SMS templates. |
jwt |
None | See Alternative auth methods. |
multipleTabsSupport |
False | See Working with multiple tabs. |
newAdapterUI |
False | See Embeddable Badge. |
popupPageUri |
null | See Customize pop-up window. |
prefix |
null | See Customize prefix. |
redirectUri |
null | See Customize redirectUri. |
showSignUpButton |
False | |
stylesUri |
null | See Customize look and feel through CSS. |
userAgent |
null | See Customize X-User-Agent. |
enableAudioInitPrompt |
null | See Audio. |
enableLoadMoreCalls |
null | Support to load old call history (more than 7 days). Supported from v2.1.0 |