Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
subtletrue
colourGreen
titleAvailable in version 9.67.13 7 or later

Table of Contents

...

In order to allow access to the Zoom APIs, an application has to be created on the Zoom portal. The system is integrated using either the JWT based or the Server-to-server OAuth 2.0 based authentication option which is suitable for the server-to-server type of integrations.

...

For information on creating a JWT application, refer to https://marketplace.zoom.us/docs/guides/build/jwt-app

Make a note of the API Key and API Secret settings created during the process, because these will be required for the import source configuration.

Image Removed


Server-to-server OAuth 2.0 app

...

  • Create a Server-to-server OAuth 2.0 app

...

...


  • recording:read:admin
  • dashboard_meetings:read:admin
  • phone:read:admin
  • phone:write:admin
  • phone_call_log:read:admin
  • phone_recording:read:admin

...

Note

A know bug in Zoom APIs invalidates every Server-to-server OAuth tokens upon requesting a new one, so a single OAuth app can ONLY be used by one server. If you plan to use multiple servers, create an app for each of them

...

.

  • Apply the required granular scopes to the app:
Note

Scopes are being deprecated, and they are being replaced with Granular Scopes. Do not set Scopes for new apps, and update your existing apps to include the corresponding Granular Scopes to avoid the apps or integrations breaking.


IntegrationScope (deprecated)Granular Scope (required)
Zoom Phone
  • phone:read:admin
  • phone_recording:read:admin
  • phone_call_log:read:admin
  • phone:read:list_call_recordings:admin
  • phone:read:list_call_logs:admin
Zoom Meetings
  • recording:read:admin

  • dashboard_meetings:read:admin

  • dashboard:read:admin

  • archiving:read:list_archived_files:admin

  • archiving:read:list_archived_files:master

  • dashboard:read:list_meeting_participants:admin

  • dashboard:read:list_meetings:admin

  • Make a note of

...

  • the Account ID,

...

  • Client ID,

...

  • Client secret of your app,

...

  • because these will be required for the import source configuration.
    Image Modified


Configure Zoom import

The configuration includes the following steps:

...

Follow the steps below to create a new Verba Import source for Zoom: 

Step 1 - Open the Verba Web interface then select Data / Import Sources from the top menu

...

NameDescription
API KeyThe Zoom API key associated with the Zoom application registered earlier
API SecretThe Zoom API secret associated with your Zoom application registered earlier
Forward Proxy Address

IP of the forward proxy server. If left empty, no attempt is made for establishing a forward proxy connection.

Forward Proxy PortPort for the forward proxy connection.
Forward Proxy UserUsername for authenticating with the Forward Proxy. If left empty, authentication is omitted.
Forward Proxy PasswordPassword for authenticating with the Forward Proxy.
API AddressThe base URL of the Zoom API

TLS Certificate File / Thumbprint

Specify the certificate file / certificate thumbprint that is being used for the Zoom API connection. If left empty then the Verba default certificate will be used.

TLS Key File

Specify the file where the certificate key is stored if not in the windows certificate store.

TLS Key Password

Specify the password for the file that contains the certificate keys.

TLS Trust List

Specify the list of certificates that Verba trusts from a 3rd-party connection. Available options:

  • .pem file with a list of certificates
  • comma separated certificate thumbprints
  • comma separated CA thumbprints

...

  • Zoom Phone: to control which user recordings have to be downloaded and archived, and to match the imported conversations to an extension (and to a user account) you need to add the Zoom user phone extension numbers (not the Zoom user ID) as extensions with type Number User / AddressAgent ID.
  • Zoom Meeting: to control which user recordings have to be downloaded and archived, and to match the imported conversations to an extension (and to a user account) you need to add the Zoom user ID as extensions with type User / Agent ID.

...