Zoom Connector for C#

In this article you will learn how to integrate Zoom data in C# (live / bi-directional connection to 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..

Using Zoom Connector you will be able to connect, read, and write data from within C#. Follow the steps below to see how we would accomplish that.

Download Documentation

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. Install ZappySys ODBC PowerPack.

  2. Open ODBC Data Sources (x64):
    Open ODBC Data Source

  3. Create a User Data Source (User DSN) based on ZappySys API Driver

    ZappySys API Driver
    Create new User DSN for ZappySys API Driver
    You should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version.
  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
    ODBC DSN Template Selection

  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.

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

    Steps to get Zoom Credentials : OAuth Authentication [OAuth]

    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 :
      • meeting:read;
      • meeting:write;
      • user:read;
      • user:write;
      • user_info:read;
      • meeting:read:admin;
      • 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
    9. Click Generate Token button on Connection Manager UI to generate tokens.
    10. That's it!

    Fill in all required parameters and set optional parameters if needed:

    ZoomDSN
    Zoom
    OAuth Authentication [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 Fill in the parameter...
    RetryMode Fill in the parameter...
    RetryStatusCodeList Fill in the parameter...
    RetryCountMax Fill in the parameter...
    RetryMultiplyWaitTime Fill in the parameter...
    ODBC DSN Oauth Connection Configuration

  6. Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
    ODBC ZappySys Data Source Preview

  7. Click OK to finish creating the data source.

Video instructions

Read data in C#

Using ODBC DSN

  1. Create a new Console project and use this code to read the data:

    "ZoomDSN";
    Make ZappySys Driver call in c#

  2. Press F5 to run the code and read the data:
    ZappySys Driver Output in c#

  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 - 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
    Copy connection string for ODBC application
  2. The window opens, telling us the connection string was successfully copied to the clipboard: Successful connection string copying for ODBC application
  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};SomeProperty=12345;AnotherProperty=some_value;";
    
    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. It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If it happens you use such API, you may get this error:

"Connection string exceeds maximum allowed length of 1024"

But there is a solution to this by storing the Refresh Token in a file instead of directly in ODBC connection string. Follow the steps below to achieve this.

  1. Open your ODBC data source
  2. Hit Advanced tab and enter a file path:
    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
    Configure Refresh Token in ODBC data source
    If you cannot find the Advanced tab, try looking for Click to Configure link in Properties tab, under URL text box. Click it, and then configure the file path in OAuth Grant Options tab.
  3. Then click Copy settings button to copy a full connection string and paste it into your script.
  4. Proceed by pasting the connection string into your C# code as an argument when calling the OdbcConnection object's constructor.
  5. Remove long AccessToken and RefreshToken properties from the connection string, and leave RefreshTokenFile property intact together with all the other properties:
    var connectionString = "Driver={ZappySys API Driver};RefreshTokenFile=C:\Users\john\Documents\tokens.txt;SomeProperty=12345;AnotherProperty=some_value;[AllOtherProperties=...]";
        using (var conn = new OdbcConnection(connectionString))
        {
            // your code goes here
        }
    AccessToken and RefreshToken will be stored in C:\Users\john\Documents\tokens.txt, specified by RefreshTokenFile property.
  6. Our troubles are over, now you should be able to execute the script with no problems.

Advanced topics

Create Custom Stored Procedure in ZappySys Driver

You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.

Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Stored Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Stored Procedure Name

  3. Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
    Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

    CREATE PROCEDURE [usp_get_orders]
        @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>'
     AS
        SELECT * FROM Orders where OrderDate >= '<@fromdate>';
    

    ZappySys Driver - Create Custom Stored Procedure

  4. That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:

    Exec usp_get_orders '1996-01-01';

    ZappySys Driver - Execute Custom Stored Procedure

  5. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')

    ZappySys Driver - Generate SQL Server Query

  6. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Create Custom Virtual Table in ZappySys Driver

ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
    Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here

    SELECT
      "ShipCountry",
      "OrderID",
      "CustomerID",
      "EmployeeID",
      "OrderDate",
      "RequiredDate",
      "ShippedDate",
      "ShipVia",
      "Freight",
      "ShipName",
      "ShipAddress",
      "ShipCity",
      "ShipRegion",
      "ShipPostalCode"
    FROM "Orders"
    Where "ShipCountry"='USA'

    ZappySys Driver - Create Custom Table

  5. That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:

    SELECT * FROM "vt__usa_orders_only"

    ZappySys Driver - Execute Custom Virtual Table Query

  6. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.

    SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')

    ZappySys Driver - Generate SQL Server Query

  7. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Actions supported by Zoom Connector

