How to Obtain APIs

ScopesTo obtain API credentials, visit the Zoom App Marketplace at https://marketplace.zoom.us/ and sign in with your Zoom account. If you don't have a Zoom account, you can create one using this link.

eRoom requires Server-to-Server OAuth and Meeting SDK APIs to connect with Zoom and use its functionalities.

To make the Zoom Credentials work, the SSL should be activated on your domain.

SERVER-TO-SERVER OAUTH CREDENTIALS

On the Zoom App Marketplace page, click Develop and select Build Server-to-Server App from the dropdown menu.

Then, in the popup window, enter your app name:

After completing this step, the system will automatically create API credentials, available in the App Credentials section.

After selecting Continue, you will be taken to the Information page. On this page, you are required to enter essential details for your app, including your email and a description. Please ensure you accurately complete the following fields in the Information section:

  • Company Name

  • Developer Contact Name

  • Developer Contact Email

You can skip the next step Feature.

Next, to ensure the plugin functions correctly, navigate to the Scopes tab and select "Add Scopes."

Required Scopes:

Below you can see all required scopes.

Permission issue error notices may appear while creating the meetings or webinars when any of the listed Scopes are not enabled.

Account

  • View account info

    • View an account's settings (account:read:account_setting:admin)

    • View an account's settings (account:read:account_setting:master)

    • View an account's settings (account:read:settings:admin)

  • View and manage account info

    • Update an account's settings (account:update:settings:admin)

  • View and manage sub accounts

    • Update an account's options (account:update:options:admin)

    • Update an account's owner (account:update:owner:master)

    • Update an account's settings (account:update:settings:master)

Meeting

  • View all user meeting summaries

    • View a meeting's summary (meeting:read:summary:admin)

  • View all user meetings

    • View a meeting's chat message (meeting:read:chat_message:admin)

    • View a meeting's invitation (meeting:read:invitation:admin)

    • View a user's meetings (meeting:read:list_meetings:admin)

    • View a user's upcoming meetings (meeting:read:list_upcoming_meetings:admin)

    • View a meeting (meeting:read:meeting:admin)

  • View and manage all user meetings

    • Delete a meeting (meeting:delete:meeting:admin)

    • Update a meeting (meeting:update:meeting:admin)

    • Update a meeting's status (meeting:update:status:admin)

    • Create invite links for a meeting (meeting:write:invite_links:admin)

    • Create a meeting for a user (meeting:write:meeting:admin)

  • View live streaming meeting token information

    • View a meeting live streaming join token (meeting:read:live_streaming_token:admin)

  • View local archiving meeting token information

    • View a meeting local archiving join token (meeting:read:local_archiving_token:admin)

User

  • View all user information

    • Verify a user's email (user:read:email:admin)

    • View a user's assistants (user:read:list_assistants:admin)

    • View a user's permissions (user:read:list_permissions:admin)

    • View users (user:read:list_users:admin)

    • View a user's settings (user:read:settings:admin)

    • View a user's token (user:read:token:admin)

    • View a user (user:read:user:admin)

  • View user's zak token

    • View a user's Zoom Access Key (user:read:zak:admin)

  • View users information and manage users

    • Delete a user (user:delete:user:admin)

    • Update a user (user:update:user:admin)

    • Create a user (user:write:user:admin)

Zoom Events

  • Manage event speaker information

    • Remove an event's speaker (zoom_events:delete:speaker:admin)

    • Update an event's speaker (zoom_events:update:speaker:admin)

    • Add a speaker to an event (zoom_events:write:speaker:admin)

  • View all events information

    • View an event (zoom_events:read:event:admin)

    • View events (zoom_events:read:list_events:admin)

  • View event's Access Link

    • View zoom event access links (zoom_events:read:list_access_links:admin)

