Variphy Zoom Account configuration using a Private OAuth App.

This guide will walk you through creating a Zoom Private App to connect your on premise Variphy installation to the Zoom APIs via a Private App.

Configuring the Private App

1. Visit and sign in to the Zoom App Marketplace

Visit https://marketplace.zoom.us/user/build and click Sign In, if not already logged in.

After successfully signing in, click Build App from the Develop drop down menu.

2. Create OAuth App on Zoom

On the resulting page, click the OAuth Create button to create an OAuth app.

This will open a modal where the following should be configured:

• App Name
  • Enter a name for your new app
  • Example: OAuth App for Variphy
• Choose app type
  • Choose Account-level app as this will be used to access data for the entire Zoom Account
• Would you like to publish this app on Zoom App Marketplace?
  • Disable this option. This app should not be published to the Zoom Marketplace – it will be only used by the specific Zoom Account.

When finished, click the Create button to continue.

3. View and Configure App Credentials

Next, the following important values, which have been automatically generated by Zoom, will be presented:

• Client ID
  • This is a unique identifier specific for this app and is not expected to change
• Client secret
  • Analogous to a password for security purposes

Copy these values as they will be needed when configuring Variphy for this Zoom Account.

Enter the following URL in both the Redirect URL for OAuth and Add allow lists fields and click Continue.

• https://www.variphy.com/api/v1/zoom/oauth

4. App Information

Enter a required Short description and Long description for this new Zoom App for Variphy.

• Short Description Example: App Required for integration with Variphy Analytics
• Long Description Example: This app is dedicated to Variphy Analytics for the purpose of securely integrating with various Zoom APIs to provide Collaboration Analytics.

Enter a required Company Name and Developer Contact Information for this new Zoom App for Variphy.

• Company Name
  • This should be your company name
• Developer Contact Information
  • Name: This should be your name as you are creating the Private App
  • Email Address: This should be your email address

All other fields are optional and can be configured if desired or needed.

When finished, click the Continue button to continue.

5. Feature

The Feature verification token is not yet needed by Variphy but may be required in the future. You can disregard the Verification Token Message.

Click the Continue button to continue.

6. Configure App Scopes

Scopes are critically important for Zoom Apps, as they define what types of data and APIs an App can access.

Click the + Add Scopes button to find and select the following required Scopes for Variphy:

• Account
  • View account info – account:read:admin
  • Required for account licensing, organization visibility, configurable data restrictions, and easy-to-use search, select, and display UI capabilities
• User
  • View all user information – user:read:admin
  • Required for organization visibility, configurable data restrictions, and easy-to-use search, select, and display UI capabilities
• Group
  • View groups and group members – group:read:admin
  • Required for organization visibility, configurable data restrictions, and easy-to-use search, select, and display UI capabilities
• Role
  • View users’ roles – role:read:admin
  • Required for organization visibility, configurable data restrictions, and easy-to-use search, select, and display UI capabilities
• Phone
  • View all users’ phone information – phone:read:admin
    • Required for organization visibility, configurable data restrictions, and easy-to-use search, select, and display UI capabilities
  • View all users’ call log information – phone_call_log:read:admin
    • Required for collecting call logs comprehensively across the organization
  • View all users’ recording information – phone_recording:read:admin
    • Required for providing privileged users the ability to playback audio voice call recordings

Click the Done button once you’ve selected the required Scopes.

You should have 7 Scopes selected.

Click the Continue

7. Activation

Time to add your Zoom App.

Click the Add or Install button.

Zoom may require you to sign in again.

Click the Authorize or Allow button that appears at the bottom of the page to complete the activation of the new Zoom OAuth app for Variphy.

8. Get Your Zoom OAuth App Authorization Code

Your Zoom OAuth App Authorization Code will be displayed on the resulting screen.

Copy this Code to a safe place as it cannot be retrieved again. If necessary, the preceding steps can be repeated in order to generate and retrieve a new Code for this App.

Although this isn’t documented, from initial R&D, these Authorization Codes appear to expire, possibly as soon as 1 hour (3600 seconds) after being issued.

9. Configure the Zoom Account in Variphy

Log into Variphy and hover over the setup icon in the upper right and click Zoom Accounts from the Platforms section.

Note: This will only appear and be accessible for system administrator users and if your instance of Variphy is licensed for Zoom Phone.

On the resulting page, click the Add New button.

Clicking the Add New button will open the following simple configuration modal to complete the creation of your Zoom Account in Variphy.

Using the Client ID, Client Secret & Authorization Code from the previous steps, a Zoom API Access Token can be generated :

1. Enter the desired Name for your Zoom Account in Variphy, for display and selection purposes.
2. Select the appropriate Enterprise group in Variphy to assign this Zoom Account to
3. Use Variphy Official Zoom OAuth App
   • Disable this option. We will not be using Market Place app as we are using the private OAuth App we created.
4. Enter the App Client ID
   • From Step 3: View and Configure App Credentials above
5. Enter the App Client Secret
   • From Step 3: View and Configure App Credentials above
6. Enter the OAuth App Authorization Code
   • From Step 8: Get Your Zoom OAuth App Authorization Code above

7. Click Save to activate connectivity between Variphy and your Zoom Account.

There is no need to click the Authorize your Zoom OAuth App button as you have already built and authorized your App in the previous steps.

You should now see your Zoom account number listed as a Zoom Account.

10. Configure CDR Processing

Navigate to the CDR Processing tab and click the gear icon to edit your Zoom Account.

On the resulting CDR Processing Settings & Activation page adjust the following configurations

1. Enable Data Processing
   • Toggle on to enable processing of Zoom Data
2. Primary Database Server
   • Select your SQL Server from the list of available options.

3. Primary Database Name
   • Key in the name you wish to use for the Primary Database name
4. Primary Database Purge Settings
   • Adjust the data purge settings per your company’s requirements

Additional Optional Settings:

CDR Data Monitoring Settings – How to Configure No CDR Alerts in Variphy

Enable Database Archiving – How to Configure Database Archiving on a new cluster.

Click Save and Continue

On the resulting page click Create Database

On the resulting page click Activate

You will see a message stating Database CDR Processing was successfully activated. Click Close.

11. Schedule your automatic data Sync

Scheduled Syncs are used to pull Zoom Account meta data into the Variphy database for reporting. Different than call data, which is pulled on the CDR Processing Schedule, meta data includes things like new Zoom Phone Users, Groups, Departments, Queues, etc…

Navigate to the Sync tab.

Once your Zoom Account integration has been successfully activated Variphy will automatically sync meta data to Variphy. It may take several second to several minutes for your first Sync to complete depending on the size of your Zoom Account. Once complete your “Status” will say Enabled and your “Last Sync Attempt” and “Last Sync Success” will be updated.

Multiple Sync Schedules can be created to import Meta Data more frequently.

In the Sync tab click the Calendar Icon

Click Create Zoom Sync Schedule

Select the Days of the Week the Sync should run.

Select the Start Time and Time Zone you wish the sync to run.

If creating multiple Sync Schedules click the Create Zoom Sync Schedule to add multiple syncs.

Click Save once you have added all your sync schedules.

In the example below I am running a sync twice a day, once at 6:00 AM and again at 5:00 PM Monday through Friday.

You have now completed the Zoom Account setup using a Private App.