List Active Calls JavaScript Quick Start

Last updated: 2021-05-12Contributors
Edit this page

Welcome to the Engage Voice Platform. In this Quick Start, we are going to read a list of active calls from an account. Let's get started.

Create an App

The first thing we need to do is create an app in the RingCentral Developer Portal. This can be done quickly by clicking the "Create Engage Voice App" button below, click the "Next" button on the app creation dialog and click the "Create" button. If you do not yet have a RingCentral account, you will be prompted to create one. If you have done this step from another quick start example, you can skip this app creation step.

Create Engage Voice App

  1. Login or create an account if you have not done so already.
  2. Go to Console/Apps and click 'Create App' button.
  3. Give your app a name and description, then click Next.
  4. On the second page of the create app wizard enter the following:
    • Select 'Private' for Application Type.
    • Select 'Server-only (No UI)' for Platform Type.
  5. On the third page of the create app wizard, select the following permissions:
    • ReadAccounts
  6. We are using Password Flow authentication, so leave "OAuth Redirect URI" blank.

When you are done, you will be taken to the app's dashboard. Make note of the Client ID and Client Secret. We will be using those momentarily.

Install Engage Voice SDK Wrapper for Node JS

$ npm install ringcentral-engage-voice-client

Create and Edit list-active-calls.js

Create a file called list-active-calls.js. Be sure to edit the variables in ALL CAPS with your app and user credentials.

const RunRequest = async function () {
    const EngageVoice = require('ringcentral-engage-voice-client').default

    // Instantiate the SDK wrapper object with your RingCentral app credentials
    const ev = new EngageVoice({
        clientId: "RINGCENTRAL_CLIENTID",
        clientSecret: "RINGCENTRAL_CLIENTSECRET"

    try {
        // Authorize with your RingCentral Office user credentials
        await ev.authorize({
            username: "RINGCENTRAL_USERNAME",
            extension: "RINGCENTRAL_EXTENSION",
            password: "RINGCENTRAL_PASSWORD"

        // Get Active Calls
        const endpoint = "/api/v1/admin/accounts/{accountId}/activeCalls/list?product=ACCOUNT&productId={accountId}"
        const response = await ev.get(endpoint)
    catch (err) {


Run Your Code

You are almost done. Now run your script.

$ node list-active-calls.js

Need Help?

Having difficulty? Feeling frustrated? Receiving an error you don't understand? Our community is here to help and may already have found an answer. Search our community forums, and if you don't find an answer please ask!

Search the forums »

What's Next?

When you have successfully made your first API call, it is time to take your next step towards building a more robust Engage Voice application.