Zoom Connector for C#

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from Zoom using C# we first need to create a DSN (Data Source) which will access data from Zoom. We will later be able to read data using C#. Perform these steps:

1. Download and install ODBC PowerPack.

2. Open ODBC Data Sources (x64):

   

3. Create a User data source (User DSN) based on ZappySys API Driver:

   ZappySys API Driver

   
   • Create and use User DSN if the client application is run under a User Account. This is an ideal option in design-time, when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit.
   • Create and use System DSN if the client application is launched under a System Account, e.g. as a Windows Service. Usually, this is an ideal option to use in a production environment. Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.

4. When the Configuration window appears give your data source a name if you haven't done that already, then select "Zoom" from the list of Popular Connectors. If "Zoom" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

   ZoomDSN

   Zoom

   

5. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.

   User Credentials (Access Your Data)

   Zoom authentication

   OAuth App must be created under Admin Console > Channel > API > Settings. [API reference]

   Follow the steps below to create a Zoom OAuth app and obtain the required credentials (Client ID and Client Secret):

   1. Go to the Zoom App Marketplace and sign in with your Zoom account.
   2. From the top navigation bar, open the Develop dropdown and select Build App.
   3. In the What kind of app are you creating window, select General App, click the Create button.
   4. Enter a name for your app and select the app type.
      (E.g. Zoom-General App)
   5. Click Create to continue.
   6. In the Redirect URL for OAuth field, enter the following URI and add it to the allow list:
      https://zappysys.com/oauth/
   7. Copy your Client ID and Client Secret, then paste them into the ZappySys API Component/Driver UI under the required parameters.
   8. From the Scopes window, please add the appropriate Granular scopes. You can search for the scopes listed below and enable them as needed.
      Scope Levels:
      • User-Level: Grants access only to the authenticated user’s data. Suitable for apps where users connect with their own Zoom account.
      • Admin-Level: Grants access to data across all users in the account, provided the user has admin permissions. Best for organization-wide apps.
      • Master-Level: Grants access at the highest level, typically for apps that need full account control (including sub-accounts). Requires Master Account credentials.
      
      Recommended Scopes:
      User-Level
      • user:read:settings
      • meeting:read:list_meetings
      • meeting:read:meeting
      • meeting:read:list_registrants
      • meeting:read:past_meeting
      • meeting:read:list_registration_questions
      • webinar:read:list_webinars
      • webinar:read:webinar
      • webinar:read:list_registrants
      • report:read:user
      Admin-Level
      • user:read:settings:admin
      • user:write:user:admin
      • meeting:read:list_meetings:admin
      • meeting:read:meeting:admin
      • meeting:read:list_registrants:admin
      • meeting:read:past_meeting:admin
      • meeting:read:list_registration_questions:admin
      • user:read:list_users:admin
      • webinar:read:list_webinars:admin
      • webinar:read:webinar:admin
      • webinar:read:list_registrants:admin
      • report:read:user:admin
      Master-Level
      • user:read:settings:master
      • meeting:read:list_meetings:master
      • meeting:read:meeting:master
      • meeting:read:list_registrants:master
      • user:read:list_users:master
      • webinar:read:list_webinars:master
      • webinar:read:webinar:master
      • webinar:read:list_registrants:master
      • report:read:user:master
   9. That’s it! After adding the scopes, click Continue to complete the process.
   10. In the ZappySys API Component/Driver UI, enter your Zoom app Client ID and Client Secret, then click Generate Token to obtain the access tokens.
   11. You’re done!

   API Connection Manager configuration

   Just perform these simple steps to finish authentication configuration:

   1. Set Authentication Type to User Credentials (Access Your Data) [OAuth]
   2. Optional step. Modify API Base URL if needed (in most cases default will work).
   3. Fill in all the required parameters and set optional parameters if needed.
   4. Press Generate Token button to generate the tokens.
   5. Finally, hit OK button:

   ZoomDSN

   Zoom

   User Credentials (Access Your Data) [OAuth]

   https://api.zoom.us/v2

   Required Parameters
   Client Id	Fill-in the parameter...
   Client Secret	Fill-in the parameter...
   Redirect Url	Fill-in the parameter...
   Token Url	Fill-in the parameter...
   Authorization Url	Fill-in the parameter...
   Optional Parameters
   Retry Mode	RetryWhenStatusCodeMatch
   Retry Status Code	429
   Retry Count Max	5
   Retry Multiply Wait Time	True

   

   App Credentials (Access Account Level Data)

   Zoom authentication

   Server-to-Server OAuth authentication method that lets applications access the Zoom API directly without user login or consent, using a Client ID and Secret to generate short-lived tokens. [API reference]

   Follow the steps below to create a Zoom OAuth app and obtain the required credentials (Client ID and Client Secret):

   1. Go to the Zoom App Marketplace and sign in with your Zoom account.
   2. From the top navigation bar, open the Develop dropdown and select Build App.
   3. In the What kind of app are you creating window, select Server to Server OAuth App, click the Create button.
   4. Enter a name for your app and select the app type.
      (E.g. Basic OAuth App)
   5. Click Create to continue.
   6. Copy your Account ID, Client ID, and Client Secret, then paste them into the ZappySys API Component/Driver UI under the required parameters.
   7. In the Information window, enter the company name, developer name, and email address, then click Continue.
   8. From the Scopes window, please add the appropriate Granular scopes. You can search for the scopes listed below and enable them as needed.
      Scope Levels:
      • Admin-Level: Grants access to data across all users in the account, provided the user has admin permissions. Best for organization-wide apps.
      • Master-Level: Grants access at the highest level, typically for apps that need full account control (including sub-accounts). Requires Master Account credentials.
      
      Recommended Scopes:
      Admin-Level
      • user:read:settings:admin
      • user:write:user:admin
      • meeting:read:list_meetings:admin
      • meeting:read:meeting:admin
      • meeting:read:list_registrants:admin
      • meeting:read:past_meeting:admin
      • meeting:read:list_registration_questions:admin
      • user:read:list_users:admin
      • webinar:read:list_webinars:admin
      • webinar:read:webinar:admin
      • webinar:read:list_registrants:admin
      • report:read:user:admin
      Master-Level
      • user:read:settings:master
      • meeting:read:list_meetings:master
      • meeting:read:meeting:master
      • meeting:read:list_registrants:master
      • user:read:list_users:master
      • webinar:read:list_webinars:master
      • webinar:read:webinar:master
      • webinar:read:list_registrants:master
      • report:read:user:master
   9. That’s it! After adding the scopes, click Continue to complete the process.
   10. In the ZappySys API Component/Driver UI, enter your Zoom app Account ID, Client ID, and Client Secret, then click Test Connection.
   11. You’re done!

   API Connection Manager configuration

   Just perform these simple steps to finish authentication configuration:

   1. Set Authentication Type to App Credentials (Access Account Level Data) [OAuth]
   2. Optional step. Modify API Base URL if needed (in most cases default will work).
   3. Fill in all the required parameters and set optional parameters if needed.
   4. Finally, hit OK button:

   ZoomDSN

   Zoom

   App Credentials (Access Account Level Data) [OAuth]

   https://api.zoom.us/v2

   Required Parameters
   Account Id	Fill-in the parameter...
   Client Id	Fill-in the parameter...
   Client Secret	Fill-in the parameter...
   Token Url	Fill-in the parameter...
   Optional Parameters
   Retry Mode	RetryWhenStatusCodeMatch
   Retry Status Code	429
   Retry Count Max	5
   Retry Multiply Wait Time	True

   

   User Credentials (Access Your Data) - With Legacy Scopes

   Zoom authentication

   OAuth App must be created under Admin Console > Channel > API > Settings. [API reference]

   Perform the following steps to get the Zoom OAuth credentials (i.e. Client ID and Client Secret)

   1. Go to Zoom Marketplace Portal and sign in there.
   2. Once you successfully login then select "Build App" option from Develop dropdown from top left on the page.
   3. Click on Create button of OAuth panel section of page.
   4. Enter the name for your application and choose app type (Recommneded "Account-Level App") option for your API
   5. Then proceed with clicking Create button.
   6. In Redirect URL for OAuth enter this https://zappysys.com/oauth/ as Redirect URI and add it to allow lists.
   7. Copy Client ID and Client Secret here and paste it into Connection Manager Required Paramters section in respective place holders
   8. Add appropiate scopes from the Scopes menu option to the right side of page for your API as below :

      NOTE: If you need to read/write data for all users (not just 'me') then add :admin suffix in the scope (e.g. meeting:read:admin)

      • meeting:read
      • meeting:write
      • user:read
      • user:write
      • user_info:read
      • meeting:read
      • chat_channel:read
      • chat_channel:write
      • chat_contact:read
      • chat_message:read
      • chat_message:write
      • contact:read
      • pac:read
      • pac:write
      • phone:read
      • phone:write
      • phone_call_control:read
      • phone_call_control:write
      • phone_call_log:read
      • phone_call_log:write
      • phone_e911:read
      • phone_recording:read
      • phone_recording:write
      • phone_sms:read
      • phone_sms:write
      • phone_voicemail:read
      • phone_voicemail:write
      • recording:read
      • recording:write
      • tsp:read
      • tsp:write
      • user:read
      • user:write
      • user_info:read
      • user_zak:read
      • webinar:read
      • webinar:write
      • report:read:user
   9. Click Generate Token button on Connection Manager UI to generate tokens.
   10. That's it!

   API Connection Manager configuration

   Just perform these simple steps to finish authentication configuration:

   1. Set Authentication Type to User Credentials (Access Your Data) - With Legacy Scopes [OAuth]
   2. Optional step. Modify API Base URL if needed (in most cases default will work).
   3. Fill in all the required parameters and set optional parameters if needed.
   4. Press Generate Token button to generate the tokens.
   5. Finally, hit OK button:

   ZoomDSN

   Zoom

   User Credentials (Access Your Data) - With Legacy Scopes [OAuth]

   https://api.zoom.us/v2

   Required Parameters
   ClientId	Fill-in the parameter...
   ClientSecret	Fill-in the parameter...
   RedirectUrl	Fill-in the parameter...
   TokenUrl	Fill-in the parameter...
   AuthorizationUrl	Fill-in the parameter...
   Optional Parameters
   Scope
   RetryMode	RetryWhenStatusCodeMatch
   RetryStatusCodeList	429
   RetryCountMax	5
   RetryMultiplyWaitTime	True

   

6. Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

   

   ZappySys API Driver - Zoom

   Zoom Connector can be used to integrate Zoom REST API in your App / BI Tools. You can read/write data about Meetings, Invite, Users, Accounts and more.

   ZoomDSN

   

7. Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in C# to retrieve data from Zoom. Hit OK button to use this query in the next step.

   SELECT *  FROM Meetings 
   WITH(
     UserId ='me' -- enter user id or email
   )
   --You can get UserId by selecting from 'list_users' endpoint and also this value available as dropdown value for UserId parameter.

   
   Some parameters configured in this window will be passed to the Zoom API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.

8. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in C#:

   

   ZappySys API Driver - Zoom

   Zoom Connector can be used to integrate Zoom REST API in your App / BI Tools. You can read/write data about Meetings, Invite, Users, Accounts and more.

   ZoomDSN

   SELECT *  FROM Meetings 
   WITH(
     UserId ='me' -- enter user id or email
   )
   --You can get UserId by selecting from 'list_users' endpoint and also this value available as dropdown value for UserId parameter.

   
   You can also access data quickly from the tables dropdown by selecting <Select table>.
   A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Zoom API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Zoom servers).

9. Click OK to finish creating the data source.

Video Tutorial

Read data in C#

Using ODBC DSN

1. Use this code snippet to read the data using ZoomDSN data source:

   "ZoomDSN" ;

   

