RingCX Embeddable 1.0 (BETA)

This is a beta release. We welcome your feedback and bug reports — please feel free to open an issue.

Looking for the 0.x beta version? Please visit the legacy branch and its demo.

Upgrading from 0.x? See the migration guide.

Introduction

This is an out-of-the-box embeddable web application that help developers to integrate RingCentral RingCX services to their web applications with few code.

Visit Online

Visit website and login with RingCX account to get online demo.

Inject

<script>
  (function() {
    var rcs = document.createElement("script");
    rcs.src = "https://cdn.labs.ringcentral.com/ringcx-embeddable/1.0.0/adapter.js";
    var rcs0 = document.getElementsByTagName("script")[0];
    rcs0.parentNode.insertBefore(rcs, rcs0);
  })();
</script>

Documents

• Migrating from 0.x (Legacy) to 1.0 (Beta)
• Get Started
• Customize Client ID and environment
• Customize Redirect Uri
• Customize Authorization
• API
• Message Transport
• Call Events
• Popup a standalone widget

Supported features

• Agent states
• Voice queues
• Dial modes
  • Manual
  • Predictive dial mode
  • Preview dial mode
• Corporate directory search for dialing
• Call disposition
  • Notes
  • Disposition
  • AI Summary

Unsupported features:

• Dial modes:
  • Preview dial mode with search
  • HCI dialing
  • Progressive dial mode
• Agent scripts

Contribution and Development

Clone the code

$ git clone https://github.com/ringcentral/engage-voice-embeddable.git

Create a free RingCentral app

1. Create a RingCentral developer free account
2. Create a RingCentral app with platform type - "Browser Based"
3. Add permissions Read Accounts to your app.
4. Add redirect uri http://localhost:8080/redirect.html to your app settings.

Create environment variables file in project root path

Create .env file in project root path:

RINGCENTRAL_CLIENT_ID=your_ringcentral_app_client_id
RINGCENTRAL_SERVER=https://platform.ringcentral.com

ENGAGE_VOICE_AUTH_SERVER=https://engage.ringcentral.com

Notice: Now the RingCX service only is supported on production environment. Please make sure your key is graduated into RingCentral production environment.

Start development server

We assume you have pre-installed node.js >= 20 and npm.

We have a package-lock.json file in source code to lock dependency versions. Use npm ci to install dependencies with the exact locked versions that work well with this project.

$ npm ci      # install dependencies with locked versions
$ npm start   # start a webpack dev server

Open site: 'http://localhost:8080/' on browser

Deploy on production

If you create pull request to this repository and get merged, CI will deploy it to this repository's github page automatically. But for something that customized, you can deploy it to your own web space, such as your github page.

1. Update .env file in production environment
2. Run command to compile code and build release

$ HOSTING_URL=your_host_url npm run build

Please replace your_host_uri with your own web host address, such as https://ringcentral.github.io/engage-voice-embeddable.

3. Upload all files in build/rc folder to your web space. And visit it in browser.
4. Add redirect uri ${your_host_url}/redirect.html to your RingCentral client ID in RingCentral developers portal