Zoom connector specifications

December 11, 2020

Contributed by:

Deploy the Citrix Zoom integration to schedule meetings instantly from anywhere and from any device or intranet.

Version Details

Citrix Zoom microapps support the latest api.zoom.us/v2: https://marketplace.zoom.us/docs/api-reference/zoom-api

Endpoints

Note:

Custom API endpoints are not supported.

POST

<https://zoom.us/oauth/authorize>
<https://zoom.us/oauth/token>
/users/\{\{userId\}\}/meetings

GET

users
users/\{\{userid\}\}/meetings
meetings/\{\{meetingid\}\}/invitation
meetings/\{\{meetingId\}\}
meetings/\{\{meetingid\}\}

Service Actions

Create Meeting - This service action helps the user to schedule a meeting with pertinent details, such as meeting topic, start time, duration, password etc.
Create Meeting Two Co-organizers - This service action helps the user to schedule a meeting with two co-organizer along with pertinent details, such as meeting topic, start time, duration, password, co-organizer etc.

Key Entities

The following are the main business entities that this connector addresses:

users
meetings
meeting_details_one_time
meeting_details_recurring
meeting_invitations

Entities with Attributes

The following is a full list of entities and their attributes:

users

created_at: TIMESTAMP, IGNORED
email: STRING(255)
first_name: STRING(255)
language: STRING(255), IGNORED
last_login_time: TIMESTAMP
last_name: STRING(255)
phone_number: STRING(255), IGNORED
pmi: LONG, IGNORED
status: STRING(255), IGNORED
timezone: STRING(255)
type: INTEGER, IGNORED
userid: STRING(255), FK(meeting_details_recurring.host_id)
verified: INTEGER, IGNORED

meetings

agenda: STRING(255), IGNORED
created_at: TIMESTAMP
duration: INTEGER
host_id: STRING(255)
id: LONG
join_url: STRING(255)
start_time: TIMESTAMP
timezone: STRING(255)
topic: STRING(255)
type: INTEGER
users_created_at: TIMESTAMP, IGNORED
users_email: STRING(255)
users_first_name: STRING(255)
users_language: STRING(255), IGNORED
users_last_login_time: TIMESTAMP
users_last_name: STRING(255)
users_phone_number: STRING(255), IGNORED
users_pmi: LONG, IGNORED
users_status: STRING(255), IGNORED
users_timezone: STRING(255), IGNORED
users_type: INTEGER, IGNORED
users_userid: STRING(255), IGNORED
users_verified: INTEGER, IGNORED
uuid: STRING(255), IGNORED

meeting_invitations

agenda: STRING(255), IGNORED
created_at: TIMESTAMP, IGNORED
duration: INTEGER, IGNORED
host_id: STRING(255), IGNORED
id: LONG, FK(meeting_details_recur_1.parent_id)
invitation: BINARY
join_url: STRING(255), IGNORED
start_time: TIMESTAMP, IGNORED
timezone: STRING(255), IGNORED
topic: STRING(255)
type: INTEGER, IGNORED
users_created_at: TIMESTAMP, IGNORED
users_email: STRING(255)
users_first_name: STRING(255)
users_language: STRING(255), IGNORED
users_last_login_time: TIMESTAMP, IGNORED
users_last_name: STRING(255)
users_phone_number: STRING(255), IGNORED
users_pmi: LONG, IGNORED
users_status: STRING(255), IGNORED
users_timezone: STRING(255), IGNORED
users_type: INTEGER, IGNORED
users_userid: STRING(255), IGNORED
users_verified: INTEGER, IGNORED
uuid: STRING(255), IGNORED

meeting_details_recurring

