List Active Calls PHP Quick Start

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. Just click the button, enter a name and description if you choose, and click the "Create" button. If you do not yet have a RingCentral account, you will be prompted to create one.

Create Engage Voice App Show detailed instructions

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.

Read Agent Groups for an Engage Voice Account

Install Engage Voice SDK Wrapper for Node JS

$ npm install engagevoice-sdk-wrapper --save

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.

require('vendor/autoload.php');

const RINGCENTRAL_CLIENTID = '<ENTER CLIENT ID>';
const RINGCENTRAL_CLIENTSECRET = '<ENTER CLIENT SECRET>';

const RINGCENTRAL_USERNAME = '<YOUR ACCOUNT PHONE NUMBER>';
const RINGCENTRAL_PASSWORD = '<YOUR ACCOUNT PASSWORD>';
const RINGCENTRAL_EXTENSION = '<YOUR EXTENSION>';

$ev = new EngageVoiceSDKWrapper\RestClient(RINGCENTRAL_CLIENTID, RINGCENTRAL_CLIENTSECRET);
try{
    $resp = $ev->login(RINGCENTRAL_USERNAME, RINGCENTRAL_PASSWORD, RINGCENTRAL_EXTENSION);
    list_account_active_calls($resp->agentDetails[0]->accountId);
}catch (Exception $e) {
    print $e->getMessage();
}

function list_account_active_calls($accountId){
    global $ev;
    $endpoint = "admin/accounts/~/activeCalls/list";
    $params = array (
      'product' => "ACCOUNT",
      'productId' => $accountId
    );
    try{
        $resp = $ev->get($endpoint, $params);
        print ($resp."\r\n");
    }catch (Exception $e) {
        print ($e->getMessage());
    }
}

Run Your Code

You are almost done. Now run your script.

$ node list-active-calls.php

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.