Skip to main content
Ensure that you have registered an account on RingCentral Developers with Developer Admin privileges.

​
Log in to RingCentral Developers

This connection authenticates on behalf of a registered application in RingCentral Developers.

1

Register for RingCentral Developers

If you do not have a RingCentral Developers account, you can register for one at https://developers.ringcentral.com/sign-up

  • Your account should have the Role Developer Admin
2

Log in to RingCentral Developers

​
Create a New RingCentral Application

Register a new application that StackOne will authenticate through.

1

View Apps

In RingCentral Developers, click the Console button, then Apps on the left.

2

Create new App

Click the Create App button.

3

Select App Type

Under App Type, select REST API App (most common) and click the Next button.

4

Enter App Properties

Under App Properties (internal-use only), enter the following details:

  • App Name: Enter a name for your new App
  • App description: Enter a description for your new App
  • Primary Contact: Enter the email address of the main support contact for this App
  • Do you intend to promote this app in the RingCentral App Gallery?: No
5

Enter Auth Details

Scroll down to the Auth section, and enter the following details:

  • Select 3-legged OAuth flow authorization code
  • From what type of app will you be calling the API?: Server-side web app (most common)
  • OAuth Redirect URI: https://api.stackone.com/connect/oauth2/ringcentral/callback
  • Issue refresh tokens?: Yes
6

Enter Security Details

Enables actions: Add BYOD Devices, Add Chat To Favorites, Add Opt-In/Out Numbers, Archive Team, Calls Aggregation Data, Calls Timeline Data, Cancel RingOut Call, Create Data Export Task, Create Extension, Create Fax Message, Create Message Store Report, Create Multiple User Extensions, Create Task, Create Team, Delete Conversation, Delete Message, Delete User Call Records, Delete User Extensions, Delete User Profile Image, Drop Call Session, Enable Automatic Location Updates For Users, Get Agent’s Call Queue Presence, Get Call Queue Presence, Get Call Session Status, Get Company Directory Entries, Get Contacts Upload Task, Get Data Export Task, Get Emergency Map Configuration Task, Get Event, Get Extension, Get Extension Update Task Status, Get Message Store Configuration, Get Message Store Report Task, Get Message(s), Get RingOut Call Status, Get Unified Presence, Get User Presence Status, Get User Profile Image, Get User Template, Get Video Meeting, List A2P SMS Statuses, List Call Queues, List Chat Tasks, List Company Active Calls, List Company User Roles, List Data Export Tasks, List Extension Devices, List Extensions, List Favorite Chats, List Favorite Contacts, List Messages, List Opted Out Numbers, List Teams, List User Active Calls, List User Administered Sites, List User Assigned Roles, List User Call Records, List User Events, List User Templates, List Video Meetings, Make CallOut, Make RingOut Call, Patch Message(s), Search Company Directory Entries, Send A2P SMS, Send MMS, Send SMS, Send/Resend Activation Email, Send/Resend Welcome Email, Start Conference Call Session, Unarchive Team, Update Agent’s Call Queue Presence, Update Call Queue Presence, Update Favorite Contact List, Update Message Store Configuration, Update Message(s), Update Multiple Extensions, Update Unified Presence, Update User Administered Sites, Update User Assigned Roles, Update User Call Queues, Update User Presence Status, Update User Profile Image, Upload Multiple User Contacts, Upload User Profile Image

Under Security, select the application permissions your integration needs, then choose who can access the app.

  • Application Scopes: select the permissions matching the actions you will use (e.g. ReadAccounts, ReadMessages, SMS, ReadCallLog, Contacts, TeamMessaging, RingOut, Faxes)
  • Who will be authorized to access your app?: This app is private and will only be callable using credentials from the same RingCentral account
  • Note: select the permission for every action you intend to use. The connection test needs no permissions, so a missing one only shows up later as a permission error from that action
  • Click the Create button to proceed. Upon seeing a success message, press the OK button.
7

Copy API Credentials

Your new App Client ID and Client Secret will now be available to copy.

  • Under Production Credentials, copy both your Client ID and Client Secret and store them securely for use later

​
Enter credentials in the connector profile

Provide the Client ID, Client Secret and, optionally, Scopes in the StackOne connector profile.

1

Enter the Client ID and Client Secret

Paste the Client ID and Client Secret copied from your RingCentral app.

2

Enter Scopes (optional)

Leave Scopes empty to use every permission selected on your RingCentral app. To request fewer, enter them space-separated, e.g. ReadAccounts SMS ReadCallLog. Only list permissions the app has, or sign-in will fail.

​
Troubleshooting

Common issues and how to resolve them.

1

Error: 'Parameter [scope] value is invalid'

The Scopes field in the connector profile lists a permission your RingCentral app does not have.

  • Clear the Scopes field to use the app’s own permissions
  • Or remove every permission that is not selected under the app’s Security settings in the Developer Console
2

Error: 'Client authentication is required'

RingCentral did not accept the app’s client credentials when linking the account.

  • Check that the Client ID and Client Secret in the connector profile both come from this app
  • Check that the app’s Auth settings use Server-side web app
3

An action fails with a permission error

The RingCentral app does not have the permission that action needs.

  • Add the permission under the app’s Security settings in the Developer Console
  • Then reconnect the account

​
Creating the StackOne Connector Profile

To create the Connector Profile in StackOne for RingCentral:
1

Open the connector

Log in to StackOne, open Connectors, and select RingCentral.
2

Choose actions and events

  • Click Add Profile.
  • If the connector offers more than one authentication method, set the Auth Method filter to OAuth 2.0.
  • Select the actions, and any events, to enable for this Connector Profile.
  • Click Continue.
3

Set up authentication

  • Select Authentication Type as OAuth 2.0.
  • Fill out the fields using details retrieved from your provider:
    • Client ID
    • Client Secret
    • Scopes (Optional)
  • Click Create Profile.
Congratulations! The new Connector Profile now shows up on the connector page. If you created it as a project member rather than an admin, it starts disabled until a project admin enables it. You can now continue to Link Accounts for RingCentral.