How to use Zoom module

Zoom module allows working with Zoom API (https://marketplace.zoom.us/docs/guides/).

Zoom Module Installation

API Key and Secret Key of your Zoom application are needed to be retrieved firstly (https://marketplace.zoom.us/develop/create?source=devdocs). Following the link you will see several types of Zoom apps for selection.

Zoom’s app API Key and Secret Key will be shown after app type selection.

Meeting and Recurrence Data Models

When you install the Zoom module, two virtual data models are also created in the project: Meeting and Recurrence. The first refers to the video call object itself, and Recurrence is responsible for the regularity (recurrence) of this video meeting. The following BPs are auxiliary in the creation and use of these data models:

• Make Zoom Meeting - creates an object of Meeting data model type:
  • Join_url [string] - meeting link;
  • start_time [datetime] - meeting start time;
  • Status [string] - status of the meeting;
  • Type [enum] - meeting type
    • Instant - unscheduled, one-time meeting
    • Scheduled - scheduled meeting
    • Recurring with no fixed time - recurring meeting with no fixed time
    • Recurring with fixed time - recurring with fixed time
  • Meeting_id [integer] - meeting identifier;
  • Agenda [string] - meeting agenda info;
  • Topic [string] - meeting topic;
  • Recurrence [recurrence type of object] - object of Recurrence data model type;
  • Password [string] - meeting password;

• Expand Zoom Meeting - expands an object of Meeting data model type;
  • Join_url [string] - meeting link;
  • start_time [datetime] - meeting start time;
  • Status [string] - status of the meeting;
  • Type [enum] - meeting type
    • Instant - unscheduled, one-time meeting
    • Scheduled - scheduled meeting
    • Recurring with no fixed time - recurring meeting with no fixed time
    • Recurring with fixed time - recurring with fixed time
  • Meeting_id [integer] - meeting identifier;
  • Agenda [string] - meeting agenda info;
  • Topic [string] - meeting topic;
  • Recurrence [recurrence type of object] - object of Recurrence data model type;
  • Password [string] - meeting password;

• Make Zoom Recurrence - creates an object of Recurrence data model type;
  • Type [enum] - type of recurrence
    • Daily
    • Weekly
    • Monthly
  • Ends_time [integer] - the number of times the recurring meeting will occur before it is canceled, between a value of 1 and 50. You cannot use this key with the end_date_time key.
  • Monthly_day [integer] - required only for monthly recurring meetings. The day of the month on which a recurring meeting occurs, between 1 to 31.
  • Weekly_days [enum] - required only for weekly recurring meetings (1 - Monday, 2 - Tuesday, … , 7 - Sunday).
  • Repeat_interval [integer] - the meeting's repeat interval. For a daily interval, a max of 90 days. For a weekly interval, a max of 12 weeks.
  • End_date_time [datetime] - the recurring meeting's final ending date and time before it is canceled, in UTC format. You cannot use this key with the end_times key.

• Expand Zoom Recurrence - expands an object of Recurrence data model type;
  • Type [enum] - type of recurrence
    • Daily
    • Weekly
    • Monthly
  • Ends_time [integer] - the number of times the recurring meeting will occur before it is canceled, between a value of 1 and 50. You cannot use this key with the end_date_time key.
  • Monthly_day [integer] - required only for monthly recurring meetings. The day of the month on which a recurring meeting occurs, between 1 to 31.
  • Weekly_days [enum] - required only for weekly recurring meetings (1 - Monday, 2 - Tuesday, … , 7 - Sunday).
  • Repeat_interval [integer] - the meeting's repeat interval. For a daily interval, a max of 90 days. For a weekly interval, a max of 12 weeks.
  • End_date_time [datetime] - the recurring meeting's final ending date and time before it is canceled, in UTC format. You cannot use this key with the end_times key.

Business Processes which work with Zoom Module

Pre-installed Zoom module business processes are available for the application backend only:

• Zoom: Get meeting - gets meeting object with the given identifier:
  • Meeting_id [integer] - meeting identifier;

• Zoom: Delete meeting - deletes meeting record from the DB with the given identifier;
  • Meeting_id [integer] (required) - meeting identifier;

• Zoom: Update meeting - updates meeting object in the DB with the given identifier:
  • Meeting_id [integer] (required) - meeting identifier;
  • Topic [string] - meeting topic;
  • Type [enum] - meeting type
    • Instant - unscheduled, one-time meeting
    • Scheduled - scheduled meeting
    • Recurring with no fixed time - recurring meeting with no fixed time
    • Recurring with fixed time - recurring with fixed time
  • start_time [datetime] - meeting start time;
  • Join_url [string] - meeting link;
  • Password [string] - meeting password;
  • Agenda [string] - meeting agenda info;
  • Recurrence [recurrence type of object] - object of Recurrence data model type;

• Zoom: Create Meeting - creates an object of Meeting data model type:
  • Type [enum] - meeting type
    • Instant - unscheduled, one-time meeting
    • Scheduled - scheduled meeting
    • Recurring with no fixed time - recurring meeting with no fixed time
    • Recurring with fixed time - recurring with fixed time
  • Password [string] - meeting password;
  • Agenda [string] - meeting agenda info;
  • Recurrence [recurrence type of object] - object of Recurrence data model type;
  • User_id [string] (required) - user’s ID or email address.

• Zoom: List meetings - use this API to list a user's (meeting host) scheduled meetings. User is defined with its API_KEY;
  • Page_size [integer] - the number of records returned within a single API call. Is set to 30 by default.
  • Page_number [integer] - the page number of the current page in the returned records. Is set to 1 by default.

Usage example

Let's look at an example of generating a Zoom meeting link on the button click. To use the business processes of the module in the front-end of the application, the first step is to set the Endpoint to create the link generation (Zoom: Create meeting).

1. Create a new group in the Endpoints section.
2. When the group is created you need to make a new Endpoint. Zoom: Create meeting business process should be considered as a POST type of request.
3. In the web application business process the newly created endpoint can be used as on the example below. Here, a link is generated and provided as a Label property of the Label component when the button is clicked (onClick).

Result is shown below: