List Active Calls Python 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 Dial Groups for an Engage Voice Account

Install Engage Voice SDK Wrapper for Python

$ pip install engagevoice-sdk-wrapper

Create and Edit list-active-calls.py

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

#### Install Python SDK wrapper ####
# $ pip3 install ringcentral_engage_voice
#  or
# $ pip install ringcentral_engage_voice
#####################################
from ringcentral_engage_voice import RingCentralEngageVoice

def list_active_calls():
    try:
        params = "product=ACCOUNT&productId={accountId}"
        response = ev.get("/api/v1/admin/accounts/{accountId}/activeCalls/list", params).json()
        print(response)
    except Exception as e:
        print(e)


# Instantiate the SDK wrapper object with your RingCentral app credentials
ev = RingCentralEngageVoice(
    "RINGCENTRAL_CLIENTID",
    "RINGCENTRAL_CLIENTSECRET")

try:
    # Authorize with your RingCentral Office user credentials
    ev.authorize(
        username="RINGCENTRAL_USERNAME",
        password="RINGCENTRAL_PASSWORD",
        extension="RINGCENTRAL_EXTENSION"
    )

    list_active_calls()
except Exception as e:
    print(e)

Run Your Code

You are almost done. Now run your script.

$ python list-active-calls.py

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.