2. Press F5 to run the code and read the data:
   

3. Here is the code in text format:

   using System;
   using System.Data.Odbc;
   
   namespace ConsoleApp {
       class Program {
           static void Main() {
               var dsn = "ZoomDSN";
               using (var conn = new OdbcConnection(String.Format("DSN={0}", dsn)))
               {
                   conn.Open();
                   var cmd = new OdbcCommand("SELECT * FROM Products", conn);
                   
                   //Increase the timeout duration from the default 30 seconds, which may be insufficient in certain scenarios
                   cmd.CommandTimeout=600; // 600-Seconds
                   
                   var rdr = cmd.ExecuteReader();
                   while (rdr.Read())
                   {
                       for (int i = 0; i < rdr.FieldCount; i++)
                       {
                               Console.Write("{0}\t", rdr[i]);
                       }
                       Console.WriteLine();
                   }
               }
               Console.ReadKey();
           }
       }
   }
   

Using a full ODBC connection string

If you want to avoid being dependent on a DSN and creating multiple DSNs for each platform (x86, x64), then you can use a fully qualified connection string. Simply go to your DSN and copy the Connection String:

1. Open ODBC data source configuration and click Copy settings:
   

   ZappySys API Driver - Configuration [Version: 2.0.1.10418]

   ZappySys API Driver - Zoom

   Zoom Connector can be used to integrate Zoom REST API in your App / BI Tools. You can read/write data about Meetings, Invite, Users, Accounts and more.

   ZoomDSN

   
2. The window opens, telling us the connection string was successfully copied to the clipboard:

3. Then in your C# code, pass the connection string as an argument when calling the OdbcConnection object's constructor, for example:

   var connectionString = @"DRIVER={ZappySys API Driver};ServiceUrl=https://api.zoom.us/v2;Provider=Custom;AuthorizeInFullBrowser=True;OAuthVersion=OAuth2;";
   
   using (var conn = new OdbcConnection(connectionString))
   {
       // your code goes here
   }

Limitations of using a full connection string

Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:

"Connection string exceeds maximum allowed length of 1024"

But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:

1. Open your ODBC data source.
2. Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
3. Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
4. Continue by pasting the copied connection string into a newly created file and save it.
5. Finally, the last step! Just construct a shorter ODBC connection string using this format:

   DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt

6. Our troubles are over! Now you should be able to use this connection string in C# with no problems.

Centralized data access via Data Gateway

