RingCentral Integration

Owned by Tamara Khanieva (Unlicensed)
Last updated: Apr 25, 2024 by Artemiy Firsov
4 min read

 The integration with the RingCentral consists of the following steps:

  1. Creating and configuring the RingCentral application

  2. Configuring the connector to work with the RingCentral application

  3. Distributing license among the users

  4. Provisioning of the connection configuration for the users (the process is described in User Guide) 

Configuring RingCentral

Prerequisites

  • An active RingCentral account

  • The administrative access to the developer console (to create private RC applications) 

Settings

Make sure your app has the following properties set, otherwise you'll get errors.

WebRTC enables dialing out and you need to be attached to an extension to use this capability. You can configure this in the Online Web Portal for Production (https://service.ringcentral.com/) and Sandbox (https://service.devtest.ringcentral.com/) accounts. You can find more information on the Digital Lines and their configuration in the following RingCentral Knowledge Base article topics:

  1. Digital Line Overview (KB 5862) - RingCentral DigitalLine Overview

  2. Adding a Digital Line (KB 3136). - The application should have an allocated Digital Line. A limited number of Digital Lines are free with each sandbox account and can be configured with the free RingCentral for Desktop softphone. - http://success.ringcentral.com/articles/RC_Knowledge_Article/5-10-Adding-Phones-to-other-extensions-via-Web

  3. Reassigning an Existing Digital Line (KB 3748) - http://success.ringcentral.com/articles/en_US/RC_Knowledge_Article/How-to-Assign-an-Existing-Digital-Line-to-a-different-extension

These permissions are configured for your app in the RingCentral Developer Portal (https://developers.ringcentral.com/). Fill in the Registration Form (https://goo.gl/sPsrXN) to get access to the WebRTC permissions. Please contact devsupport@ringcentral.com to request these permissions.

Setting Up the Integration

  1. Go to the RingCentral Developers Console and create the Application there:

    1. Click [Create App] (Fig. 1)

Fig. 1. Creating an Application

image-20240425-063120.png



b. Choose [Rest API App] for the Application type and click the "Next" button (Fig. 2)

Fig. 2. Choosing the Application type

image-20240425-063257.png



c. Enter the application name and add the description (Fig. 3)

Fig.3. Entering the application name and adding the description

d. Add the Primary Contact (Fig. 4)

e. Choose [No] for the promotion (Fig. 4)

f. Choose Type of app for calling the API (Fig. 4)

Fig.4. Adding the primary contact, promotion and choosing type of app for calling the API 

image-20240425-063357.png

 

g. Configure the OAuth Redirect URLs (OAuth Redirect URLs should be written according to the following format: https://<Creatio instance domain>/0/rest/VvtAuthorizeService/callback (Fig.5)

h. Choose [Yes] for refresh tokens (Fig.5)
i. Add the permissions - VoIP Calling, Read Accounts, Read Call Log, Read Messages, Read Presence, Edit Presence, WebSocket, WebSocket Subscriptions, Webhook Subscriptions (Fig.5)
j. Set the access to be private for your application (Fig.5)

Fig. 5. Configuring the permissions and the Redirect URLs, refreshing tokens and choosing the access to the application

Screenshot 2024-04-25 at 14.46.58.png

  1. After that you will be presented with the following screen, on which you should click the “OK“ button
    Fig. 5. Success App Create Screen

Screenshot 2024-04-25 at 14.52.31.png

  1. Once done, the following screen will conform that Production Environment credentials are available (Fig. 6).

Fig. 6. Application page

Screenshot 2024-04-25 at 14.52.53.png

  1. Sign in to Creatio as an admin to be able to configure the application

  2. Go to the [System Settings] -> [Telephony] (Fig. 7)

Fig. 7. Opening Telephony setting folder

Screenshot 2024-04-25 at 14.59.18.png

  1. Click the [Default Messages exchange library], and click [Open] (Fig. 8)

Fig. 8. Opening the Default Messages exchange library section

Screenshot 2024-04-25 at 15.00.36.png

  1. Make sure that [Telephony integration library based on Velvetech protocol] is set as a default value

  2. Return to the previous page, open the [Velvetech] (Fig. 9) setting folder

Fig. 9. Opening Velvetech setting folder

Screenshot 2024-04-25 at 15.01.34.png

  1. Open [RC platform: Production] and make sure that the Default value is checked

  2. Open [RC Client Id] and fill in the Default value field, with the Client ID from the Production Environment in RingCentral’s [Credentials] section (Fig. 10)

Fig. 10. Copying the Client ID from the Production Environment in the RingCentral’s [Credentials] section

image-20240425-084510.png

  1. Open the [RC Client Secret] and fill in Client Secret in the [Credentials] section's Default value field (Fig. 11).

Fig. 11. Copying the Client Secret from the Production Environment in the RingCentral’s Credentials section

  1. Now, you can distribute the licenses among the users who need to be connected with the RingCentral (see License Purchasing section)

  2. Sign out from the admin account in the Creatio

  3. To create users follow this instruction from the RingCentral - https://support.ringcentral.com/article/11683-Add-Users-Extensions-and-assign-RingCentral-Phone-app-RingCentral.html