Zoom Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.
 GET Settings
Retrieve a user's settings. For user-level apps, pass the me value instead of the userId parameter.    [Read more...]
Parameter Description
UserId The user ID or email address of the user. For user-level apps, pass the me value.
 List Meetings
Get the list of scheduled meetings. For current user (me) or specified user Id. To get more details about a meeting you can call get_meeting EndPoint.    [Read more...]
Parameter Description
UserId The user ID or email address of the user. For user-level apps, pass the me value.
 Get Meeting By Id
The Meeting Id or email address of the user. For user-level apps, pass the me value.    [Read more...]
Parameter Description
MeetingId The Meeting ID for which you want to get details.
 List Meeting Registrants
A host or a user with admin permission can require registration for a Zoom meeting. Use this API to list users that have registered for a meeting.    [Read more...]
Parameter Description
UserId Only Used to list Meetings in the UI
MeetingId The Meeting ID for which you want to get details.
 Past Meeting
Use this API to get information about a past meeting.    [Read more...]
Parameter Description
MeetingId The Meeting ID for which you want to get details.
 List Registration Questions
List registration questions that will be displayed to users while registering for a meeting.    [Read more...]
Parameter Description
MeetingId The Meeting ID for which you want to get details.
 List Users
Use this API to list your account's users.'s users    [Read more...]
 List Webinars
Use this API to list all the webinars scheduled by or on-behalf a user (webinar host). For user-level apps, pass the me value instead of the userId parameter.    [Read more...]
Parameter Description
UserId The user ID or email address of the user. For user-level apps, pass the me value.
 Get Webinar Settings
Use this API to get settings details of a scheduled webinar.    [Read more...]
Parameter Description
WebinarId The Webinar ID for which you want to get details.
 Get Webinar Settings By Id
Use this API to get details of a scheduled webinar.    [Read more...]
Parameter Description
WebinarId The Webinar ID for which you want to get details.
 List Webinar Registrants
Use this API to list all the users that have registered for a webinar.    [Read more...]
Parameter Description
WebinarId The Webinar ID for which you want to get details.
 Generic Request
This is generic endpoint. Use this endpoint when some actions are not implemented by connector. Just enter partial URL (Required), Body, Method, Header etc. Most parameters are optional except URL.    [Read more...]
Parameter Description
Url API URL goes here. You can enter full URL or Partial URL relative to Base URL. If it is full URL then domain name must be part of ServiceURL or part of TrustedDomains
Body Request Body content goes here
IsMultiPart Set this option if you want to upload file(s) (i.e. POST RAW file data) or send data using Multi-Part encoding method (i.e. Content-Type: multipart/form-data). Multi-Part request allows you to mix key/value and upload files in same request. On the other hand raw upload allows only single file upload (without any key/value) ==== Raw Upload (Content-Type: application/octet-stream) ===== To upload single file in raw mode check this option and specify full file path starting with @ sign in the Body (e.g. @c:\data\myfile.zip ) ==== Form-Data / Multipart Upload (Content-Type: multipart/form-data) ===== To treat your Request data as multi part fields you must specify key/value pairs separated by new lines into RequestData field (i.e. Body). Each key value pair is entered on new-line and key/value are separated using equal sign (=). Preceding and trailing spaces are ignored also blank lines are ignored. If field value has some any special character(s) then use escape sequence (e.g. For NewLine: \r\n, For Tab: \t, For at (@): \@). When value of any field starts with at sign (@) its automatically treated as File you want to upload. By default file content type is determined based on extension however you can supply content type manually for any field using this way [ YourFileFieldName.Content-Type=some-content-type ]. By default File Upload Field always includes Content-Type in the request (non file fields do not have content-type by default unless you supply manually). For some reason if you dont want to use Content-Type header in your request then supply blank Content-Type to exclude this header altogather [e.g. SomeFieldName.Content-Type= ]. In below example we have supplied Content-Type for file2 and SomeField1, all other fields are using default content-type. See below Example of uploading multiple files along with additional fields. If some API requires you to pass Content-Type: multipart/form-data rather than multipart/form-data then manually set Request Header => Content-Type: multipart/mixed (it must starts with multipart/ else will be ignored). file1=@c:\data\Myfile1.txt file2=@c:\data\Myfile2.json file2.Content-Type=application/json SomeField1=aaaaaaa SomeField1.Content-Type=text/plain SomeField2=12345 SomeFieldWithNewLineAndTab=This is line1\r\nThis is line2\r\nThis is \ttab \ttab \ttab SomeFieldStartingWithAtSign=\@MyTwitterHandle
Filter Enter filter to extract array from response. Example: $.rows[*] --OR-- $.customers[*].orders[*]. Check your response document and find out hierarchy you like to extract
Headers Headers for Request. To enter multiple headers use double pipe or new line after each {header-name}:{value} pair

