Skip to content

RingCentral Embeddable 3.1 Beta

3.1.0

RingCentral Embeddable 3.1 brings RingCX contact center calling into Embeddable, a new user interface built on RingCentral's Spring design system, and fax sending. It is rebuilt on a new application framework, while keeping the existing Embeddable events, commands, and third-party service APIs.

Beta Release

Version 3.1 is a BETA release for early testing. Some 3.x features are still being migrated. See Known limitations. We welcome feedback and suggestions.

What's new in 3.1

RingCX support

Agents can now handle RingCX contact center calls in Embeddable, next to their RingEX calls. A new Agent tab lets the agent:

  • Start an agent session with their RingCentral login and choose queues and dial groups
  • Set their working state
  • Make and receive RingCX calls with the integrated softphone
  • Transfer and requeue calls, and submit dispositions
  • Work preview leads
  • Review RingCX call history
  • Follow agent scripts during calls

For developers, RingCX calls use the same events, commands, and third-party service APIs as RingEX calls. The new call.source field tells you which product a call belongs to. Existing callLoggerPath, contactMatchPath, and callLogEntityMatcherPath registrations work for RingCX calls without changes.

To enable it, add enableRingCX=1 to the widget URL. The Agent tab only shows for users who have a RingCX account.

Learn more about RingCX

Read the RingCX integration guide for setup, events, commands, call logging, and migrating from the standalone RingCX Embeddable.

New user interface

The whole widget is redesigned with Spring, RingCentral's new design system, so it matches the latest RingCentral apps.

  • New navigation bar - When there are more than five tabs, the extra tabs move into a More menu, with their unread counts added up on its badge.
  • Detail pages in the side panel - Call details, voicemail, fax, conversations, contacts, call and message logging, compose text and fax, settings pages, HUD, and Smart Notes open as side panel tabs, next to the list you came from.
  • Auto width - The widget widens to fit the side panel content, and folds back when the side panel is closed. Popup windows resize the same way.
  • Call recordings in call details - Recordings are shown in the call details page.
  • Troubleshooting logs - Users can download app logs from Settings to share with support.

Fax sending

Users can now send faxes from the Fax tab. To enable it:

  1. Add the Faxes app scope to your RingCentral app in the Developer Console.
  2. Make sure the user's RingCentral account has fax sending enabled.

The new fax button is hidden when the app does not have the Faxes scope. Users who already signed in need to sign in again after you add the scope.

Getting started with 3.1

Quick setup

Load the 3.1.x build:

Add the following code to your website's header to embed RingCentral Embeddable 3.1:

<script>
  (function() {
    var rcs = document.createElement("script");
    rcs.src = "https://apps.ringcentral.com/integration/ringcentral-embeddable/3.1.x/adapter.js?clientId=YOUR_RINGCENTRAL_CLIENT_ID&enableSideWidget=1&enableRingCX=1"; // (1)!
    var rcs0 = document.getElementsByTagName("script")[0];
    rcs0.parentNode.insertBefore(rcs, rcs0);
  })();
</script>
  1. Replace YOUR_RINGCENTRAL_CLIENT_ID with your actual RingCentral application client ID. Remove enableRingCX=1 if you do not need RingCX.

Add the following iframe anywhere on your webpage:

<iframe 
  width="300" 
  height="500" 
  allow="microphone" 
  src="https://apps.ringcentral.com/integration/ringcentral-embeddable/3.1.x/app.html?clientId=YOUR_RINGCENTRAL_CLIENT_ID&enableSideWidget=1&enableRingCX=1">
</iframe>

Required configuration

Add the following redirect URI to your RingCentral application settings in the Developer Console:

https://apps.ringcentral.com/integration/ringcentral-embeddable/3.1.x/redirect.html

Important

The redirect URI must be added to your RingCentral application configuration, or authentication will fail.

To use fax sending, also add the Faxes app scope. See app registration for the full scope list.

Migrating from 3.x

  1. Update the URL - Change 3.x or latest to 3.1.x in your script or iframe src.
  2. Update the redirect URI - Add the 3.1.x redirect URI to your app settings.
  3. Add the Faxes scope - Optional, needed for fax sending.
  4. Add enableRingCX=1 - Optional, needed for RingCX.
  5. Check boolean parameters - Parameters are now on only when set to 1 or true. Before, values like 0 or false could still turn a feature on.
  6. Test thoroughly - Verify your existing integration works as expected. See Known limitations.

Known limitations

Some 3.x features are still being migrated to 3.1 and will be added in later releases. If a feature or parameter your integration uses does not work yet, please let us know.

Next steps

Online demo RingCX guide