Ballerina Zoom Meetings connector

Overview

Zoom is a widely-used video conferencing service provided by Zoom Video Communications, enabling users to host and attend virtual meetings, webinars, and collaborate online.

The ballerinax/zoom.meetings package offers APIs to connect and interact with Zoom API endpoints, specifically based on Zoom API v2.

Setup guide

To use the Zoom meetings connector, you must have access to the Zoom API through Zoom Marketplace and a project under it. If you do not have a Zoom account, you can sign up for one here.

Step 1: Create a new app

1. Open the Zoom Marketplace.

2. Click "Develop" → "Build App"

   

3. Choose "General App" app type (for user authorization with refresh tokens)

   

4. Fill in Basic Information, choose Admin-managed option.

Step 2: Configure OAuth settings

1. Note down your credentials:

   • Client ID
   • Client Secret

   

2. Set Redirect URI: Add your application's redirect URI

3. Add scopes: Make sure your Zoom app has the necessary scopes for the meetings API:

   • Add meetings:read, meetings:write and user:read in the scope

   

Step 3: Activate the app

1. Complete all necessary information fields.

2. Once, the necessary fields are correctly filled, app will be activated.

Step 4: Get user authorization

1. Direct users to authorization URL (replace YOUR_CLIENT_ID and YOUR_REDIRECT_URI):

   https://zoom.us/oauth/authorize?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI&scope=meetings:read meetings:write user:read
   

2. User authorizes the app and gets redirected to your callback URL with an authorization code

3. Exchange authorization code for tokens:

   curl -X POST https://zoom.us/oauth/token \
   -H "Authorization: Basic $(echo -n 'CLIENT_ID:CLIENT_SECRET' | base64)" \
   -d "grant_type=authorization_code&code=AUTHORIZATION_CODE&redirect_uri=YOUR_REDIRECT_URI"
   

   This returns both access_token and refresh_token.

   Replace:

   • CLIENT_ID with your app's Client ID
   • CLIENT_SECRET with your app's Client Secret
   • AUTHORIZATION_CODE with the code received from the callback
   • YOUR_REDIRECT_URI with your configured redirect URI

Step 5: Verify your setup

   curl -X GET "https://api.zoom.us/v2/users/me" \
   -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

This will give you the user ID needed for API calls.

Quickstart

To use the Zoom connector in your Ballerina application, update the .bal file as follows:

Step 1: Import the module

Import the zoom.meetings module.

import ballerinax/zoom.meetings;

Step 2: Instantiate a new connector

1. Create a Config.toml file and, configure the obtained credentials in the above steps as follows:

   refreshToken = "<refresh Token>"
   refreshUrl = "<refresh URL>"
   userId = "<user_id>"
   clientId = "<client_id>"
   clientSecret = "<client_secret>"

2. Create a zoom.meeting:ConnectionConfig with the obtained access token and initialize the connector with it.

   configurable string refreshToken = ?;
   ConnectionConfig config = {
      auth: {
         refreshToken,
         clientId,
         clientSecret,
         refreshUrl
      }
   };
   
   final Client zoomClient = check new Client(config, serviceUrl);

Step 3: Invoke the connector operation

Now, utilize the available connector operations.

   meetings:InlineResponse20028 response = check zoomClient->/users/[originalId]/meetings();
      meetings:InlineResponse20028Meetings[]? meetings = response.meetings;
      if meetings is () {
         io:println("No upcoming meetings found.");
         return;
      }
      foreach var meeting in meetings {
         if meeting.id is int && meeting.topic is string {
               io:println("Meeting ID: ", meeting.id);
               io:println("Topic    : ", meeting.topic);
               io:println("-------------------------------");
         }
      }

Step 4: Run the Ballerina application

   bal run

Examples

The Zoom Meetings connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

1. Create a Zoom meeting – Creates a new Zoom meeting using the API.

2. List scheduled meetings – Displays the list of meetings scheduled under a specified Zoom user account.

Setting up the prerequisites

1. Download and install Java SE Development Kit (JDK) version 21. You can download it from either of the following sources:
   • Oracle JDK
   • OpenJDK

   Note: After installation, remember to set the JAVA_HOME environment variable to the directory where JDK was installed.

2. Download and install Ballerina Swan Lake.
3. Download and install Docker.

   Note: Ensure that the Docker daemon is running before executing any tests.

4. Export Github Personal access token with read package permissions as follows,

   export packageUser=<Username>
   export packagePAT=<Personal access token>

Build options

Execute the commands below to build from the source.

1. To build the package:

   ./gradlew clean build

2. To run the tests:

   ./gradlew clean test

3. To build the without the tests:

   ./gradlew clean build -x test

4. To run tests against different environments:

   ./gradlew clean test -Pgroups=<Comma separated groups/test cases>

5. To debug the package with a remote debugger:

   ./gradlew clean build -Pdebug=<port>

6. To debug with the Ballerina language:

   ./gradlew clean build -PbalJavaDebug=<port>

7. Publish the generated artifacts to the local Ballerina Central repository:

   ./gradlew clean build -PpublishToLocalCentral=true

8. Publish the generated artifacts to the Ballerina Central repository:

   ./gradlew clean build -PpublishToCentral=true

Contribute to Ballerina

As an open-source project, Ballerina welcomes contributions from the community.

For more information, go to the contribution guidelines.

Code of conduct

All the contributors are encouraged to read the Ballerina Code of Conduct.

Useful links

• For more information go to the zoom.meetings package.
• For example demonstrations of the usage, go to Ballerina By Examples.
• Chat live with us via our Discord server.
• Post all technical questions on Stack Overflow with the #ballerina tag.