Zoom Connector Examples for C# Connection

This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.

List Users    [Read more...]

Lists all available Users for organization level

SELECT * FROM Users

Get Settings    [Read more...]

Get the user settings by by user id

SELECT * FROM UserSettings
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.

List Meetings    [Read more...]

List all the meetings for a selected User

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.

Get Meeting    [Read more...]

Select a meeting from the list_meetings by providing meeting id

SELECT * FROM Meetings Where id=1234
--You can get id by selecting from 'list_meetings' endpoint and also this value available as dropdown value for MeetingId parameter.

List Meeting Registrants    [Read more...]

Select a meeting registants for the specific meeting id

SELECT * FROM MeetingRegistrants
WITH(
  MeetingId='1234'
)
--You can get MeetingId by selecting from 'list_meetings' endpoint and also this value available as dropdown value for MeetingId parameter.

List Past Meeting Registrants    [Read more...]

Select a past meeting registants for the specific meeting id

SELECT * FROM PastMeetingRegistrants
				
			WITH(
					  MeetingId='123456'
				)
				--You can get MeetingId by selecting from 'list_meetings' endpoint and also this value available as dropdown value for MeetingId parameter.

List Registration Questions    [Read more...]

Select a meeting registants questions for the specific meeting id

SELECT * FROM RegistrationQuestions

				WITH(
					  MeetingId='123456'
				)
				--You can get MeetingId by selecting from 'list_meetings' endpoint and also this value available as dropdown value for MeetingId parameter.

List Webinars    [Read more...]

Lists all available Webinars for a selected User with webinars access rights

SELECT *  FROM Webinars
				
				WITH(
					  UserId='test' -- 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.

List Webinar Registrants    [Read more...]

Select a webinar registants for the specific webinar id

SELECT * FROM [WebinarRegistrants]
					WITH(
				 WebinarId='123456'
				)
				--You can get WebinarId by selecting from 'list_webinars' endpoint and also this value avialable as dropdown value for MeetingId parameter.

Get Webinar    [Read more...]

Select a webinar from the list_webinars by providing webinar id

SELECT * FROM Webinars Where id=1234
				--You can get id by selecting from 'list_webinars' endpoint and also this value available as dropdown value for WebinarId parameter.

Get Webinar Settings    [Read more...]

Select a webinar from the list_webinars by providing webinar id

SELECT * FROM WebinarSettings

					WITH(
						  WebinarId='85463711883'
					)
				--You can get WebinarId by selecting from 'list_webinars' endpoint and also this value available as dropdown value for WebinarId parameter.

Conclusion

In this article we discussed how to connect to Zoom in C# and integrate data without any coding. Click here to Download Zoom Connector for C# and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download Zoom Connector for C# Documentation 

More integrations

Other application integration scenarios for Zoom

Other connectors for C#


Download Zoom Connector for C# Documentation

  • How to connect Zoom in C#?

  • How to get Zoom data in C#?

  • How to read Zoom data in C#?

  • How to load Zoom data in C#?

  • How to import Zoom data in C#?

  • How to pull Zoom data in C#?

  • How to push data to Zoom in C#?

  • How to write data to Zoom in C#?

  • How to POST data to Zoom in C#?

  • Call Zoom API in C#

  • Consume Zoom API in C#

  • Zoom C# Automate

  • Zoom C# Integration

  • Integration Zoom in C#

  • Consume real-time Zoom data in C#

  • Consume real-time Zoom API data in C#

  • Zoom ODBC Driver | ODBC Driver for Zoom | ODBC Zoom Driver | SSIS Zoom Source | SSIS Zoom Destination

  • Connect Zoom in C#

  • Load Zoom in C#

  • Load Zoom data in C#

  • Read Zoom data in C#

  • Zoom API Call in C#