Overview

RingCentral Inspector (Beta)

RingCentral is a cloud business phone system (RingEX, formerly RingCentral MVP) with calling, SMS, video meetings, and contact center built in. The RingCentral Inspector (Beta) connects to a Customer's RingCentral account through the read-only RingCentral Platform API and reports the phone system's users, admin access, phone numbers, call queues, sites, and desk phones back into Liongard. You see who can administer the phone system, which numbers the Customer owns and where they ring, and which desk phones are missing a valid emergency address, without logging in to the RingCentral Admin Portal.

What you can monitor

The RingCentral Inspector collects phone system configuration, including:

• Account status, brand, service plan and edition, billing plan, and included phone lines
• Every extension (users, call queues, IVR menus, common-area phones, and others) with status, email, department, site, admin permission, and assigned roles
• Company phone numbers, with usage (main, direct, toll-free, fax, and others), status (including numbers being ported in), label, and the extension each number rings
• Call queues and their members
• Desk phones, with model, serial number, online or offline status, assigned user, and E911 emergency address status
• Multi-Site sites, IVR menus, and the RingCentral features enabled on the account

How it works

Each launchpoint connects to one RingCentral account using a private app and a JWT credential created in that Customer's account. RingCentral doesn't offer an API that lets one partner credential reach every Customer account, so you create one launchpoint per Customer, in that Customer's Environment. The Inspector is read-only and never changes anything in RingCentral. It supports both the RingCentral platform (including BT, Avaya Cloud Office, and TELUS) and the separate platform used by AT&T Office@Hand and Verizon.

Benefits

• Get alerted when the number of admins or Super Admins changes, and review exactly who holds those rights on the Users & Extensions tab.
• Find desk phones with an invalid E911 emergency address, a compliance exposure under US Kari's Law and RAY BAUM's Act.
• Spot enabled call queues with no members, where Customer calls go unanswered.
• Keep an accurate inventory of the Customer's phone numbers and where they route, and verify offboarding by confirming departed users' extensions and numbers are released.
• Track service plan, billing plan, and feature changes, and keep a timeline of phone system administration for QBRs.

The Inspector ships with 8 alert rules, listed in the RingCentral Inspector Summary. All rules ship turned off. To receive these alerts, turn the rules on under Admin > Actionable Alerts.

Inspector Setup Preparation

Step 1: Create a RingCentral App

1. Sign in to the RingCentral Developer Console at developers.ringcentral.com with the Customer account's admin user.
2. On the Apps tab, select Create App (upper right).
3. Choose REST API App.
4. Enter an App name, for example Liongard Inspector, and a Display name.
5. Under authentication, select JWT auth flow.
6. Under app scopes, select Read Accounts only.
7. Make the app private, so only credentials from this account can use it.
8. Create the app, open its Credentials, and copy the Client ID and Client Secret.

Step 2: Create a JWT Credential

1. In the Developer Console, hover over your name in the upper right corner and select Credentials.
2. Select Create JWT.
3. When asked which apps may use the credential, choose Only specific apps of my choice and paste the app's Client ID.
4. Choose an expiration. A credential that doesn't expire avoids an outage when it lapses. If you set an expiry, note the date.
5. Create the credential and copy the JWT. Store it securely: it unlocks the account through the API.

Inspector Setup:

Step 3: Configure the RingCentral Inspector in Liongard

1. Log in to the Liongard platform.
2. In Liongard, navigate to Admin > Inspectors > Inspector Types > Navigate to the RingCentral Inspector > Select Add System.

Fill in the following information:

• Environment: Select the Customer Environment this System Inspector should be associated to
• Friendly Name: Suggested: RingCentral [Environment Name]
• Agent: Select the On-Demand Agent. A Self-Managed Agent also works if it has outbound HTTPS (port 443) access to platform.ringcentral.com, or platform.ringcentral.biz for AT&T Office@Hand and Verizon accounts
• Inspector Version: Latest
• Client ID: The app's Client ID
• Client Secret: The app's Client Secret
• JWT Credential: The JWT created for this app
• Platform: Select RingCentral for RingCentral, BT, Avaya Cloud Office, TELUS, and other brands, or AT&T Office@Hand or Verizon for those two brands
• Scheduling: The Inspector will default to run once a day at the time it's set up. Here you can adjust the schedule
• Select Save. The Inspector will now be triggered to run within the minute.

Repeat these steps for each RingCentral Customer account you manage: one launchpoint per account.

Troubleshooting

• RingCentral rejected the JWT credential: The JWT was created for a different app than the Client ID, it has expired or been revoked, or the Platform setting doesn't match the Customer. Create a new JWT restricted to this app's Client ID, and select AT&T Office@Hand or Verizon as the Platform for those brands.
• RingCentral rejected the app credentials: The Client ID or Client Secret is wrong. Copy both again from Apps > your app > Credentials in the Developer Console.
• The RingCentral app is missing an app permission: The app doesn't have the Read Accounts app permission. Edit the app in the Developer Console and select it.
• The user who created the JWT credential lacks a permission: The JWT was created by a user without admin rights. Create a new JWT while signed in as a Super Admin.
• RingCentral stopped accepting the access token during the inspection: The JWT was revoked, or the user who created it was disabled, while the inspection ran. Create a new JWT credential.
• Could not reach the RingCentral platform: The Agent can't reach RingCentral over HTTPS (port 443). For a Self-Managed Agent, allow outbound access to platform.ringcentral.com (or platform.ringcentral.biz).
• RingCentral kept rate-limiting this credential: RingCentral limits how many requests one credential can make per minute. The next scheduled run retries. If it repeats, check whether another integration uses the same JWT credential.
• A collection shows under Collections Not Collected on the Account tab: RingCentral refused that one collection, usually because the account doesn't have the feature (for example, Multi-Site or IVR) or the JWT user's role can't read it. The reason appears in the table, the rest of the inspection succeeds, and the related counts stay empty instead of showing 0.
• The Sites tab is empty: Sites appear only on accounts with RingCentral Multi-Site.
• The Devices tab doesn't list softphones: The Inspector lists desk phones only. Softphones and the RingCentral app aren't included.
• The Admins count is empty: RingCentral didn't return admin permissions for this account. The Users & Extensions tab still lists every extension and its roles.
• Inspections take several minutes on large accounts: RingCentral limits each credential to a set number of requests per minute, and desk phones are read one user at a time. An account with about 400 users takes about 10 minutes.

Inspector FAQs