Webinar

  • View all user Webinars

    • View a webinar's participant (webinar:read:participant:admin)

    • View a webinar (webinar:read:webinar:admin)

  • View and manage all user Webinars

    • Delete a webinar (webinar:delete:webinar:admin)

    • Update a webinar's status (webinar:update:status:admin)

    • Update a webinar (webinar:update:webinar:admin)

    • Create invite links for a webinars (webinar:write:invite_links:admin)

    • Create a webinar for a user (webinar:write:webinar:admin)

  • View and manage sub account's user webinars

    • Delete a webinar (webinar:delete:webinar:master)

    • View a webinar (webinar:read:webinar:master)

    • Update a webinar (webinar:update:webinar:master)

    • Create invite links for a webinars (webinar:write:invite_links:master)

    • Create a webinar for a user (webinar:write:webinar:master)

Once you've added all the necessary Scopes, click on the Done button.

To learn more about scopes and expand the functionality of the app, read Zoom's doc about OATH Scopes.

Click Continue to go to the final step.

Finally, activate the Server-to-Server App:

Copy the Account ID, Client ID, and Client Secret and paste them into the respective fields on the Zoom Settings page in your dashboard:

JWT (JSON WEB TOKEN) CREDENTIALS (Deprecated)

Zoom is deprecating their JWT app from June of 2023 and until the deadline, all your current APIs will work. Please see JWT App Type Depreciation FAQ for more details. It is recommended to run the migration wizard to smooth the transition to the new Server to Server OAuth system.

Among available Apps select JWT type and click Create to generate APIs.

Then, in the Popup window set a name for the App:

Then, it is required to add information for the app such as email, and description in the Information section. In the Information section, it is required to fill out the following fields:

  1. Company Name

  2. Developer Contact Name

  3. Developer Contact Email

As soon as App created API credentials will be generated automatically in the App Credentials section:

Copy the API Key and API Secret Key and paste them into the respective fields on the Zoom Settings page in your dashboard.

Under the API Key field, you can also find the link to the guide on how to obtain the credentials.

MEETING SDK CREDENTIALS

Zoom Meeting SDK offers video-conferencing features that mirror the meeting experience in the Zoom Client. Meeting SDK is required to make Join In Browser work.

Go to the Zoom App Marketplace at https://marketplace.zoom.us/.

On the Zoom App Marketplace page, click Develop and select Build Legacy App from the dropdown menu.

Then, in the popup window, enter your app name:

Among available Apps select Meeting SDK API type and click Create to generate APIs.

Then, in the Popup window set a name for the app and click Create:

The toggle button should be disabled in the "Would you like to publish this app on Zoom Marketplace" section.

In the Information section, it is required to fill out the following fields:

  1. App Name

  2. Short description

  3. Long description

  4. Company Name

  5. Developer Name

  6. Developer Email address

As soon as the Required information is filled out, go to the Download section:

As soon Continue button is clicked, API credentials will be generated automatically in the App Credentials section:

Copy the API Key and API Secret Key and paste them into the respective fields on the Zoom Settings page in your dashboard.

Redirect URL for OAuth

Destination URL where Zoom will send the access token after the user completes the OAuth authentication. To get the "Redirect URL for OAuth" open Zoom Settings on your dashboard and copy the URL from the address bar:

Paste the URL to the Redirect URL for OAuth input:

Next, it is required to add the domain (example: https://your-domain.com) to the "OAuth allow list" to make the Metting SDK secure:

You can skip the next step Feature.

In the Scopes tab, click on the Add scopes button.

Add the another scope from the Meeting:

  • View live streaming meeting token information

    • View a meeting live streaming join token meeting:read:live_streaming_token

Once you've added the scope, click on the Done button.

To learn more about scopes and expand the functionality of the app, read Zoom's doc about OATH Scopes.

Click Continue to go to the final step.

Next, go to the SDK Activation tab, and click on the "Add" button to complete the API generation progress.

On the opened window, click on the "Allow" button to give access permission:

Under the API Key field, you can also find the link to the guide on how to obtain the credentials.

Last updated