In some situations, you may need to provide Zoom data access to multiple users or services. Configuring the data source on a Data Gateway creates a single, centralized connection point for this purpose.

This configuration provides two primary advantages:

• Centralized data access
  The data source is configured once on the gateway, eliminating the need to set it up individually on each user's machine or application. This significantly simplifies the management process.
• Centralized access control
  Since all connections route through the gateway, access can be governed or revoked from a single location for all users.

If you need any of these requirements, you will have to create a data source in Data Gateway to connect to Zoom, and to create an ODBC data source to connect to Data Gateway in C#.

Let's not wait and get going!

Creating Zoom data source in Gateway

In this section we will create a data source for Zoom in Data Gateway. Let's follow these steps to accomplish that:

1. Search for gateway in Windows Start Menu and open ZappySys Data Gateway Configuration:

   

2. Go to Users tab and follow these steps to add a Data Gateway user:

   • Click Add button
   • In Login field enter username, e.g., john
   • Then enter a Password
   • Check Is Administrator checkbox
   • Click OK to save
   

3. Now we are ready to add a data source:

   • Click Add button
   • Give Datasource a name (have it handy for later)
   • Then select Native - ZappySys API Driver
   • Finally, click OK
   ZoomDSN

   ZappySys API Driver

   

4. When the ZappySys API Driver configuration window opens, configure the Data Source the same way you configured it in ODBC Data Sources (64-bit), in the beginning of this article.

5. Very important step. Now, after creating or modifying the data source make sure you:

   • Click the Save button to persist your changes.
   • Hit Yes, once asked if you want to restart the Data Gateway service.

   This will ensure all changes are properly applied:

   
   Skipping this step may result in the new settings not taking effect and, therefore you will not be able to connect to the data source.

Creating ODBC data source for Data Gateway

In this part we will create ODBC data source to connect to Data Gateway from C#. To achieve that, let's perform these steps:

1. Open ODBC Data Sources (x64):

   

2. Create a User data source (User DSN) based on ODBC Driver 17 for SQL Server:

   ODBC Driver 17 for SQL Server

   
   If you don't see ODBC Driver 17 for SQL Server driver in the list, choose a similar version driver.

3. Then set a Name of the data source (e.g. Gateway) and the address of the Data Gateway:

   GatewayDSN

   localhost,5000

   
   Make sure you separate the hostname and port with a comma, e.g. localhost,5000.

4. Proceed with authentication part:

   • Select SQL Server authentication
   • In Login ID field enter the user name you used in Data Gateway, e.g., john
   • Set Password to the one you configured in Data Gateway
   

5. Then set the default database property to ZoomDSN (the one we used in Data Gateway):

   ZoomDSN

   

6. Continue by checking Trust server certificate option:

   

7. Once you do that, test the connection:

   

8. If connection is successful, everything is good:

   

9. Done!

We are ready to move to the final step. Let's do it!

Accessing data in C# via Data Gateway

Finally, we are ready to read data from Zoom in C# via Data Gateway. Follow these final steps:

1. Go back to C#.

2. Use this code snippet to read the data using GatewayDSN data source:

   "GatewayDSN" ;

   

3. Read the data the same way we discussed at the beginning of this article.

4. That's it!

Now you can connect to Zoom data in C# via the Data Gateway.

Actions supported by Zoom Connector

Learn how to perform common Zoom actions directly in C# with these how-to guides:

• GET Current User (Me)
• Get Meeting By Id
• GET Settings
• Get Webinar Settings
• Get Webinar Settings By Id
• List Meeting Registrants
• List Meetings
• List Meetings (All Users)
• List Past Meetings (All Users)
• List Registration Questions
• List Users
• List Webinar Registrants
• List Webinars
• Past Meeting
• Make Generic API Request
• Make Generic API Request (Bulk Write)

Conclusion

In this article we showed you how to connect to Zoom in C# and integrate data without any coding, saving you time and effort.

We encourage you to download Zoom Connector for C# and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download Zoom Connector for C# Documentation

More integrations

Other connectors for C#

Amazon Ads

Amazon Athena

Amazon Selling Partner (SP-API)

Apache Derby

Apache Hive

Apache Spark

Asana

Azure DevOps

Cosmos DB

Dropbox

ElasticSearch

FastSpring

Gmail

Google Ads

Google BigQuery

Google Calendar

Google Drive

Google Search Console

Google Sheets

Hubspot

Infor Data Lake

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

MariaDB

OData

OneDrive

Outlook Mail (Office 365)

Parquet (DuckDB)

Power BI

ServiceNow

SharePoint Online

Shopify

Smartsheet

Starburst

Stripe

Trino

YouTube

Zendesk

Zoho CRM

Zoho SalesIQ

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Build your own Custom API Connector

Other application integration scenarios for Zoom

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

Python

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC