Example commands (*) that you can use to validate proxy behavior against the Zoom APIs. Follow the steps and change the values to match your configuration when needed.

For AWS, change the role to assume with one with sufficient permissions to call the proxy (-r flag). Example:

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/v2/users -r arn:aws:iam::PROJECT_ID:role/ROLE_NAME

If any call appears to fail, repeat it using the -v flag.

(*) All commands assume that you are at the root path of the Psoxy project.

List users

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/v2/users

Now pull out a user id ([zoom_user_id], accessor path in response .users[0].id). Next call is bound to a single user:

List user meetings

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/v2/users/[zoom_user_id]/meetings

Meetings

First pull out a meeting id ([zoom_meeting_id], accessor path in response .meetings[0].id):

List past meeting details

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/v2/past_meetings/[zoom_meeting_id]

List past meeting instances

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/v2/past_meetings/[zoom_meeting_id]/instances

List past meeting participants

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/v2/past_meetings/[zoom_meeting_id]/participants

Get meeting details

node tools/psoxy-test/cli-call.js -u [your_psoxy_url]/v2/meetings/[zoom_meeting_id]

Prerequisites

As of July 2023, pulling historical data (last 6 months) and all scheduled and instant meetings requires a Zoom paid account on Pro or higher plan (Business, Business Plus). On other plans Zoom data may be incomplete.

Accounts on unpaid plans do not have access to some methods Worklytics use like:

• -required for historical data

• certain methods such as retrieving

Examples

• Example Data : |

See more examples in the docs/sources/zoom/example-api-responses folder of the .

Steps to Connect

The Zoom connector through Psoxy requires a Custom Managed App on the Zoom Marketplace. This app may be left in development mode; it does not need to be published.

1. Go to https://marketplace.zoom.us/develop/create and create an app of type "Server to Server OAuth" for creating a server-to-server app.

2. After creation, it will show the App Credentials.

   Copy the following values:

   • Account ID

   • Client ID

   • Client Secret

   Share them with the AWS/GCP administrator, who should fill them in your host platform's secret manager (AWS Systems Manager Parameter Store / GCP Secret Manager) for use by the proxy when authenticating with the Zoom API:

   • Account ID --> PSOXY_ZOOM_ACCOUNT_ID

   • Client ID --> PSOXY_ZOOM_CLIENT_ID

   • Client Secret --> PSOXY_ZOOM_CLIENT_SECRET

   NOTE: Anytime the Client Secret is regenerated it needs to be updated in the Proxy too. NOTE: Client Secret should be handled according to your organization's security policies for API keys/secrets as, in combination with the above, allows access to your organization's data.

3. Fill the 'Information' section. Zoom requires company name, developer name, and developer email to activate the app.

4. No changes are needed in the 'Features' section. Continue.

5. Fill the scopes section clicking on + Add Scopes and adding the following:

• meeting:read:past_meeting:admin

• meeting:read:meeting:admin

• meeting:read:list_past_participants:admin

• meeting:read:list_past_instances:admin

• meeting:read:list_meetings:admin

• meeting:read:participant:admin

• report:read:list_meeting_participants:admin

• report:read:meeting:admin

• report:read:user:admin

• user:read:user:admin

• user:read:list_users:admin

Alternatively, the scopes: user:read:admin, meeting:read:admin, report:read:admin are sufficient, but as of May 2024 are no longer available for newly created Zoom apps.

Once the scopes are added, click on Done and then Continue.

1. Activate the app