Zoom Connector
Documentation
Version: 1
Documentation

How to read Zoom data in ODBC application?


In this section we will learn how to configure and use Zoom Connector in the API Driver to extract data from the Zoom.

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

Step-by-step instructions

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

  1. Download and install 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
    • 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
    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 reference]

    Steps how to get and use 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
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN Oauth Connection Configuration

  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:

    - 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
    Open Query Builder in API ODBC Driver to read and write data to REST API
  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 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.
    Configure table/endpoint parameters in ODBC data source based on API Driver
    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 :

    - 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.
    API ODBC Driver-based data source data preview
    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

Reading data from client application

  1. Firstly, to get data from ODBC data source based on ZappySys ODBC driver, in your client application, you would need to connect to ODBC source and then from the list select the data source.
  2. Finally, to read the data just read tables/views in your app or enter a SQL statement to extract data, e.g.:

    SELECT * FROM Users

Zoom Connector Examples

The ZappySys API Driver is a user-friendly interface designed to facilitate the seamless integration of various applications with the Zoom API. With its intuitive design and robust functionality, the ZappySys API Driver simplifies the process of configuring specific API endpoints to efficiently read or write data from Zoom.

Click here to find more Zoom Connector 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.

Consume Data inside your App / Programming Language

Once you know how to load data from Zoom Connector, you can click on one of the below links to learn the steps how to consume data inside your App / Programming Language from Zoom Connector.

ODBC inside ETL / Reporting / BI Tools

ODBC inside Programming Languages

Key features of the ZappySys API Driver include:

The API ODBC driver facilitates the reading and writing of data from numerous popular online services (refer to the complete list here) using familiar SQL language without learning complexity of REST API calls. The driver allows querying nested structure and output as a flat table. You can also create your own ODBC / Data Gateway API connector file and use it with this driver.

  1. Intuitive Configuration: The interface is designed to be user-friendly, enabling users to easily set up the specific API endpoints within Zoom without requiring extensive technical expertise or programming knowledge.

  2. Customizable Endpoint Setup: Users can conveniently configure the API endpoint settings, including the HTTP request method, endpoint URL, and any necessary parameters, to precisely target the desired data within Zoom.

  3. Data Manipulation Capabilities: The ZappySys API Driver allows for seamless data retrieval and writing, enabling users to fetch data from Zoom and perform various data manipulation operations as needed, all through an intuitive and straightforward interface.

  4. Secure Authentication Integration: The driver provides secure authentication integration, allowing users to securely connect to the Zoom API by inputting the necessary authentication credentials, such as API tokens or other authentication keys.

  5. Error Handling Support: The interface is equipped with comprehensive error handling support, ensuring that any errors or exceptions encountered during the data retrieval or writing process are efficiently managed and appropriately communicated to users for prompt resolution.

  6. Data Visualization and Reporting: The ZappySys API Driver facilitates the seamless processing and presentation of the retrieved data from Zoom, enabling users to generate comprehensive reports and visualizations for further analysis and decision-making purposes.

Overall, the ZappySys API Driver serves as a powerful tool for streamlining the integration of applications with Zoom, providing users with a convenient and efficient way to access and manage data, all through a user-friendly and intuitive interface.