agenda: STRING(255), IGNORED
created_at: TIMESTAMP
encrypted_password: STRING(255), IGNORED
h_323_password: STRING(255), IGNORED
host_id: STRING(255), FK(meeting_details_one_time.host_id)
id: LONG
join_url: STRING(255)
password: STRING(255)
pstn_password: STRING(255), IGNORED
recurrence_end_times: INTEGER
recurrence_monthly_day: STRING(255)
recurrence_repeat_interva: INTEGER
recurrence_type: INTEGER
recurrence_weekly_days: STRING(255)
settings_alternative_host: STRING(255)
settings_approval_type: INTEGER, IGNORED
settings_audio: STRING(255), IGNORED
settings_auto_recording: STRING(255), IGNORED
settings_close_registrati: BOOLEAN, IGNORED
settings_cn_meeting: BOOLEAN, IGNORED
settings_enforce_login: BOOLEAN, IGNORED
settings_enforce_login_do: STRING(255), IGNORED
settings_host_video: BOOLEAN, IGNORED
settings_in_meeting: BOOLEAN, IGNORED
settings_join_before_host: BOOLEAN, IGNORED
settings_meeting_authenti: BOOLEAN, IGNORED
settings_mute_upon_entry: BOOLEAN, IGNORED
settings_participant_vide: BOOLEAN, IGNORED
settings_registrants_conf: BOOLEAN, IGNORED
settings_registrants_emai: BOOLEAN, IGNORED
settings_request_permissi: BOOLEAN, IGNORED
settings_use_pmi: BOOLEAN, IGNORED
settings_waiting_room: BOOLEAN, IGNORED
settings_watermark: BOOLEAN, IGNORED
start_url: BINARY
status: STRING(255), IGNORED
timezone: STRING(255)
topic: STRING(255)
type: INTEGER
uuid: STRING(255), IGNORED

meeting_details_recur_1

duration: INTEGER
occurrence_id: LONG
start_time: TIMESTAMP
status: STRING(255), IGNORED
parent_id: LONG, FK(meeting_details_recurring.id)
unique_id: STRING(36)
root_id: LONG

meeting_details_recur_2

value: STRING(255)
parent_id: LONG, FK(meeting_details_recurring.id)
unique_id: STRING(36)
root_id: LONG

meeting_details_recur_3

country: STRING(255)
country_name: STRING(255)
number: STRING(255)
type: STRING(255)
parent_id: LONG, FK(meeting_details_recurring.id)
unique_id: STRING(36)
root_id: LONG

meeting_details_one_time

agenda: STRING(255), IGNORED
created_at: TIMESTAMP
duration: INTEGER
encrypted_password: STRING(255), IGNORED
h_323_password: STRING(255), IGNORED
host_id: STRING(255)
id: LONG
join_url: STRING(255)
password: STRING(255)
pstn_password: STRING(255), IGNORED
recurrence_monthly_day: STRING(255)
recurrence_weekly_days: STRING(255)
settings_alternative_host: STRING(255)
settings_approval_type: INTEGER, IGNORED
settings_audio: STRING(255), IGNORED
settings_auto_recording: STRING(255), IGNORED
settings_close_registrati: BOOLEAN, IGNORED
settings_cn_meeting: BOOLEAN, IGNORED
settings_enforce_login: BOOLEAN, IGNORED
settings_enforce_login_do: STRING(255), IGNORED
settings_host_video: BOOLEAN, IGNORED
settings_in_meeting: BOOLEAN, IGNORED
settings_join_before_host: BOOLEAN, IGNORED
settings_meeting_authenti: BOOLEAN, IGNORED
settings_mute_upon_entry: BOOLEAN, IGNORED
settings_participant_vide: BOOLEAN, IGNORED
settings_registrants_conf: BOOLEAN, IGNORED
settings_registrants_emai: BOOLEAN, IGNORED
settings_request_permissi: BOOLEAN, IGNORED
settings_use_pmi: BOOLEAN, IGNORED
settings_waiting_room: BOOLEAN, IGNORED
settings_watermark: BOOLEAN, IGNORED
start_time: TIMESTAMP
start_url: BINARY
status: STRING(255), IGNORED
timezone: STRING(255)
topic: STRING(255)
type: INTEGER
uuid: STRING(255), IGNORED

meeting_details_one_t_1

value: STRING(255)
parent_id: LONG, FK(meeting_details_one_time.id)
unique_id: STRING(36)
root_id: LONG

meeting_details_one_t_2

country: STRING(255)
country_name: STRING(255)
number: STRING(255)
type: STRING(255)
parent_id: LONG, FK(meeting_details_one_time.id)
unique_id: STRING(36)
root_id: LONG

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Zoom connector specifications

December 11, 2020

Contributed by:

December 11, 2020

Contributed by:

Zoom connector specifications

Version Details

Endpoints

Service Actions

Key Entities

Entities with Attributes

In this article