├── source ├── includes │ ├── appendix │ │ ├── lists │ │ │ ├── _index.md.erb │ │ │ ├── _premium_countries.md.erb │ │ │ ├── _callout_countries.md.erb │ │ │ ├── _tollfree_countries.md.erb │ │ │ └── _state.md.erb │ │ ├── _index.md.erb │ │ └── _recurrence.md.erb │ ├── billing │ │ ├── index.md.erb │ │ ├── get_accountId_billing.md.erb │ │ ├── post_accountId_plans_addons.md.erb │ │ ├── put_accountId_plans_addons.md.erb │ │ ├── put_accountId_plans_base.md.erb │ │ ├── get_accountId_plans.md.erb │ │ └── patch_accountId_billing.md.erb │ ├── im_chat │ │ ├── index.md.erb │ │ ├── get_chat_sessions.md.erb │ │ └── get_chat_sessions_sessionId.md.erb │ ├── reports │ │ ├── index.md.erb │ │ ├── get_daily.md.erb │ │ ├── get_meetings_meetingId.md.erb │ │ ├── get_webinars_webinarId.md.erb │ │ ├── get_meetings_meetingId_polls.md.erb │ │ ├── get_webinars_webinarId_qa.md.erb │ │ ├── get_webinars_webinarId_polls.md.erb │ │ ├── get_telephone.md.erb │ │ ├── get_users.md.erb │ │ ├── get_webinars_webinarId_participants.md.erb │ │ ├── get_meetings_meetingId_participants.md.erb │ │ └── get_users_userId_meetings.md.erb │ ├── dashboards │ │ ├── index.md.erb │ │ ├── get_crc.md.erb │ │ ├── get_zoomrooms.md.erb │ │ ├── get_webinars_webinarId.md.erb │ │ ├── get_meetings_meetingId.md.erb │ │ ├── get_meetings_meetingId_participants_participantId_sharing.md.erb │ │ ├── get_webinars_webinarId_participants_participantId_sharing.md.erb │ │ ├── get_meetings_meetingId_participants_sharing.md.erb │ │ ├── get_webinars_webinarId_participants_sharing.md.erb │ │ ├── get_im.md.erb │ │ ├── get_webinars.md.erb │ │ ├── get_meetings.md.erb │ │ ├── get_webinars_webinarId_participants.md.erb │ │ ├── get_meetings_meetingId_participants.md.erb │ │ ├── get_zoomrooms_zoomroomId.md.erb │ │ ├── get_meetings_meetingId_participants_participantId_qos.md.erb │ │ └── get_webinars_webinarId_participants_participantId_qos.md.erb │ ├── reference │ │ ├── _before_core.md.erb │ │ ├── _rate_limits.md.erb │ │ ├── _errors.md.erb │ │ ├── _index.md.erb │ │ └── _authentication.md.erb │ ├── groups │ │ ├── index.md.erb │ │ ├── delete_groupId.md.erb │ │ ├── get_.md.erb │ │ ├── get_groupId.md.erb │ │ ├── delete_groupId_members_memberId.md.erb │ │ ├── post_.md.erb │ │ ├── patch_groupId.md.erb │ │ ├── post_groupId_members.md.erb │ │ └── get_groupId_members.md.erb │ ├── webhooks │ │ ├── delete_webhookId.md.erb │ │ ├── patch_options.md.erb │ │ ├── get_webhookId.md.erb │ │ ├── get_.md.erb │ │ ├── index.md.erb │ │ ├── patch_webhookId.md.erb │ │ └── post_.md.erb │ ├── users │ │ ├── post_userId_picture.md.erb │ │ ├── put_userId_picture.md.erb │ │ ├── delete_userId_schedulers.md.erb │ │ ├── delete_userId_token.md.erb │ │ ├── delete_userId_ssoToken.md.erb │ │ ├── delete_userId_assistants.md.erb │ │ ├── get_email.md.erb │ │ ├── get_zpk.md.erb │ │ ├── get_userId_permissions.md.erb │ │ ├── get_vanity_name.md.erb │ │ ├── get_userId_zpk.md.erb │ │ ├── delete_userId_schedulers_schedulerId.md.erb │ │ ├── delete_userId_assistants_assistantId.md.erb │ │ ├── get_userId_schedulers.md.erb │ │ ├── get_userId_assistants.md.erb │ │ ├── put_userId_password.md.erb │ │ ├── put_userId_status.md.erb │ │ ├── post_userId_assistants.md.erb │ │ ├── get_userId_token.md.erb │ │ ├── delete_userId.md.erb │ │ ├── index.md.erb │ │ ├── get_userId.md.erb │ │ ├── patch_userId.md.erb │ │ ├── get_.md.erb │ │ ├── post_.md.erb │ │ └── get_userId_settings.md.erb │ ├── devices │ │ ├── delete_devices_deviceId.md.erb │ │ ├── index.md.erb │ │ ├── get_devices.md.erb │ │ ├── patch_devices_deviceId.md.erb │ │ └── post_devices.md.erb │ ├── im_groups │ │ ├── delete_groups_groupId.md.erb │ │ ├── delete_groups_groupId_members_memberId.md.erb │ │ ├── delete_groups_groupId_members_userId.md.erb │ │ ├── get_groups_groupId.md.erb │ │ ├── get_groups.md.erb │ │ ├── post_groups_groupId_members.md.erb │ │ ├── index.md.erb │ │ ├── get_groups_groupId_members.md.erb │ │ ├── patch_groups_groupId.md.erb │ │ └── post_groups.md.erb │ ├── webinars │ │ ├── delete_webinarId_panelists.md.erb │ │ ├── delete_webinarId.md.erb │ │ ├── delete_webinarId_panelists_panelistId.md.erb │ │ ├── put_webinarId_status.md.erb │ │ ├── get_webinarId_instances.md.erb │ │ ├── get_webinarId_panelists.md.erb │ │ ├── post_webinarId_panelists.md.erb │ │ ├── put_webinarId_registrants_registrantId_status.md.erb │ │ ├── put_webinarId_registrants_status.md.erb │ │ ├── get_userId_webinars.md.erb │ │ ├── get_webinarId.md.erb │ │ ├── get_webinarId_registrants.md.erb │ │ └── post_webinarId_registrants.md.erb │ ├── tsp │ │ ├── delete_userId_tsp_tspId.md.erb │ │ ├── get_.md.erb │ │ ├── get_userId_tsp_tspId.md.erb │ │ ├── get_userId_tsp.md.erb │ │ ├── index.md.erb │ │ ├── patch_userId_tsp_tspId.md.erb │ │ └── post_userId_tsp.md.erb │ ├── meetings │ │ ├── delete_meetingId.md.erb │ │ ├── put_meetingId_status.md.erb │ │ ├── get_meetingUUID.md.erb │ │ ├── put_meetingId_registrants_registrantId_status.md.erb │ │ ├── put_meetingId_registrants_status.md.erb │ │ ├── get_meetingUUID_participants.md.erb │ │ ├── get_userId_meetings.md.erb │ │ ├── get_meetingId.md.erb │ │ ├── get_meetingId_registrants.md.erb │ │ └── post_meetingId_registrants.md.erb │ ├── accounts │ │ ├── delete_accountId.md.erb │ │ ├── get_accountId.md.erb │ │ ├── get_.md.erb │ │ ├── patch_accountId_options.md.erb │ │ ├── index.md.erb │ │ └── post_.md.erb │ ├── cloud_recording │ │ ├── put_meetingId_recordings_status.md.erb │ │ ├── delete_meetingId_recordings.md.erb │ │ ├── put_meetingId_recordings_recordingId_status.md.erb │ │ ├── delete_meetingId_recordings_recordingId.md.erb │ │ ├── index.md.erb │ │ ├── get_meetingId_recordings.md.erb │ │ └── get_userId_recordings.md.erb │ └── pac │ │ ├── index.md.erb │ │ └── get_userId_pac.md.erb ├── fonts │ ├── slate.eot │ ├── slate.ttf │ ├── slate.woff │ ├── slate.woff2 │ └── slate.svg ├── images │ ├── logo.png │ ├── navbar.png │ ├── favicon.ico │ └── logo-blue.png ├── javascripts │ ├── all_nosearch.js │ ├── all.js │ └── app │ │ ├── _toc.js │ │ └── _search.js └── stylesheets │ ├── _icon-font.scss │ ├── print.css.scss │ └── _variables.scss ├── .travis.yml ├── lib └── multilang.rb ├── LICENSE ├── Vagrantfile ├── README.md ├── config.rb └── CHANGELOG.md /source/includes/appendix/lists/_index.md.erb: -------------------------------------------------------------------------------- 1 | # Lists -------------------------------------------------------------------------------- /source/includes/billing/index.md.erb: -------------------------------------------------------------------------------- 1 | # Billing 2 | 3 | -------------------------------------------------------------------------------- /source/includes/im_chat/index.md.erb: -------------------------------------------------------------------------------- 1 | # IM Chat 2 | 3 | -------------------------------------------------------------------------------- /source/includes/reports/index.md.erb: -------------------------------------------------------------------------------- 1 | # Reports 2 | 3 | -------------------------------------------------------------------------------- /source/includes/appendix/_index.md.erb: -------------------------------------------------------------------------------- 1 |
Appendix
-------------------------------------------------------------------------------- /source/includes/dashboards/index.md.erb: -------------------------------------------------------------------------------- 1 | # Dashboards 2 | 3 | -------------------------------------------------------------------------------- /source/includes/reference/_before_core.md.erb: -------------------------------------------------------------------------------- 1 |
Core Resources
-------------------------------------------------------------------------------- /source/fonts/slate.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/zoom/api/HEAD/source/fonts/slate.eot -------------------------------------------------------------------------------- /source/fonts/slate.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/zoom/api/HEAD/source/fonts/slate.ttf -------------------------------------------------------------------------------- /source/images/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/zoom/api/HEAD/source/images/logo.png -------------------------------------------------------------------------------- /source/fonts/slate.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/zoom/api/HEAD/source/fonts/slate.woff -------------------------------------------------------------------------------- /source/fonts/slate.woff2: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/zoom/api/HEAD/source/fonts/slate.woff2 -------------------------------------------------------------------------------- /source/images/navbar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/zoom/api/HEAD/source/images/navbar.png -------------------------------------------------------------------------------- /source/images/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/zoom/api/HEAD/source/images/favicon.ico -------------------------------------------------------------------------------- /source/images/logo-blue.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/zoom/api/HEAD/source/images/logo-blue.png -------------------------------------------------------------------------------- /source/javascripts/all_nosearch.js: -------------------------------------------------------------------------------- 1 | //= require ./lib/_energize 2 | //= require ./app/_lang 3 | //= require ./app/_toc 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | 3 | language: ruby 4 | 5 | rvm: 6 | - 2.2.5 7 | - 2.3.3 8 | - 2.4.0 9 | 10 | cache: bundler 11 | script: bundle exec middleman build 12 | -------------------------------------------------------------------------------- /source/includes/groups/index.md.erb: -------------------------------------------------------------------------------- 1 | # Groups 2 | 3 | ## The Group object 4 | Group object 5 | 6 | ```json 7 | { 8 | "name": "string", 9 | "total_members": "integer" 10 | } 11 | ``` 12 | 13 | Property | Description 14 | --- | --- 15 | name *string* | Group name 16 | total_members *integer* | Total number of members in this group 17 | 18 | -------------------------------------------------------------------------------- /source/includes/appendix/lists/_premium_countries.md.erb: -------------------------------------------------------------------------------- 1 | ## Premium Countries 2 | 3 | ID|Name 4 | ---|--- 5 | CN|China 6 | CR|Costa Rica 7 | IN|India 8 | ID|Indonesia 9 | JM|Jamaica 10 | KW|Kuwait 11 | MO|Macau 12 | NG|Nigeria 13 | PK|Pakistan 14 | PH|Philippines 15 | LK|Sri Lanka 16 | TW|Taiwan 17 | TZ|Tanzania 18 | TH|Thailand 19 | UG|Uganda 20 | VN|Vietnam 21 | ZW|Zimbabwe -------------------------------------------------------------------------------- /lib/multilang.rb: -------------------------------------------------------------------------------- 1 | module Multilang 2 | def block_code(code, full_lang_name) 3 | parts = full_lang_name.split('--') 4 | rouge_lang_name = parts[0] || "" 5 | super(code, rouge_lang_name).sub("highlight #{rouge_lang_name}") do |match| 6 | match + " tab-" + full_lang_name 7 | end 8 | end 9 | end 10 | 11 | require 'middleman-core/renderers/redcarpet' 12 | Middleman::Renderers::MiddlemanRedcarpetHTML.send :include, Multilang 13 | -------------------------------------------------------------------------------- /source/includes/webhooks/delete_webhookId.md.erb: -------------------------------------------------------------------------------- 1 | ## Delete a webhook 2 | 3 | Delete a webhook 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/webhooks/{webhookId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/webhooks/{webhookId} \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | webhookId **required** | The webhook ID 27 | 28 | -------------------------------------------------------------------------------- /source/includes/groups/delete_groupId.md.erb: -------------------------------------------------------------------------------- 1 | ## Delete a group 2 | 3 | Delete a group under your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/groups/{groupId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/groups/{groupId} \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | groupId **required** | The group ID 27 | 28 | -------------------------------------------------------------------------------- /source/javascripts/all.js: -------------------------------------------------------------------------------- 1 | //= require ./all_nosearch 2 | //= require ./app/_search 3 | 4 | jQuery(function() { 5 | 6 | var toolbox = $('.tocify-wrapper'), 7 | height = toolbox.height(); 8 | 9 | toolbox.bind('wheel', function (e) { 10 | var d = e.originalEvent.deltaY, 11 | scrollHeight = toolbox.get(0).scrollHeight; 12 | if((this.scrollTop === (scrollHeight - height) && d > 0) || (this.scrollTop === 0 && d < 0)) { 13 | e.preventDefault(); 14 | } 15 | }); 16 | 17 | }); -------------------------------------------------------------------------------- /source/includes/users/post_userId_picture.md.erb: -------------------------------------------------------------------------------- 1 | ## Upload a user's picture 2 | 3 | Upload a user's profile picture 4 | 5 | > Definition 6 | 7 | ```shell 8 | POST https://api.zoom.us/v2/users/{userId}/picture 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/picture 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 201 Created 21 | ``` 22 | 23 | Path Arguments |   24 | --- | --- 25 | userId **required** | The user ID or email address 26 | 27 | -------------------------------------------------------------------------------- /source/includes/users/put_userId_picture.md.erb: -------------------------------------------------------------------------------- 1 | ## Update a user's picture 2 | 3 | Update a user's profile picture 4 | 5 | > Definition 6 | 7 | ```shell 8 | PUT https://api.zoom.us/v2/users/{userId}/picture 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/picture 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 201 Created 21 | ``` 22 | 23 | Path Arguments |   24 | --- | --- 25 | userId **required** | The user ID or email address 26 | 27 | -------------------------------------------------------------------------------- /source/includes/devices/delete_devices_deviceId.md.erb: -------------------------------------------------------------------------------- 1 | ## Delete a H.323/SIP Device 2 | 3 | Delete a H.323/SIP Device on your Zoom account 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/h323/devices/{deviceId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/h323/devices/{deviceId} \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | deviceId **required** | The device ID 27 | 28 | -------------------------------------------------------------------------------- /source/includes/im_groups/delete_groups_groupId.md.erb: -------------------------------------------------------------------------------- 1 | ## Delete an IM Group 2 | 3 | Delete an IM Group under your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/im/groups/{groupId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/im/groups/{groupId} \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | groupId **required** | The group ID 27 | 28 | -------------------------------------------------------------------------------- /source/includes/users/delete_userId_schedulers.md.erb: -------------------------------------------------------------------------------- 1 | ## Delete a user's schedulers 2 | 3 | Delete all of a user'schedulers 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/users/{userId}/schedulers 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/schedulers \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | userId **required** | The user ID or email address 27 | 28 | -------------------------------------------------------------------------------- /source/includes/users/delete_userId_token.md.erb: -------------------------------------------------------------------------------- 1 | ## Revoke a user's SSO token 2 | 3 | Revoke a user's SSO token 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/users/{userId}/token 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/token \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | userId **required** | The user ID or email address 27 | 28 | -------------------------------------------------------------------------------- /source/includes/users/delete_userId_ssoToken.md.erb: -------------------------------------------------------------------------------- 1 | ## Revoke a user's SSO token 2 | 3 | Revoke a user's SSO token 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/users/{userId}/ssoToken 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/ssoToken \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | userId **required** | The user ID or email address 27 | 28 | -------------------------------------------------------------------------------- /source/includes/devices/index.md.erb: -------------------------------------------------------------------------------- 1 | # Devices 2 | 3 | ## The Device object 4 | The H.323/SIP device object. 5 | 6 | ```json 7 | { 8 | "name": "string", 9 | "protocol": "string", 10 | "ip": "string", 11 | "encryption": "string" 12 | } 13 | ``` 14 | 15 | Property | Description 16 | --- | --- 17 | name *string* | Device name 18 | protocol *string* | Device protocol
`H.323` H.323
`SIP` SIP
19 | ip *string* | Device Ip 20 | encryption *string* | Device encryption
`auto` auto
`yes` yes
`no` no
21 | 22 | -------------------------------------------------------------------------------- /source/includes/users/delete_userId_assistants.md.erb: -------------------------------------------------------------------------------- 1 | ## Delete a user's assistants 2 | 3 | Delete all of a user'sassitants 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/users/{userId}/assistants 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/assistants \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | userId **required** | The user ID or email address 27 | 28 | -------------------------------------------------------------------------------- /source/includes/users/get_email.md.erb: -------------------------------------------------------------------------------- 1 | ## Check a user's email 2 | 3 | Check if the user email exists 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/users/email 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/email?email=string 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "existed_email": "boolean" 26 | } 27 | ``` 28 | 29 | Query Arguments |   30 | --- | --- 31 | email **required** | Zoom work email 32 | 33 | -------------------------------------------------------------------------------- /source/includes/webhooks/patch_options.md.erb: -------------------------------------------------------------------------------- 1 | ## Switch webhook version 2 | 3 | Switch webhook version 4 | 5 | > Definition 6 | 7 | ```shell 8 | PATCH https://api.zoom.us/v2/webhooks/options 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/webhooks/options \ 15 | -d '{ 16 | "version": "string" 17 | }' 18 | ``` 19 | 20 | > Example Response 21 | 22 | ```text 23 | 204 No Content 24 | ``` 25 | 26 | Body Arguments |   27 | --- | --- 28 | version **required** |
`v1` Version 1
`v2` Version 2
29 | 30 | -------------------------------------------------------------------------------- /source/includes/webinars/delete_webinarId_panelists.md.erb: -------------------------------------------------------------------------------- 1 | ## Remove a webinar's panelists 2 | 3 | Remove all panelists from a webinar 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/webinars/{webinarId}/panelists 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/webinars/{webinarId}/panelists \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | webinarId **required** | The webinar ID 27 | 28 | -------------------------------------------------------------------------------- /source/includes/users/get_zpk.md.erb: -------------------------------------------------------------------------------- 1 | ## Verify a user's zpk (Deprecated 2 | 3 | Check if the zpk is expired. The zpk is used to authenticate a user. 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/users/zpk 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/zpk?zpk=string 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "expire_in": "integer" 26 | } 27 | ``` 28 | 29 | Query Arguments |   30 | --- | --- 31 | zpk **required** | User zpk 32 | 33 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright 2008-2013 Concur Technologies, Inc. 2 | 3 | Licensed under the Apache License, Version 2.0 (the "License"); you may 4 | not use this file except in compliance with the License. You may obtain 5 | a copy of the License at 6 | 7 | http://www.apache.org/licenses/LICENSE-2.0 8 | 9 | Unless required by applicable law or agreed to in writing, software 10 | distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 11 | WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 12 | License for the specific language governing permissions and limitations 13 | under the License. -------------------------------------------------------------------------------- /source/includes/groups/get_.md.erb: -------------------------------------------------------------------------------- 1 | ## List groups 2 | 3 | List groups under your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/groups 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/groups 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "total_records": "integer", 26 | "groups": [ 27 | { 28 | "id": "string", 29 | "name": "string", 30 | "total_members": "integer" 31 | } 32 | ] 33 | } 34 | ``` 35 | 36 | -------------------------------------------------------------------------------- /source/includes/tsp/delete_userId_tsp_tspId.md.erb: -------------------------------------------------------------------------------- 1 | ## Delete a user's TSP account 2 | 3 | Delete a user's TSP account 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/users/{userId}/tsp/{tspId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/tsp/{tspId} \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | userId **required** | The user ID or email address 27 | tspId **required** | TSP account index 28 | 29 | -------------------------------------------------------------------------------- /source/includes/users/get_userId_permissions.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve a user's permissions 2 | 3 | Retrieve a user's permissions 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/users/{userId}/permissions 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/permissions 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "permissions": [ 26 | "string" 27 | ] 28 | } 29 | ``` 30 | 31 | Path Arguments |   32 | --- | --- 33 | userId **required** | The user ID or email address 34 | 35 | -------------------------------------------------------------------------------- /source/includes/groups/get_groupId.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve a group 2 | 3 | Retrieve a group under your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/groups/{groupId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/groups/{groupId} 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "id": "string", 26 | "name": "string", 27 | "total_members": "integer" 28 | } 29 | ``` 30 | 31 | Path Arguments |   32 | --- | --- 33 | groupId **required** | The group ID 34 | 35 | -------------------------------------------------------------------------------- /source/includes/users/get_vanity_name.md.erb: -------------------------------------------------------------------------------- 1 | ## Check a user's personal meeting room name 2 | 3 | Check if the user's personal meeting room name exists 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/users/vanity_name 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/vanity_name?vanity_name=string 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "existed": "boolean" 26 | } 27 | ``` 28 | 29 | Query Arguments |   30 | --- | --- 31 | vanity_name **required** | Personal meeting room name 32 | 33 | -------------------------------------------------------------------------------- /source/includes/tsp/get_.md.erb: -------------------------------------------------------------------------------- 1 | ## List TSP dial-in numbers 2 | 3 | List TSP dial-in numbers under account 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/tsp 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/tsp 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "tsp_provider": "string", 26 | "dial_in_numbers": [ 27 | { 28 | "code": "string", 29 | "number": "string", 30 | "type": "string" 31 | } 32 | ] 33 | } 34 | ``` 35 | 36 | -------------------------------------------------------------------------------- /source/includes/users/get_userId_zpk.md.erb: -------------------------------------------------------------------------------- 1 | ## Verify a user's zpk 2 | 3 | Check if the zpk is expired. The zpk is used to authenticate a user. 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/users/{userId}/zpk 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/zpk 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | Path Arguments |   24 | --- | --- 25 | userId **required** | The user ID or email address 26 | 27 | Query Arguments |   28 | --- | --- 29 | type *optional* | User zpk 30 | 31 | -------------------------------------------------------------------------------- /source/includes/meetings/delete_meetingId.md.erb: -------------------------------------------------------------------------------- 1 | ## Delete a meeting 2 | 3 | Delete a meeting 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/meetings/{meetingId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/meetings/{meetingId} \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | meetingId **required** | The meeting ID 27 | 28 | Query Arguments |   29 | --- | --- 30 | occurrence_id *optional* | The meeting occurrence ID 31 | 32 | -------------------------------------------------------------------------------- /source/includes/users/delete_userId_schedulers_schedulerId.md.erb: -------------------------------------------------------------------------------- 1 | ## Delete a user's scheduler 2 | 3 | Delete one of a user's schedulers 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/users/{userId}/schedulers/{schedulerId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/schedulers/{schedulerId} \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | userId **required** | The user ID or email address 27 | schedulerId **required** | Scheduler's ID 28 | 29 | -------------------------------------------------------------------------------- /source/includes/webinars/delete_webinarId.md.erb: -------------------------------------------------------------------------------- 1 | ## Delete a webinar 2 | 3 | Delete a webinar 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/webinars/{webinarId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/webinars/{webinarId} \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | webinarId **required** | The webinar ID 27 | 28 | Query Arguments |   29 | --- | --- 30 | occurrence_id *optional* | The meeting occurrence ID 31 | 32 | -------------------------------------------------------------------------------- /source/includes/groups/delete_groupId_members_memberId.md.erb: -------------------------------------------------------------------------------- 1 | ## Delete a group member 2 | 3 | Delete a member from a group under your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/groups/{groupId}/members/{memberId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/groups/{groupId}/members/{memberId} \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | groupId **required** | The group ID 27 | memberId **required** | The member ID 28 | 29 | -------------------------------------------------------------------------------- /source/includes/groups/post_.md.erb: -------------------------------------------------------------------------------- 1 | ## Create a group 2 | 3 | Create a group under your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | POST https://api.zoom.us/v2/groups 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/groups \ 15 | -d '{ 16 | "name": "string" 17 | }' 18 | ``` 19 | 20 | > Example Response 21 | 22 | ```text 23 | 201 Created 24 | ``` 25 | 26 | ```json 27 | { 28 | "id": "string", 29 | "name": "string", 30 | "total_members": "integer" 31 | } 32 | ``` 33 | 34 | Body Arguments |   35 | --- | --- 36 | name *optional* | Group name 37 | 38 | -------------------------------------------------------------------------------- /source/includes/users/delete_userId_assistants_assistantId.md.erb: -------------------------------------------------------------------------------- 1 | ## Delete a user's assistant 2 | 3 | Delete one of a user's assistants 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/users/{userId}/assistants/{assistantId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/assistants/{assistantId} \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | userId **required** | The user ID or email address 27 | assistantId **required** | Assistant's ID 28 | 29 | -------------------------------------------------------------------------------- /source/includes/webinars/delete_webinarId_panelists_panelistId.md.erb: -------------------------------------------------------------------------------- 1 | ## Remove a webinar panelist 2 | 3 | Remove a panelist from a webinar 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/webinars/{webinarId}/panelists/{panelistId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/webinars/{webinarId}/panelists/{panelistId} \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | webinarId **required** | The webinar ID 27 | panelistId **required** | The panelist ID 28 | 29 | -------------------------------------------------------------------------------- /source/includes/im_groups/delete_groups_groupId_members_memberId.md.erb: -------------------------------------------------------------------------------- 1 | ## Delete an IM Group member 2 | 3 | Delete a member from an IM Group under your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/im/groups/{groupId}/members/{memberId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/im/groups/{groupId}/members/{memberId} \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | groupId **required** | The group ID 27 | memberId **required** | The member ID 28 | 29 | -------------------------------------------------------------------------------- /source/includes/im_groups/delete_groups_groupId_members_userId.md.erb: -------------------------------------------------------------------------------- 1 | ## Delete an IM Group member 2 | 3 | Delete a member from an IM Group under your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/im/groups/{groupId}/members/{userId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/im/groups/{groupId}/members/{userId} \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | groupId **required** | The group ID 27 | userId **required** | The user ID or email address 28 | 29 | -------------------------------------------------------------------------------- /source/includes/accounts/delete_accountId.md.erb: -------------------------------------------------------------------------------- 1 | ## Disassociate an account 2 | 3 | Disassociate a sub account from the master account. This will leave the account intact but the sub account will not longer be associated with the master account. 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/accounts/{accountId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/accounts/{accountId} \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | accountId **required** | The account ID 27 | 28 | -------------------------------------------------------------------------------- /source/includes/users/get_userId_schedulers.md.erb: -------------------------------------------------------------------------------- 1 | ## List a user's schedulers 2 | 3 | List a user's schedulers 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/users/{userId}/schedulers 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/schedulers 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "assistants": [ 26 | { 27 | "id": "string", 28 | "email": "string" 29 | } 30 | ] 31 | } 32 | ``` 33 | 34 | Path Arguments |   35 | --- | --- 36 | userId **required** | The user ID or email address 37 | 38 | -------------------------------------------------------------------------------- /source/includes/groups/patch_groupId.md.erb: -------------------------------------------------------------------------------- 1 | ## Update a group 2 | 3 | Update a group under your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | PATCH https://api.zoom.us/v2/groups/{groupId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/groups/{groupId} \ 15 | -d '{ 16 | "name": "string" 17 | }' 18 | ``` 19 | 20 | > Example Response 21 | 22 | ```text 23 | 204 No Content 24 | ``` 25 | 26 | Path Arguments |   27 | --- | --- 28 | groupId **required** | The group ID 29 | 30 | Body Arguments |   31 | --- | --- 32 | name *optional* | Group name. Must be unique in one account. Character length is less than 128. 33 | 34 | -------------------------------------------------------------------------------- /source/includes/users/get_userId_assistants.md.erb: -------------------------------------------------------------------------------- 1 | ## List a user's assistants 2 | 3 | List a user's assistants 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/users/{userId}/assistants 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/assistants 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "assistants": [ 26 | { 27 | "id": "string", 28 | "email": "string" 29 | } 30 | ] 31 | } 32 | ``` 33 | 34 | Path Arguments |   35 | --- | --- 36 | userId **required** | The user ID or email address 37 | 38 | -------------------------------------------------------------------------------- /source/includes/meetings/put_meetingId_status.md.erb: -------------------------------------------------------------------------------- 1 | ## Update a meeting's status 2 | 3 | Update a meeting's status 4 | 5 | > Definition 6 | 7 | ```shell 8 | PUT https://api.zoom.us/v2/meetings/{meetingId}/status 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/meetings/{meetingId}/status \ 15 | -d '{ 16 | "action": "string" 17 | }' 18 | ``` 19 | 20 | > Example Response 21 | 22 | ```text 23 | 204 No Content 24 | ``` 25 | 26 | Path Arguments |   27 | --- | --- 28 | meetingId **required** | The meeting ID 29 | 30 | Body Arguments |   31 | --- | --- 32 | action *optional* |
`end` end a meeting
33 | 34 | -------------------------------------------------------------------------------- /source/includes/webinars/put_webinarId_status.md.erb: -------------------------------------------------------------------------------- 1 | ## Update a webinar's status 2 | 3 | Update a webinar's status 4 | 5 | > Definition 6 | 7 | ```shell 8 | PUT https://api.zoom.us/v2/webinars/{webinarId}/status 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/webinars/{webinarId}/status \ 15 | -d '{ 16 | "status": "string" 17 | }' 18 | ``` 19 | 20 | > Example Response 21 | 22 | ```text 23 | 204 No Content 24 | ``` 25 | 26 | Path Arguments |   27 | --- | --- 28 | webinarId **required** | The webinar ID 29 | 30 | Body Arguments |   31 | --- | --- 32 | status *optional* |
`end` end a webinar
33 | 34 | -------------------------------------------------------------------------------- /source/includes/users/put_userId_password.md.erb: -------------------------------------------------------------------------------- 1 | ## Update a user's password 2 | 3 | Update a user's password 4 | 5 | > Definition 6 | 7 | ```shell 8 | PUT https://api.zoom.us/v2/users/{userId}/password 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/password \ 15 | -d '{ 16 | "password": "string" 17 | }' 18 | ``` 19 | 20 | > Example Response 21 | 22 | ```text 23 | 204 No Content 24 | ``` 25 | 26 | Path Arguments |   27 | --- | --- 28 | userId **required** | The user ID or email address 29 | 30 | Body Arguments |   31 | --- | --- 32 | password **required** | User’s password. Character length is less than 32, 33 | 34 | -------------------------------------------------------------------------------- /source/includes/webinars/get_webinarId_instances.md.erb: -------------------------------------------------------------------------------- 1 | ## List of ended webinar instances 2 | 3 | List of ended webinar instances 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/past_webinars/{webinarId}/instances 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/past_webinars/{webinarId}/instances 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "webinars": [ 26 | { 27 | "uuid": "string", 28 | "start_time": "string [date-time]" 29 | } 30 | ] 31 | } 32 | ``` 33 | 34 | Path Arguments |   35 | --- | --- 36 | webinarId **required** | The webinar ID 37 | 38 | -------------------------------------------------------------------------------- /source/includes/webhooks/get_webhookId.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve a webhook 2 | 3 | Retrieve a webhook 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/webhooks/{webhookId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/webhooks/{webhookId} 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "webhook_id": "string", 26 | "url": "string", 27 | "auth_user": "string", 28 | "auth_password": "string", 29 | "events": [ 30 | "string" 31 | ], 32 | "created_at": "string [date-time]" 33 | } 34 | ``` 35 | 36 | Path Arguments |   37 | --- | --- 38 | webhookId **required** | The webhook ID 39 | 40 | -------------------------------------------------------------------------------- /source/includes/webhooks/get_.md.erb: -------------------------------------------------------------------------------- 1 | ## List webhooks 2 | 3 | List webhooks for a account 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/webhooks 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/webhooks 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "total_records": "integer", 26 | "webhooks": [ 27 | { 28 | "webhook_id": "string", 29 | "url": "string", 30 | "auth_user": "string", 31 | "auth_password": "string", 32 | "events": [ 33 | "string" 34 | ], 35 | "created_at": "string [date-time]" 36 | } 37 | ] 38 | } 39 | ``` 40 | 41 | -------------------------------------------------------------------------------- /source/includes/users/put_userId_status.md.erb: -------------------------------------------------------------------------------- 1 | ## Update a user's status 2 | 3 | Update a user's status 4 | 5 | > Definition 6 | 7 | ```shell 8 | PUT https://api.zoom.us/v2/users/{userId}/status 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/status \ 15 | -d '{ 16 | "action": "string" 17 | }' 18 | ``` 19 | 20 | > Example Response 21 | 22 | ```text 23 | 204 No Content 24 | ``` 25 | 26 | Path Arguments |   27 | --- | --- 28 | userId **required** | The user ID or email address 29 | 30 | Body Arguments |   31 | --- | --- 32 | action **required** | The action type
`activate` set users status to active
`deactivate` set users status to inactive
33 | 34 | -------------------------------------------------------------------------------- /source/includes/im_groups/get_groups_groupId.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve an IM Group 2 | 3 | Retrieve an IM Group under your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/im/groups/{groupId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/im/groups/{groupId} 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "id": "string", 26 | "name": "string", 27 | "total_members": "integer", 28 | "type": "string", 29 | "search_by_domain": "boolean", 30 | "search_by_account": "boolean", 31 | "search_by_ma_account": "boolean" 32 | } 33 | ``` 34 | 35 | Path Arguments |   36 | --- | --- 37 | groupId **required** | The group ID 38 | 39 | -------------------------------------------------------------------------------- /source/includes/devices/get_devices.md.erb: -------------------------------------------------------------------------------- 1 | ## List H.323/SIP Devices. 2 | 3 | List H.323/SIP Devices on your Zoom account. 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/h323/devices 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/h323/devices 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_number": "integer", 27 | "page_size": "integer", 28 | "total_records": "integer", 29 | "devices": [ 30 | { 31 | "id": "string", 32 | "name": "string", 33 | "protocol": "string", 34 | "ip": "string", 35 | "encryption": "string" 36 | } 37 | ] 38 | } 39 | ``` 40 | 41 | -------------------------------------------------------------------------------- /source/includes/webinars/get_webinarId_panelists.md.erb: -------------------------------------------------------------------------------- 1 | ## List a webinar's panelists 2 | 3 | List panelists for a webinar 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/webinars/{webinarId}/panelists 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/webinars/{webinarId}/panelists 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "total_records": "integer", 26 | "panelists": [ 27 | { 28 | "id": "string", 29 | "name": "string", 30 | "email": "string", 31 | "join_url": "string" 32 | } 33 | ] 34 | } 35 | ``` 36 | 37 | Path Arguments |   38 | --- | --- 39 | webinarId **required** | The webinar ID 40 | 41 | -------------------------------------------------------------------------------- /source/includes/cloud_recording/put_meetingId_recordings_status.md.erb: -------------------------------------------------------------------------------- 1 | ## Recover a meeting's recordings 2 | 3 | Recover a meeting's recordings 4 | 5 | > Definition 6 | 7 | ```shell 8 | PUT https://api.zoom.us/v2/meetings/{meetingId}/recordings/status 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/meetings/{meetingId}/recordings/status \ 15 | -d '{ 16 | "action": "string" 17 | }' 18 | ``` 19 | 20 | > Example Response 21 | 22 | ```text 23 | 204 No Content 24 | ``` 25 | 26 | Path Arguments |   27 | --- | --- 28 | meetingId **required** | The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. 29 | 30 | Body Arguments |   31 | --- | --- 32 | action *optional* |
`recover` recover meeting recording
33 | 34 | -------------------------------------------------------------------------------- /source/includes/tsp/get_userId_tsp_tspId.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve a user's TSP account 2 | 3 | Retrieve a user's TSP account 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/users/{userId}/tsp/{tspId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/tsp/{tspId} 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "conference_code": "string", 26 | "leader_pin": "string", 27 | "dial_in_numbers": [ 28 | { 29 | "code": "string", 30 | "number": "string", 31 | "type": "string" 32 | } 33 | ] 34 | } 35 | ``` 36 | 37 | Path Arguments |   38 | --- | --- 39 | userId **required** | The user ID or email address 40 | tspId **required** | TSP account index 41 | 42 | -------------------------------------------------------------------------------- /source/includes/cloud_recording/delete_meetingId_recordings.md.erb: -------------------------------------------------------------------------------- 1 | ## Delete a meeting's recordings 2 | 3 | Delete a meeting's recordings 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/meetings/{meetingId}/recordings 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/meetings/{meetingId}/recordings \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | meetingId **required** | The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. 27 | 28 | Query Arguments |   29 | --- | --- 30 | action *optional*
trash
| The recording delete action
`trash` move recording to trash
`delete` delete recording permanently
31 | 32 | -------------------------------------------------------------------------------- /source/includes/webinars/post_webinarId_panelists.md.erb: -------------------------------------------------------------------------------- 1 | ## Add a webinar panelist 2 | 3 | Add panelist to webinar 4 | 5 | > Definition 6 | 7 | ```shell 8 | POST https://api.zoom.us/v2/webinars/{webinarId}/panelists 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/webinars/{webinarId}/panelists \ 15 | -d '{ 16 | "panelists": [ 17 | { 18 | "name": "string", 19 | "email": "string" 20 | } 21 | ] 22 | }' 23 | ``` 24 | 25 | > Example Response 26 | 27 | ```text 28 | 201 Created 29 | ``` 30 | 31 | ```json 32 | { 33 | "id": "string", 34 | "join_url": "string" 35 | } 36 | ``` 37 | 38 | Path Arguments |   39 | --- | --- 40 | webinarId **required** | The webinar ID 41 | 42 | Body Arguments |   43 | --- | --- 44 | panelists *optional* | List of Panelist objects 45 | 46 | -------------------------------------------------------------------------------- /source/includes/im_groups/get_groups.md.erb: -------------------------------------------------------------------------------- 1 | ## List IM Groups 2 | 3 | List IM groups under your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/im/groups 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/im/groups 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_number": "integer", 27 | "page_size": "integer", 28 | "total_records": "integer", 29 | "groups": [ 30 | { 31 | "id": "string", 32 | "name": "string", 33 | "total_members": "integer", 34 | "type": "string", 35 | "search_by_domain": "boolean", 36 | "search_by_account": "boolean", 37 | "search_by_ma_account": "boolean" 38 | } 39 | ] 40 | } 41 | ``` 42 | 43 | -------------------------------------------------------------------------------- /source/includes/groups/post_groupId_members.md.erb: -------------------------------------------------------------------------------- 1 | ## Add group members 2 | 3 | Add members to a group under your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | POST https://api.zoom.us/v2/groups/{groupId}/members 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/groups/{groupId}/members \ 15 | -d '{ 16 | "members": [ 17 | { 18 | "id": "string", 19 | "email": "string" 20 | } 21 | ] 22 | }' 23 | ``` 24 | 25 | > Example Response 26 | 27 | ```text 28 | 201 Created 29 | ``` 30 | 31 | ```json 32 | { 33 | "ids": "string", 34 | "added_at": "string [date-time]" 35 | } 36 | ``` 37 | 38 | Path Arguments |   39 | --- | --- 40 | groupId **required** | The group ID 41 | 42 | Body Arguments |   43 | --- | --- 44 | members *optional*
30
| List of Group members 45 | 46 | -------------------------------------------------------------------------------- /source/includes/billing/get_accountId_billing.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve billing information for a sub account 2 | 3 | Retrieve billing information for a sub account under the master account 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/accounts/{accountId}/billing 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/accounts/{accountId}/billing 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "first_name": "string", 26 | "last_name": "string", 27 | "email": "string", 28 | "phone_number": "string", 29 | "address": "string", 30 | "apt": "string", 31 | "city": "string", 32 | "state": "string", 33 | "zip": "string", 34 | "country": "string" 35 | } 36 | ``` 37 | 38 | Path Arguments |   39 | --- | --- 40 | accountId **required** | The account ID 41 | 42 | -------------------------------------------------------------------------------- /source/includes/cloud_recording/put_meetingId_recordings_recordingId_status.md.erb: -------------------------------------------------------------------------------- 1 | ## Recover a single recording 2 | 3 | Recover a single recording 4 | 5 | > Definition 6 | 7 | ```shell 8 | PUT https://api.zoom.us/v2/meetings/{meetingId}/recordings/{recordingId}/status 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/meetings/{meetingId}/recordings/{recordingId}/status \ 15 | -d '{ 16 | "action": "string" 17 | }' 18 | ``` 19 | 20 | > Example Response 21 | 22 | ```text 23 | 204 No Content 24 | ``` 25 | 26 | Path Arguments |   27 | --- | --- 28 | meetingId **required** | The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. 29 | recordingId **required** | The recording ID 30 | 31 | Body Arguments |   32 | --- | --- 33 | action *optional* |
`recover` recover meeting recording
34 | 35 | -------------------------------------------------------------------------------- /source/includes/users/post_userId_assistants.md.erb: -------------------------------------------------------------------------------- 1 | ## Add assistants 2 | 3 | Add assistants to a user 4 | 5 | > Definition 6 | 7 | ```shell 8 | POST https://api.zoom.us/v2/users/{userId}/assistants 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/assistants \ 15 | -d '{ 16 | "assistants": [ 17 | { 18 | "id": "string", 19 | "email": "string" 20 | } 21 | ] 22 | }' 23 | ``` 24 | 25 | > Example Response 26 | 27 | ```text 28 | 201 Created 29 | ``` 30 | 31 | ```json 32 | { 33 | "ids": "string", 34 | "add_at": "string [date-time]" 35 | } 36 | ``` 37 | 38 | Path Arguments |   39 | --- | --- 40 | userId **required** | The user ID or email address 41 | 42 | Body Arguments |   43 | --- | --- 44 | assistants *optional*
30
| List of User's assistants 45 | 46 | -------------------------------------------------------------------------------- /source/includes/tsp/get_userId_tsp.md.erb: -------------------------------------------------------------------------------- 1 | ## List user's TSP accounts 2 | 3 | List user's TSP accounts 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/users/{userId}/tsp 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/tsp 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "tsp_accounts": [ 26 | { 27 | "conference_code": "string", 28 | "leader_pin": "string", 29 | "dial_in_numbers": [ 30 | { 31 | "code": "string", 32 | "number": "string", 33 | "type": "string" 34 | } 35 | ] 36 | } 37 | ] 38 | } 39 | ``` 40 | 41 | Path Arguments |   42 | --- | --- 43 | userId **required** | The user ID or email address 44 | 45 | -------------------------------------------------------------------------------- /source/includes/billing/post_accountId_plans_addons.md.erb: -------------------------------------------------------------------------------- 1 | ## Add an additional plan for sub account 2 | 3 | Add an additional plan for sub account 4 | 5 | > Definition 6 | 7 | ```shell 8 | POST https://api.zoom.us/v2/accounts/{accountId}/plans/addons 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/accounts/{accountId}/plans/addons \ 15 | -d '{ 16 | "type": "string", 17 | "hosts": "integer" 18 | }' 19 | ``` 20 | 21 | > Example Response 22 | 23 | ```text 24 | 201 Created 25 | ``` 26 | 27 | Path Arguments |   28 | --- | --- 29 | accountId **required** | The account ID 30 | 31 | Body Arguments |   32 | --- | --- 33 | type **required** | Account plan type 34 | hosts **required** | Account plan number of hosts 35 | 36 | -------------------------------------------------------------------------------- /source/includes/reference/_rate_limits.md.erb: -------------------------------------------------------------------------------- 1 | # Rate Limits 2 | 3 | To preserve the integrity and reliability of the platform our APIs have the following rate limits. 4 | 5 | ## All API Endpoints 6 | 7 | You can run a max of ten requests per second (10 requests/second) unless otherwise noted below. 8 | 9 | ## Billing APIs 10 | 11 | You can run a max of one request per second (1 request/second) on the following: 12 | 13 | - /v2/\*/billing/\* 14 | - /v2/\*/plan/\* 15 | - /v2/\*/metrics/\* (excluding /meetings and /webinars) 16 | 17 | ## Report & Metric APIs 18 | 19 | You can run a max of one request per second (1 request/second) and a max of two thousand request per day (2000 requests/day) on the following: 20 | 21 | - /v2/metrics/meetings 22 | - /v2/metrics/webinars 23 | - /v2/report/\* 24 | 25 | Furthermore, you can run a max of one request per minute (1 request/minute) on the following: 26 | 27 | - /v2/metrics/meetings 28 | - /v2/metrics/webinars -------------------------------------------------------------------------------- /source/includes/billing/put_accountId_plans_addons.md.erb: -------------------------------------------------------------------------------- 1 | ## Update an additional plan for sub account 2 | 3 | Update an additional plan for sub account 4 | 5 | > Definition 6 | 7 | ```shell 8 | PUT https://api.zoom.us/v2/accounts/{accountId}/plans/addons 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/accounts/{accountId}/plans/addons \ 15 | -d '{ 16 | "type": "string", 17 | "hosts": "integer" 18 | }' 19 | ``` 20 | 21 | > Example Response 22 | 23 | ```text 24 | 204 No Content 25 | ``` 26 | 27 | Path Arguments |   28 | --- | --- 29 | accountId **required** | The account ID 30 | 31 | Body Arguments |   32 | --- | --- 33 | type **required** | Account plan type 34 | hosts **required** | Account plan number of hosts 35 | 36 | -------------------------------------------------------------------------------- /source/includes/im_groups/post_groups_groupId_members.md.erb: -------------------------------------------------------------------------------- 1 | ## Add IM Group members 2 | 3 | Add members to an IM Group under your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | POST https://api.zoom.us/v2/im/groups/{groupId}/members 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/im/groups/{groupId}/members \ 15 | -d '{ 16 | "members": [ 17 | { 18 | "id": "string", 19 | "email": "string" 20 | } 21 | ] 22 | }' 23 | ``` 24 | 25 | > Example Response 26 | 27 | ```text 28 | 201 Created 29 | ``` 30 | 31 | ```json 32 | { 33 | "ids": "string", 34 | "added_at": "string [date-time]" 35 | } 36 | ``` 37 | 38 | Path Arguments |   39 | --- | --- 40 | groupId **required** | The group ID 41 | 42 | Body Arguments |   43 | --- | --- 44 | members *optional*
10
| List of IM Group members 45 | 46 | -------------------------------------------------------------------------------- /source/includes/users/get_userId_token.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve a user's token 2 | 3 | Retrieve a user's token 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/users/{userId}/token 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/token 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "token": "string" 26 | } 27 | ``` 28 | 29 | Path Arguments |   30 | --- | --- 31 | userId **required** | The user ID or email address 32 | 33 | Query Arguments |   34 | --- | --- 35 | type *optional* | User token type
`token` Used for starting meeting with client SDK.
`zpk` Used for generating the start meeting url. (Deprecated)
`zak` Used for generating the start meeting url. The expiration time is two hours. For API users, the expiration time is 90 days.
36 | 37 | -------------------------------------------------------------------------------- /source/includes/meetings/get_meetingUUID.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve past meeting details 2 | 3 | Retrieve ended meeting details 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/past_meetings/{meetingUUID} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/past_meetings/{meetingUUID} 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "uuid": "string [uuid]", 26 | "id": "integer", 27 | "host_id": "integer", 28 | "type": "integer", 29 | "topic": "string", 30 | "user_name": "string", 31 | "user_email": "string", 32 | "start_time": "string [date-time]", 33 | "end_time": "string [date-time]", 34 | "duration": "integer", 35 | "total_minutes": "integer", 36 | "participants_count": "integer" 37 | } 38 | ``` 39 | 40 | Path Arguments |   41 | --- | --- 42 | meetingUUID **required** | The meeting UUID. 43 | 44 | -------------------------------------------------------------------------------- /source/includes/reports/get_daily.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve daily report 2 | 3 | Retrieve daily report for one month, can only get daily report for recent 6 months 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/report/daily 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/report/daily 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "year": "integer", 26 | "month": "integer", 27 | "dates": [ 28 | { 29 | "date": "string [date]", 30 | "new_users": "integer", 31 | "meetings": "integer", 32 | "participants": "integer", 33 | "meeting_minutes": "integer" 34 | } 35 | ] 36 | } 37 | ``` 38 | 39 | Query Arguments |   40 | --- | --- 41 | year *optional* | Year for this report 42 | month *optional* | Month for this report 43 | 44 | -------------------------------------------------------------------------------- /source/includes/pac/index.md.erb: -------------------------------------------------------------------------------- 1 | # PAC 2 | 3 | ## The PAC object 4 | List of PAC Accounts 5 | 6 | ```json 7 | { 8 | "dedicated_dial_in_number": [ 9 | { 10 | "number": "string", 11 | "country": "string" 12 | } 13 | ], 14 | "global_dial_in_numbers": [ 15 | { 16 | "number": "string", 17 | "country": "string" 18 | } 19 | ], 20 | "conference_id": "integer", 21 | "participant_password": "string", 22 | "listen_only_password": "string" 23 | } 24 | ``` 25 | 26 | Property | Description 27 | --- | --- 28 | dedicated_dial_in_number *array* | List of Dedicated Dial In Numbers 29 | global_dial_in_numbers *array* | List of Global Dial In Numbers 30 | conference_id *integer* | Conference ID 31 | participant_password *string* | Participant Password, numeric value, length is less than 6 32 | listen_only_password *string* | Listen-Only Password, numeric value, length is less than 6 33 | 34 | -------------------------------------------------------------------------------- /source/includes/users/delete_userId.md.erb: -------------------------------------------------------------------------------- 1 | ## Delete a user 2 | 3 | Delete a user on your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/users/{userId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId} \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | userId **required** | The user ID or email address 27 | 28 | Query Arguments |   29 | --- | --- 30 | action *optional*
disassociate
| Delete action type
`disassociate` Disassociate a user
`delete` Permanently delete a user
31 | transfer_email *optional* | Transfer email 32 | transfer_meeting *optional* | Transfer meeting 33 | transfer_webinar *optional* | Transfer webinar 34 | transfer_recording *optional* | Transfer recording 35 | 36 | -------------------------------------------------------------------------------- /source/includes/webinars/put_webinarId_registrants_registrantId_status.md.erb: -------------------------------------------------------------------------------- 1 | ## Update a webinar registrant's status 2 | 3 | Update a webinar registrant's status 4 | 5 | > Definition 6 | 7 | ```shell 8 | PUT https://api.zoom.us/v2/webinars/{webinarId}/registrants/{registrantId}/status 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/webinars/{webinarId}/registrants/{registrantId}/status \ 15 | -d '{ 16 | "status": "string" 17 | }' 18 | ``` 19 | 20 | > Example Response 21 | 22 | ```text 23 | 204 No Content 24 | ``` 25 | 26 | Path Arguments |   27 | --- | --- 28 | webinarId **required** | The webinar ID 29 | registrantId **required** | The registrant ID 30 | 31 | Body Arguments |   32 | --- | --- 33 | status *optional* |
`pending` set registrant status to pending
`approved` set registrant status to approved
`denied` set registrant status to denied
34 | 35 | -------------------------------------------------------------------------------- /source/includes/meetings/put_meetingId_registrants_registrantId_status.md.erb: -------------------------------------------------------------------------------- 1 | ## Update a meeting registrant's status 2 | 3 | Update a registrants status for a meeting 4 | 5 | > Definition 6 | 7 | ```shell 8 | PUT https://api.zoom.us/v2/meetings/{meetingId}/registrants/{registrantId}/status 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/meetings/{meetingId}/registrants/{registrantId}/status \ 15 | -d '{ 16 | "status": "string" 17 | }' 18 | ``` 19 | 20 | > Example Response 21 | 22 | ```text 23 | 204 No Content 24 | ``` 25 | 26 | Path Arguments |   27 | --- | --- 28 | meetingId **required** | The meeting ID 29 | registrantId **required** | The registrant ID 30 | 31 | Body Arguments |   32 | --- | --- 33 | status *optional* |
`pending` set registrant status to pending
`approved` set registrant status to approved
`denied` set registrant status to denied
34 | 35 | -------------------------------------------------------------------------------- /source/includes/tsp/index.md.erb: -------------------------------------------------------------------------------- 1 | # TSP 2 | 3 | ## The TSP object 4 | List of TSP Accounts 5 | 6 | ```json 7 | { 8 | "conference_code": "string", 9 | "leader_pin": "string", 10 | "dial_in_numbers": [ 11 | { 12 | "code": "string", 13 | "number": "string", 14 | "type": "string" 15 | } 16 | ] 17 | } 18 | ``` 19 | 20 | Property | Description 21 | --- | --- 22 | conference_code *string* | Conference code, numeric value, length is less than 16. 23 | leader_pin *string* | Leader PIN, numeric value, length is less than 16. 24 | dial_in_numbers *array* | List of Dial In Numbers 25 | dial_in_numbers[0].code **required**
6
| Country Code 26 | dial_in_numbers[0].number **required**
16
| Dial-in number, length is less than 16. 27 | dial_in_numbers[0].type *optional* | Number type
`toll` Toll number
`tollfree` Toll free number
28 | -------------------------------------------------------------------------------- /source/stylesheets/_icon-font.scss: -------------------------------------------------------------------------------- 1 | @font-face { 2 | font-family: 'slate'; 3 | src:font-url('slate.eot?-syv14m'); 4 | src:font-url('slate.eot?#iefix-syv14m') format('embedded-opentype'), 5 | font-url('slate.woff2?-syv14m') format('woff2'), 6 | font-url('slate.woff?-syv14m') format('woff'), 7 | font-url('slate.ttf?-syv14m') format('truetype'), 8 | font-url('slate.svg?-syv14m#slate') format('svg'); 9 | font-weight: normal; 10 | font-style: normal; 11 | } 12 | 13 | %icon { 14 | font-family: 'slate'; 15 | speak: none; 16 | font-style: normal; 17 | font-weight: normal; 18 | font-variant: normal; 19 | text-transform: none; 20 | line-height: 1; 21 | } 22 | 23 | %icon-exclamation-sign { 24 | @extend %icon; 25 | content: "\e600"; 26 | } 27 | %icon-info-sign { 28 | @extend %icon; 29 | content: "\e602"; 30 | } 31 | %icon-ok-sign { 32 | @extend %icon; 33 | content: "\e606"; 34 | } 35 | %icon-search { 36 | @extend %icon; 37 | content: "\e607"; 38 | } 39 | -------------------------------------------------------------------------------- /source/includes/cloud_recording/delete_meetingId_recordings_recordingId.md.erb: -------------------------------------------------------------------------------- 1 | ## Delete one meeting recording file 2 | 3 | Delete one meeting recording file 4 | 5 | > Definition 6 | 7 | ```shell 8 | DELETE https://api.zoom.us/v2/meetings/{meetingId}/recordings/{recordingId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/meetings/{meetingId}/recordings/{recordingId} \ 15 | -X DELETE 16 | ``` 17 | 18 | > Example Response 19 | 20 | ```text 21 | 204 No Content 22 | ``` 23 | 24 | Path Arguments |   25 | --- | --- 26 | meetingId **required** | The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. 27 | recordingId **required** | The recording ID 28 | 29 | Query Arguments |   30 | --- | --- 31 | action *optional*
trash
| The recording delete action
`trash` move recording to trash
`delete` delete recording permanently
32 | 33 | -------------------------------------------------------------------------------- /source/includes/devices/patch_devices_deviceId.md.erb: -------------------------------------------------------------------------------- 1 | ## Update a H.323/SIP Device 2 | 3 | Update a H.323/SIP Device on your Zoom account 4 | 5 | > Definition 6 | 7 | ```shell 8 | PATCH https://api.zoom.us/v2/h323/devices/{deviceId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/h323/devices/{deviceId} \ 15 | -d '{ 16 | "name": "string", 17 | "protocol": "string", 18 | "ip": "string", 19 | "encryption": "string" 20 | }' 21 | ``` 22 | 23 | > Example Response 24 | 25 | ```text 26 | 204 No Content 27 | ``` 28 | 29 | Path Arguments |   30 | --- | --- 31 | deviceId **required** | The device ID 32 | 33 | Body Arguments |   34 | --- | --- 35 | name **required**
64
| Device name 36 | protocol **required** | Device protocol
`H.323` H.323
`SIP` SIP
37 | ip **required** | Device Ip 38 | encryption **required** | Device encryption
`auto` auto
`yes` yes
`no` no
39 | 40 | -------------------------------------------------------------------------------- /source/includes/reports/get_meetings_meetingId.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve meeting details report 2 | 3 | Retrieve ended meeting details report 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/report/meetings/{meetingId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/report/meetings/{meetingId} 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "uuid": "string [uuid]", 26 | "id": "integer", 27 | "type": "integer", 28 | "topic": "string", 29 | "user_name": "string", 30 | "user_email": "string", 31 | "start_time": "string [date-time]", 32 | "end_time": "string [date-time]", 33 | "duration": "integer", 34 | "total_minutes": "integer", 35 | "participants_count": "integer" 36 | } 37 | ``` 38 | 39 | Path Arguments |   40 | --- | --- 41 | meetingId **required** | The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. 42 | 43 | -------------------------------------------------------------------------------- /source/includes/reports/get_webinars_webinarId.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve webinar details report 2 | 3 | Retrieve ended webinar details report 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/report/webinars/{webinarId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/report/webinars/{webinarId} 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "uuid": "string [uuid]", 26 | "id": "integer", 27 | "type": "integer", 28 | "topic": "string", 29 | "user_name": "string", 30 | "user_email": "string", 31 | "start_time": "string [date-time]", 32 | "end_time": "string [date-time]", 33 | "duration": "integer", 34 | "total_minutes": "integer", 35 | "participants_count": "integer" 36 | } 37 | ``` 38 | 39 | Path Arguments |   40 | --- | --- 41 | webinarId **required** | The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance. 42 | 43 | -------------------------------------------------------------------------------- /source/includes/users/index.md.erb: -------------------------------------------------------------------------------- 1 | # Users 2 | 3 | ## The User object 4 | The user object represents a User on Zoom 5 | 6 | ```json 7 | { 8 | "first_name": "string", 9 | "last_name": "string", 10 | "email": "string", 11 | "type": "integer", 12 | "pmi": "string", 13 | "timezone": "string", 14 | "dept": "string", 15 | "created_at": "string [date-time]", 16 | "last_login_time": "string [date-time]", 17 | "last_client_version": "string" 18 | } 19 | ``` 20 | 21 | Property | Description 22 | --- | --- 23 | first_name *string* | User's first name 24 | last_name *string* | User's last name 25 | email *string* | User's email address 26 | type *integer* | User's type
`1` basic
`2` pro
`3` corp
27 | pmi *string* | Personal Meeting ID 28 | timezone *string* | Time Zone 29 | dept *string* | Department 30 | created_at *string* | User create time 31 | last_login_time *string* | User last login time 32 | last_client_version *string* | User last login client version 33 | 34 | -------------------------------------------------------------------------------- /source/includes/devices/post_devices.md.erb: -------------------------------------------------------------------------------- 1 | ## Create a H.323/SIP Device 2 | 3 | Create a H.323/SIP Device on your Zoom account 4 | 5 | > Definition 6 | 7 | ```shell 8 | POST https://api.zoom.us/v2/h323/devices 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/h323/devices \ 15 | -d '{ 16 | "name": "string", 17 | "protocol": "string", 18 | "ip": "string", 19 | "encryption": "string" 20 | }' 21 | ``` 22 | 23 | > Example Response 24 | 25 | ```text 26 | 201 Created 27 | ``` 28 | 29 | ```json 30 | { 31 | "id": "string", 32 | "name": "string", 33 | "protocol": "string", 34 | "ip": "string", 35 | "encryption": "string" 36 | } 37 | ``` 38 | 39 | Body Arguments |   40 | --- | --- 41 | name **required**
64
| Device name 42 | protocol **required** | Device protocol
`H.323` H.323
`SIP` SIP
43 | ip **required** | Device Ip 44 | encryption **required** | Device encryption
`auto` auto
`yes` yes
`no` no
45 | 46 | -------------------------------------------------------------------------------- /source/includes/accounts/get_accountId.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve a sub account 2 | 3 | Retrieve a sub account under the master account. . 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/accounts/{accountId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/accounts/{accountId} 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "id": "string", 26 | "owner_id": "string", 27 | "owner_email": "string", 28 | "created_at": "string [date-time]", 29 | "options": { 30 | "share_rc": "boolean", 31 | "room_connectors": "string", 32 | "share_mc": "boolean", 33 | "meeting_connectors": "string", 34 | "pay_mode": "string" 35 | } 36 | } 37 | ``` 38 | 39 | Path Arguments |   40 | --- | --- 41 | accountId **required** | The account ID 42 | 43 | -------------------------------------------------------------------------------- /source/includes/reports/get_meetings_meetingId_polls.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve meeting polls report 2 | 3 | Retrieve ended meeting polls report 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/report/meetings/{meetingId}/polls 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/report/meetings/{meetingId}/polls 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "id": "integer", 26 | "uuid": "string [uuid]", 27 | "start_time": "string [date-time]", 28 | "questions": [ 29 | { 30 | "name": "string", 31 | "email": "string", 32 | "question_details": [ 33 | { 34 | "question": "string", 35 | "answer": "string" 36 | } 37 | ] 38 | } 39 | ] 40 | } 41 | ``` 42 | 43 | Path Arguments |   44 | --- | --- 45 | meetingId **required** | The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. 46 | 47 | -------------------------------------------------------------------------------- /source/includes/reports/get_webinars_webinarId_qa.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve webinar Q&A report 2 | 3 | Retrieve ended webinar Q&A report 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/report/webinars/{webinarId}/qa 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/report/webinars/{webinarId}/qa 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "id": "integer", 26 | "uuid": "string [uuid]", 27 | "start_time": "string [date-time]", 28 | "questions": [ 29 | { 30 | "name": "string", 31 | "email": "string", 32 | "question_details": [ 33 | { 34 | "question": "string", 35 | "answer": "string" 36 | } 37 | ] 38 | } 39 | ] 40 | } 41 | ``` 42 | 43 | Path Arguments |   44 | --- | --- 45 | webinarId **required** | The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance. 46 | 47 | -------------------------------------------------------------------------------- /source/includes/reports/get_webinars_webinarId_polls.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve webinar polls report 2 | 3 | Retrieve ended webinar polls report 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/report/webinars/{webinarId}/polls 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/report/webinars/{webinarId}/polls 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "id": "integer", 26 | "uuid": "string [uuid]", 27 | "start_time": "string [date-time]", 28 | "questions": [ 29 | { 30 | "name": "string", 31 | "email": "string", 32 | "question_details": [ 33 | { 34 | "question": "string", 35 | "answer": "string" 36 | } 37 | ] 38 | } 39 | ] 40 | } 41 | ``` 42 | 43 | Path Arguments |   44 | --- | --- 45 | webinarId **required** | The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance. 46 | 47 | -------------------------------------------------------------------------------- /source/includes/im_groups/index.md.erb: -------------------------------------------------------------------------------- 1 | # IM Groups 2 | 3 | ## The IM Group object 4 | IM Group object 5 | 6 | ```json 7 | { 8 | "name": "string", 9 | "total_members": "integer", 10 | "type": "string", 11 | "search_by_domain": "boolean", 12 | "search_by_account": "boolean", 13 | "search_by_ma_account": "boolean" 14 | } 15 | ``` 16 | 17 | Property | Description 18 | --- | --- 19 | name *string* | Group name 20 | total_members *integer* | Total number of members in this group 21 | type *string* | IM Group type
`normal` Only members can see the group automatically. Other people can search members in the group.
`shared` All people in the account can see the group and members automatically
`restricted` Nobody can see the group or search members except the members in the group
22 | search_by_domain *boolean* | Members can search others in the same email domain 23 | search_by_account *boolean* | Members can search others under same account 24 | search_by_ma_account *boolean* | Members can search others under same master account, including all sub accounts 25 | 26 | -------------------------------------------------------------------------------- /source/includes/pac/get_userId_pac.md.erb: -------------------------------------------------------------------------------- 1 | ## List user's PAC accounts 2 | 3 | List user's PAC accounts 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/users/{userId}/pac 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/pac 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "tsp_accounts": [ 26 | { 27 | "dedicated_dial_in_number": [ 28 | { 29 | "number": "string", 30 | "country": "string" 31 | } 32 | ], 33 | "global_dial_in_numbers": [ 34 | { 35 | "number": "string", 36 | "country": "string" 37 | } 38 | ], 39 | "conference_id": "integer", 40 | "participant_password": "string", 41 | "listen_only_password": "string" 42 | } 43 | ] 44 | } 45 | ``` 46 | 47 | Path Arguments |   48 | --- | --- 49 | userId **required** | The user ID or email address 50 | 51 | -------------------------------------------------------------------------------- /source/includes/meetings/put_meetingId_registrants_status.md.erb: -------------------------------------------------------------------------------- 1 | ## Update a meeting registrant's status 2 | 3 | Update a meeting registrant's status 4 | 5 | > Definition 6 | 7 | ```shell 8 | PUT https://api.zoom.us/v2/meetings/{meetingId}/registrants/status 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/meetings/{meetingId}/registrants/status \ 15 | -d '{ 16 | "action": "string", 17 | "registrants": [ 18 | { 19 | "id": "string", 20 | "email": "string" 21 | } 22 | ] 23 | }' 24 | ``` 25 | 26 | > Example Response 27 | 28 | ```text 29 | 204 No Content 30 | ``` 31 | 32 | Path Arguments |   33 | --- | --- 34 | meetingId **required** | The meeting ID 35 | 36 | Query Arguments |   37 | --- | --- 38 | occurrence_id *optional* | The meeting occurrence ID 39 | 40 | Body Arguments |   41 | --- | --- 42 | action **required** |
`approve` Approve registrant
`cancel` Cancel registrant
`deny` Deny registrant
43 | registrants *optional*
30
| List of registrants 44 | 45 | -------------------------------------------------------------------------------- /source/includes/webinars/put_webinarId_registrants_status.md.erb: -------------------------------------------------------------------------------- 1 | ## Update a webinar registrant's status 2 | 3 | Update a webinar registrant's status 4 | 5 | > Definition 6 | 7 | ```shell 8 | PUT https://api.zoom.us/v2/webinars/{webinarId}/registrants/status 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/webinars/{webinarId}/registrants/status \ 15 | -d '{ 16 | "action": "string", 17 | "registrants": [ 18 | { 19 | "id": "string", 20 | "email": "string" 21 | } 22 | ] 23 | }' 24 | ``` 25 | 26 | > Example Response 27 | 28 | ```text 29 | 204 No Content 30 | ``` 31 | 32 | Path Arguments |   33 | --- | --- 34 | webinarId **required** | The webinar ID 35 | 36 | Query Arguments |   37 | --- | --- 38 | occurrence_id *optional* | The meeting occurrence ID 39 | 40 | Body Arguments |   41 | --- | --- 42 | action **required** |
`approve` Approve registrant
`cancel` Cancel registrant
`deny` Deny registrant
43 | registrants *optional*
30
| List of registrants 44 | 45 | -------------------------------------------------------------------------------- /source/includes/billing/put_accountId_plans_base.md.erb: -------------------------------------------------------------------------------- 1 | ## Update a base plan for a sub account 2 | 3 | Update a base plan for a sub account 4 | 5 | > Definition 6 | 7 | ```shell 8 | PUT https://api.zoom.us/v2/accounts/{accountId}/plans/base 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/accounts/{accountId}/plans/base \ 15 | -d '{ 16 | "type": "string", 17 | "hosts": "integer" 18 | }' 19 | ``` 20 | 21 | > Example Response 22 | 23 | ```text 24 | 204 No Content 25 | ``` 26 | 27 | Path Arguments |   28 | --- | --- 29 | accountId **required** | The account ID 30 | 31 | Body Arguments |   32 | --- | --- 33 | type **required** | Account base plan type 34 | hosts **required** | Account base plan number of hosts. For a Pro Plan, please select a value between 1 and 9. For a Business Plan, please select a value between 10 and 49. For a Education Plan, please select a value between 20 and 149. For a Free Trial Plan, please select a value between 1 and 9999. 35 | 36 | -------------------------------------------------------------------------------- /source/includes/webhooks/index.md.erb: -------------------------------------------------------------------------------- 1 | # Webhooks 2 | 3 | ## The Webhook object 4 | Webhook base object, only available for version 2 webhook 5 | 6 | ```json 7 | { 8 | "url": "string", 9 | "auth_user": "string", 10 | "auth_password": "string", 11 | "events": [ 12 | "string" 13 | ] 14 | } 15 | ``` 16 | 17 | Property | Description 18 | --- | --- 19 | url *string* | Webhook endpoint 20 | auth_user *string* | Webhook auth user name 21 | auth_password *string* | Webhook auth password 22 | events *array* | List of events objects.
`meeting_started` The meeting has started.
`meeting_ended` The meeting has ended.
`meeting_jbh` Attendee has joined a meeting before the host.
`meeting_join` Host hasn’t launched the meeting, attendee is waiting.
`recording_completed` All the Cloud Recordings have completed processing and is available.
`participant_joined` Participant has joined the meeting.
`participant_left` Participant has leaved the meeting.
`meeting_registered` Attendee registered for a meeting or webinar.
`recording_transcript_completed` Recording audio transcript files have processed and are available.
23 | 24 | -------------------------------------------------------------------------------- /source/includes/dashboards/get_crc.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve CRC Port Usage 2 | 3 | Get CRC Port usage hour by hour for a specified time period . 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/metrics/crc 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/metrics/crc?from=string&to=string 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "from": "string [date]", 26 | "to": "string [date]", 27 | "crc_ports_usage": [ 28 | { 29 | "date_time": "string", 30 | "crc_ports_hour_usage": [ 31 | { 32 | "hour": "string", 33 | "max_usage": "integer", 34 | "total_usage": "integer" 35 | } 36 | ] 37 | } 38 | ] 39 | } 40 | ``` 41 | 42 | Query Arguments |   43 | --- | --- 44 | from **required** | Start Date 45 | to **required** | End Date 46 | 47 | -------------------------------------------------------------------------------- /source/includes/groups/get_groupId_members.md.erb: -------------------------------------------------------------------------------- 1 | ## List a group's members 2 | 3 | List a group's members under your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/groups/{groupId}/members 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/groups/{groupId}/members 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_number": "integer", 27 | "page_size": "integer", 28 | "total_records": "integer", 29 | "members": [ 30 | { 31 | "id": "string", 32 | "email": "string", 33 | "first_name": "string", 34 | "last_name": "string", 35 | "type": "integer" 36 | } 37 | ] 38 | } 39 | ``` 40 | 41 | Path Arguments |   42 | --- | --- 43 | groupId **required** | The group ID 44 | 45 | Query Arguments |   46 | --- | --- 47 | page_size *optional*
30
300
| The number of records returned within a single API call 48 | page_number *optional*
1
| Current page number of returned records 49 | 50 | -------------------------------------------------------------------------------- /source/includes/im_groups/get_groups_groupId_members.md.erb: -------------------------------------------------------------------------------- 1 | ## List an IM Group's members 2 | 3 | List an IM Group's members under your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/im/groups/{groupId}/members 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/im/groups/{groupId}/members 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_number": "integer", 27 | "page_size": "integer", 28 | "total_records": "integer", 29 | "members": [ 30 | { 31 | "id": "string", 32 | "email": "string", 33 | "first_name": "string", 34 | "last_name": "string", 35 | "type": "integer" 36 | } 37 | ] 38 | } 39 | ``` 40 | 41 | Path Arguments |   42 | --- | --- 43 | groupId **required** | The group ID 44 | 45 | Query Arguments |   46 | --- | --- 47 | page_size *optional*
30
300
| The number of records returned within a single API call 48 | page_number *optional*
1
| Current page number of returned records 49 | 50 | -------------------------------------------------------------------------------- /source/includes/accounts/get_.md.erb: -------------------------------------------------------------------------------- 1 | ## List sub accounts 2 | 3 | List all the sub accounts under the master account 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/accounts 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/accounts 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_number": "integer", 27 | "page_size": "integer", 28 | "total_records": "integer", 29 | "accounts": [ 30 | { 31 | "id": "string [uuid]", 32 | "account_name": "string", 33 | "owner_email": "string", 34 | "account_type": "string", 35 | "seats": "integer", 36 | "subscription_start_time": "string [date-time]", 37 | "subscription_end_time": "string [date-time]", 38 | "created_at": "string [date-time]" 39 | } 40 | ] 41 | } 42 | ``` 43 | 44 | Query Arguments |   45 | --- | --- 46 | page_size *optional*
30
300
| The number of records returned within a single API call 47 | page_number *optional*
1
| Current page number of returned records 48 | 49 | -------------------------------------------------------------------------------- /source/includes/meetings/get_meetingUUID_participants.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve past meeting participants 2 | 3 | Retrieve ended meeting participants 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/past_meetings/{meetingUUID}/participants 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/past_meetings/{meetingUUID}/participants 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_size": "integer", 27 | "total_records": "integer", 28 | "next_page_token": "string", 29 | "participants": [ 30 | { 31 | "id": "string [uuid]", 32 | "name": "string" 33 | } 34 | ] 35 | } 36 | ``` 37 | 38 | Path Arguments |   39 | --- | --- 40 | meetingUUID **required** | The meeting UUID. 41 | 42 | Query Arguments |   43 | --- | --- 44 | page_size *optional*
30
300
| The number of records returned within a single API call 45 | next_page_token *optional* | Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes. 46 | 47 | -------------------------------------------------------------------------------- /source/includes/cloud_recording/index.md.erb: -------------------------------------------------------------------------------- 1 | # Cloud Recording 2 | 3 | ## The Cloud Recording object 4 | Recording file Object 5 | 6 | ```json 7 | { 8 | "id": "string", 9 | "meeting_id": "string", 10 | "recording_start": "string", 11 | "recording_end": "string", 12 | "file_type": "string", 13 | "file_size": "number", 14 | "play_url": "string", 15 | "download_url": "string", 16 | "status": "string", 17 | "deleted_time": "string", 18 | "recording_type": "string" 19 | } 20 | ``` 21 | 22 | Property | Description 23 | --- | --- 24 | id *string* | The recording file ID.Response in general query. 25 | meeting_id *string* | The meeting ID. 26 | recording_start *string* | The recording start time 27 | recording_end *string* | The recording end time. Response in general query. 28 | file_type *string* | The recording file type 29 | file_size *number* | The recording file size 30 | play_url *string* | The recording file play url. Response in general query. 31 | download_url *string* | The recording download url. Response in general query. 32 | status *string* | The recording status. Response in general query. 33 | deleted_time *string* | The recording delete time. Response in trash query. 34 | recording_type *string* | The recording file type, active_speaker or gallery_view 35 | 36 | -------------------------------------------------------------------------------- /source/includes/appendix/lists/_callout_countries.md.erb: -------------------------------------------------------------------------------- 1 | ## Callout Countries 2 | 3 | ID|Name 4 | ---|--- 5 | DE|Germany 6 | HK|Hong Kong 7 | TW|Taiwan 8 | PT|Portugal 9 | DK|Denmark 10 | LT|Lithuania 11 | LU|Luxembourg 12 | PY|Paraguay 13 | HR|Croatia 14 | LV|Latvia 15 | UA|Ukraine 16 | HU|Hungary 17 | QA|Qatar 18 | UG|Uganda 19 | ID|Indonesia 20 | IE|Ireland 21 | EC|Ecuador 22 | US|US 23 | EE|Estonia 24 | EG|Egypt 25 | MO|Macau 26 | IL|Israel 27 | AE|United Arab Emirates 28 | IN|India 29 | MT|Malta 30 | ZA|South Africa 31 | IT|Italy 32 | MX|Mexico 33 | MY|Malaysia 34 | ES|Spain 35 | VE|Venezuela 36 | OM_mobile|Oman Mobile 37 | AR|Argentina 38 | AT|Austria 39 | AU|Australia 40 | VN|Vietnam 41 | NG|Nigeria 42 | RO|Romania 43 | NL|Netherlands 44 | NO|Norway 45 | BE|Belgium 46 | FI|Finland 47 | RU|Russia 48 | BG|Bulgaria 49 | BH|Bahrain 50 | JP|Japan 51 | FR|France 52 | NZ|New Zealand 53 | BO|Bolivia 54 | SA|Saudi Arabia 55 | BR|Brazil 56 | SE|Sweden 57 | SG|Singapore 58 | SI|Slovenia 59 | SK|Slovakia 60 | KE|Kenya 61 | GB|United Kingdom 62 | CA|Canada 63 | GE|Georgia 64 | OM|Oman 65 | CH|Switzerland 66 | KR|South Korea 67 | CL|Chile 68 | CN|China 69 | GR|Greece 70 | TW_mobile|Taiwan Mobile 71 | CO|Colombia 72 | CR|Costa Rica 73 | PA|Panama 74 | TH|Thailand 75 | PE|Peru 76 | CY|Cyprus 77 | CZ|Czech Republic 78 | PH|Philippines 79 | PL|Poland 80 | TR|Turkey -------------------------------------------------------------------------------- /source/includes/accounts/patch_accountId_options.md.erb: -------------------------------------------------------------------------------- 1 | ## Update a sub account's options 2 | 3 | Update a sub account's options under the master account 4 | 5 | > Definition 6 | 7 | ```shell 8 | PATCH https://api.zoom.us/v2/accounts/{accountId}/options 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/accounts/{accountId}/options \ 15 | -d '{ 16 | "share_rc": "boolean", 17 | "room_connectors": "string", 18 | "share_mc": "boolean", 19 | "meeting_connectors": "string", 20 | "pay_mode": "string" 21 | }' 22 | ``` 23 | 24 | > Example Response 25 | 26 | ```text 27 | 204 No Content 28 | ``` 29 | 30 | Path Arguments |   31 | --- | --- 32 | accountId **required** | The account ID 33 | 34 | Body Arguments |   35 | --- | --- 36 | share_rc *optional*
false
| Enable Share Virtual Room Connector 37 | room_connectors *optional* | Virtual Room Connector, multiple value separated by comma 38 | share_mc *optional*
false
| Enable Share Meeting Connector 39 | meeting_connectors *optional* | Meeting Connector, multiple values separated by comma 40 | pay_mode *optional*
master
| Payee
`master` Master account holder pays
`sub` Sub account holder pays
41 | 42 | -------------------------------------------------------------------------------- /source/includes/dashboards/get_zoomrooms.md.erb: -------------------------------------------------------------------------------- 1 | ## List Zoom Rooms 2 | 3 | List all zoom rooms on account 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/metrics/zoomrooms 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/metrics/zoomrooms 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_number": "integer", 27 | "page_size": "integer", 28 | "total_records": "integer", 29 | "zoom_rooms": [ 30 | { 31 | "id": "string", 32 | "room_name": "string", 33 | "calender_name": "string", 34 | "email": "string", 35 | "account_type": "string", 36 | "status": "string", 37 | "device_ip": "string", 38 | "camera": "string", 39 | "microphone": "string", 40 | "speaker": "string", 41 | "last_start_time": "string" 42 | } 43 | ] 44 | } 45 | ``` 46 | 47 | Query Arguments |   48 | --- | --- 49 | page_size *optional*
30
300
| The number of records returned within a single API call 50 | page_number *optional*
1
| Current page number of returned records 51 | 52 | -------------------------------------------------------------------------------- /source/includes/appendix/lists/_tollfree_countries.md.erb: -------------------------------------------------------------------------------- 1 | ## Toll Free Countries 2 | 3 | ID|Name 4 | ---|--- 5 | AR|Argentina 6 | AU|Australia 7 | AT|Austria 8 | BS|Bahamas 9 | BH|Bahrain 10 | BE|Belgium 11 | BO|Bolivia 12 | BA|Bosnia and Herzegovina 13 | BR|Brazil 14 | BG|Bulgaria 15 | CA|Canada 16 | CL|Chile 17 | CN|China 18 | CO|Colombia 19 | HR|Croatia 20 | CY|Cyprus 21 | CZ|Czech Republic 22 | DK|Denmark 23 | DO|Dominican Republic 24 | EC|Ecuador 25 | FJ|Fiji 26 | FI|Finland 27 | FR|France 28 | DE|Germany 29 | GH|Ghana 30 | GR|Greece 31 | HN|Honduras 32 | HK|Hong Kong 33 | HU|Hungary 34 | IN|India 35 | IE|Ireland 36 | IL|Israel 37 | IT|Italy 38 | JP|Japan 39 | KE|Kenya 40 | LV|Latvia 41 | LT|Lithuania 42 | LU|Luxembourg 43 | MO|Macau 44 | MK|Macedonia [FYROM] 45 | MY|Malaysia 46 | MT|Malta 47 | MX|Mexico 48 | NL|Netherlands 49 | NZ|New Zealand 50 | NO|Norway 51 | OM|Oman 52 | PA|Panama 53 | PY|Paraguay 54 | PE|Peru 55 | PH|Philippines 56 | PL|Poland 57 | PT|Portugal 58 | PR|Puerto Rico 59 | QA|Qatar 60 | RO|Romania 61 | RU|Russia 62 | SA|Saudi Arabia 63 | SG|Singapore 64 | SK|Slovakia 65 | SI|Slovenia 66 | ZA|South Africa 67 | KR|South Korea 68 | ES|Spain 69 | SE|Sweden 70 | CH|Switzerland 71 | TW|Taiwan 72 | TR|Turkey 73 | UA|Ukraine 74 | AE|United Arab Emirates 75 | GB|United Kingdom 76 | US|United States 77 | VE|Venezuela 78 | GT|Guatemala 79 | IS|Iceland 80 | UY|Uruguay -------------------------------------------------------------------------------- /source/includes/reference/_errors.md.erb: -------------------------------------------------------------------------------- 1 | # Errors 2 | 3 | The Zoom API uses HTTP Status codes to reflect a successful or error requests. 2XX status codes represent a successful request, 4XX/5XX status codes represent an error took place. If you receive an error HTTP status code, check the body for an error code and message. 4 | 5 | > Error response example 6 | 7 | ```json 8 | { 9 | "code" : 300, 10 | "message" : "Request Body should be a valid JSON object." 11 | } 12 | ``` 13 | 14 | > Error response when sending invalid fields 15 | 16 | ```json 17 | { 18 | "code": 300, 19 | "message": "Validation Failed.", 20 | "errors": [ 21 | { 22 | "field": "user_info.email", 23 | "message": "Invalid field." 24 | }, 25 | { 26 | "field": "user_info.type", 27 | "message": "Invalid field." 28 | } 29 | ] 30 | } 31 | ``` 32 | 33 | Status Code | Description | Most Likely Cause 34 | ------------|-------------|------------------ 35 | 2XX | Successful Request |   36 | 400 | Bad Request | Invalid/missing data 37 | 401 | Unauthorized | Invalid/missing credentials 38 | 404 | Not Found | The resource dosen't exists, ex. invalid/non-existent user id 39 | 409 | Conflict | Trying to overwrite a resource, ex. when creating a user with an email that already exists 40 | 429 | Too Many Requests | Hit an API rate limit -------------------------------------------------------------------------------- /source/includes/im_chat/get_chat_sessions.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve IM Chat sessions 2 | 3 | Retrieve IM Chat sessions for a specified period 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/im/chat/sessions 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/im/chat/sessions?from=string&to=string 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "from": "string [date]", 26 | "to": "string [date]", 27 | "page_size": "integer", 28 | "next_page_token": "string", 29 | "sessions": [ 30 | { 31 | "session_id": "string", 32 | "type": "string", 33 | "name": "string", 34 | "last_message_sent_time": "string [date-time]" 35 | } 36 | ] 37 | } 38 | ``` 39 | 40 | Query Arguments |   41 | --- | --- 42 | from **required** | Start Date 43 | to **required** | End Date 44 | page_size *optional*
30
300
| The number of records returned within a single API call 45 | next_page_token *optional* | Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes. 46 | 47 | -------------------------------------------------------------------------------- /source/includes/webinars/get_userId_webinars.md.erb: -------------------------------------------------------------------------------- 1 | ## List webinars 2 | 3 | List webinars for a user 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/users/{userId}/webinars 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/webinars 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_number": "integer", 27 | "page_size": "integer", 28 | "total_records": "integer", 29 | "webinars": [ 30 | { 31 | "uuid": "string", 32 | "id": "string", 33 | "host_id": "string", 34 | "topic": "string", 35 | "type": "integer", 36 | "duration": "integer", 37 | "timezone": "string", 38 | "created_at": "string [date-time]", 39 | "join_url": "string" 40 | } 41 | ] 42 | } 43 | ``` 44 | 45 | Path Arguments |   46 | --- | --- 47 | userId **required** | The user ID or email address 48 | 49 | Query Arguments |   50 | --- | --- 51 | page_size *optional*
30
300
| The number of records returned within a single API call 52 | page_number *optional*
1
| Current page number of returned records 53 | 54 | -------------------------------------------------------------------------------- /source/includes/dashboards/get_webinars_webinarId.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve webinar detail 2 | 3 | Retrieve live or past webinars detail 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/metrics/webinars/{webinarId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/metrics/webinars/{webinarId} 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "uuid": "string [uuid]", 26 | "id": "integer", 27 | "topic": "string", 28 | "host": "string", 29 | "email": "string", 30 | "user_type": "string", 31 | "start_time": "string [date-time]", 32 | "end_time": "string [date-time]", 33 | "duration": "string", 34 | "participants": "integer", 35 | "has_pstn": "boolean", 36 | "has_voip": "boolean", 37 | "has_3rd_party_audio": "boolean", 38 | "has_video": "boolean", 39 | "has_screen_share": "boolean", 40 | "has_recording": "boolean", 41 | "has_sip": "boolean" 42 | } 43 | ``` 44 | 45 | Path Arguments |   46 | --- | --- 47 | webinarId **required** | The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance. 48 | 49 | Query Arguments |   50 | --- | --- 51 | type *optional*
live
| The webinar type
`past` past webinar
`live` live webinar
52 | 53 | -------------------------------------------------------------------------------- /source/includes/users/get_userId.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve a user 2 | 3 | Retrieve a user on your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/users/{userId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId} 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "id": "string", 26 | "first_name": "string", 27 | "last_name": "string", 28 | "email": "string", 29 | "type": "integer", 30 | "pmi": "string", 31 | "timezone": "string", 32 | "dept": "string", 33 | "created_at": "string [date-time]", 34 | "last_login_time": "string [date-time]", 35 | "last_client_version": "string", 36 | "vanity_url": "string", 37 | "personal_meeting_url": "string", 38 | "verified": "integer", 39 | "pic_url": "string", 40 | "cms_user_id": "string", 41 | "account_id": "string", 42 | "host_key": "string", 43 | "group_ids": [ 44 | "string" 45 | ], 46 | "im_group_ids": [ 47 | "string" 48 | ] 49 | } 50 | ``` 51 | 52 | Path Arguments |   53 | --- | --- 54 | userId **required** | The user ID or email address 55 | 56 | Query Arguments |   57 | --- | --- 58 | login_type *optional* |
`0` Facebook
`1` Google
`99` API
`100` Zoom
`101` SSO
59 | 60 | -------------------------------------------------------------------------------- /source/includes/dashboards/get_meetings_meetingId.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve meeting detail 2 | 3 | Retrieve live or past meetings detail 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/metrics/meetings/{meetingId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/metrics/meetings/{meetingId} 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "uuid": "string [uuid]", 26 | "id": "integer", 27 | "topic": "string", 28 | "host": "string", 29 | "email": "string", 30 | "user_type": "string", 31 | "start_time": "string [date-time]", 32 | "end_time": "string [date-time]", 33 | "duration": "string", 34 | "participants": "integer", 35 | "has_pstn": "boolean", 36 | "has_voip": "boolean", 37 | "has_3rd_party_audio": "boolean", 38 | "has_video": "boolean", 39 | "has_screen_share": "boolean", 40 | "has_recording": "boolean", 41 | "has_sip": "boolean" 42 | } 43 | ``` 44 | 45 | Path Arguments |   46 | --- | --- 47 | meetingId **required** | The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. 48 | 49 | Query Arguments |   50 | --- | --- 51 | type *optional*
live
| The meeting type
`past` past meeting
`pastOne` past one user meeting
`live` live meeting
52 | 53 | -------------------------------------------------------------------------------- /Vagrantfile: -------------------------------------------------------------------------------- 1 | Vagrant.configure(2) do |config| 2 | config.vm.box = "ubuntu/trusty64" 3 | config.vm.network :forwarded_port, guest: 4567, host: 4567 4 | 5 | config.vm.provision "bootstrap", 6 | type: "shell", 7 | inline: <<-SHELL 8 | sudo apt-get update 9 | sudo apt-get install -yq ruby2.0 ruby2.0-dev pkg-config build-essential nodejs git libxml2-dev libxslt-dev 10 | sudo apt-get autoremove -yq 11 | gem2.0 install --no-ri --no-rdoc bundler 12 | SHELL 13 | 14 | # add the local user git config to the vm 15 | config.vm.provision "file", source: "~/.gitconfig", destination: ".gitconfig" 16 | 17 | config.vm.provision "install", 18 | type: "shell", 19 | privileged: false, 20 | inline: <<-SHELL 21 | echo "==============================================" 22 | echo "Installing app dependencies" 23 | cd /vagrant 24 | bundle config build.nokogiri --use-system-libraries 25 | bundle install 26 | SHELL 27 | 28 | config.vm.provision "run", 29 | type: "shell", 30 | privileged: false, 31 | run: "always", 32 | inline: <<-SHELL 33 | echo "==============================================" 34 | echo "Starting up middleman at http://localhost:4567" 35 | echo "If it does not come up, check the ~/middleman.log file for any error messages" 36 | cd /vagrant 37 | bundle exec middleman server --force-polling --latency=1 &> ~/middleman.log & 38 | SHELL 39 | end 40 | -------------------------------------------------------------------------------- /source/includes/accounts/index.md.erb: -------------------------------------------------------------------------------- 1 | # Accounts 2 | 3 | ## The Account object 4 | The account object represents an account on zoom. The person who created the account, or who the account was created for, is referred to as the account owner. You can read more about the Zoom account structure here. 5 | 6 | ```json 7 | { 8 | "first_name": "string", 9 | "last_name": "string", 10 | "email": "string", 11 | "password": "string", 12 | "options": { 13 | "share_rc": "boolean", 14 | "room_connectors": "string", 15 | "share_mc": "boolean", 16 | "meeting_connectors": "string", 17 | "pay_mode": "string" 18 | } 19 | } 20 | ``` 21 | 22 | Property | Description 23 | --- | --- 24 | first_name *string* | User's first name 25 | last_name *string* | User's last name 26 | email *string* | User's email address 27 | password *string* | User's password 28 | options.share_rc *boolean* | Enable Share Virtual Room Connector 29 | options.room_connectors *string* | Virtual Room Connector, multiple value separated by comma 30 | options.share_mc *boolean* | Enable Share Meeting Connector 31 | options.meeting_connectors *string* | Meeting Connector, multiple values separated by comma 32 | options.pay_mode *string* | Payee
`master` Master account holder pays
`sub` Sub account holder pays
33 | 34 | -------------------------------------------------------------------------------- /source/includes/cloud_recording/get_meetingId_recordings.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve a meeting’s all recordings 2 | 3 | Retrieve a meeting’s all recordings 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/meetings/{meetingId}/recordings 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/meetings/{meetingId}/recordings 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "uuid": "string", 26 | "id": "string", 27 | "account_id": "string", 28 | "host_id": "string", 29 | "topic": "string", 30 | "start_time": "string [date-time]", 31 | "duration": "integer", 32 | "total_size": "string", 33 | "recording_count": "string", 34 | "recording_files": [ 35 | { 36 | "id": "string", 37 | "meeting_id": "string", 38 | "recording_start": "string", 39 | "recording_end": "string", 40 | "file_type": "string", 41 | "file_size": "number", 42 | "play_url": "string", 43 | "download_url": "string", 44 | "status": "string", 45 | "deleted_time": "string", 46 | "recording_type": "string" 47 | } 48 | ] 49 | } 50 | ``` 51 | 52 | Path Arguments |   53 | --- | --- 54 | meetingId **required** | The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. 55 | 56 | -------------------------------------------------------------------------------- /source/includes/im_groups/patch_groups_groupId.md.erb: -------------------------------------------------------------------------------- 1 | ## Update an IM Group 2 | 3 | Update an IM Group under your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | PATCH https://api.zoom.us/v2/im/groups/{groupId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/im/groups/{groupId} \ 15 | -d '{ 16 | "name": "string", 17 | "type": "string", 18 | "search_by_domain": "boolean", 19 | "search_by_account": "boolean", 20 | "search_by_ma_account": "boolean" 21 | }' 22 | ``` 23 | 24 | > Example Response 25 | 26 | ```text 27 | 204 No Content 28 | ``` 29 | 30 | Path Arguments |   31 | --- | --- 32 | groupId **required** | The group ID 33 | 34 | Body Arguments |   35 | --- | --- 36 | name *optional*
128
| Group name, must be unique in one account 37 | type *optional* | IM Group type
`normal` Only members can see the group automatically. Other people can search members in the group.
`shared` All people in the account can see the group and members automatically
`restricted` Nobody can see the group or search members except the members in the group
38 | search_by_domain *optional* | Members can search others in the same email domain 39 | search_by_account *optional* | Members can search others under same account 40 | search_by_ma_account *optional* | Members can search others under same master account, including all sub accounts 41 | 42 | -------------------------------------------------------------------------------- /source/includes/appendix/lists/_state.md.erb: -------------------------------------------------------------------------------- 1 | ## States 2 | 3 | ID|Name 4 | ---|--- 5 | AK|Alaska 6 | AL|Alabama 7 | AP|Armed Forces Pacific 8 | AR|Arkansas 9 | AS|American Samoa 10 | AZ|Arizona 11 | CA|California 12 | CO|Colorado 13 | CT|Connecticut 14 | DC|District of Columbia 15 | DE|Delaware 16 | FL|Florida 17 | FM|Federated States of Micronesia 18 | GA|Georgia 19 | GU|Guam 20 | HI|Hawaii 21 | IA|Iowa 22 | ID|Idaho 23 | IL|Illinois 24 | IN|Indiana 25 | KS|Kansas 26 | KY|Kentucky 27 | LA|Louisiana 28 | MA|Massachusetts 29 | MD|Maryland 30 | ME|Maine 31 | MH|Marshall Islands 32 | MI|Michigan 33 | MN|Minnesota 34 | MO|Missouri 35 | MP|Northern Mariana Islands 36 | MS|Mississippi 37 | MT|Montana 38 | NC|North Carolina 39 | ND|North Dakota 40 | NE|Nebraska 41 | NH|New Hampshire 42 | NJ|New Jersey 43 | NM|New Mexico 44 | NV|Nevada 45 | NY|New York 46 | OH|Ohio 47 | OK|Oklahoma 48 | OR|Oregon 49 | PA|Pennsylvania 50 | PR|Puerto Rico 51 | PW|Palau 52 | RI|Rhode Island 53 | SC|South Carolina 54 | SD|South Dakota 55 | TN|Tennessee 56 | TX|Texas 57 | UT|Utah 58 | VA|Virginia 59 | VI|Virgin Islands 60 | VT|Vermont 61 | WA|Washington 62 | WV|West Virginia 63 | WI|Wisconsin 64 | WY|Wyoming 65 | | 66 | AB|Alberta 67 | BC|British Columbia 68 | MB|Manitoba 69 | NB|New Brunswick 70 | NL|Newfoundland 71 | NS|Nova Scotia 72 | NU|Nunavut 73 | ON|Ontario 74 | PE|Prince Edward Island 75 | QC|Quebec 76 | SK|Saskatchewan 77 | NT|Northwest Territories 78 | YT|Yukon Territory 79 | AA|Armed Forces Americas 80 | AE|Armed Forces Europe, Middle East, & Canada -------------------------------------------------------------------------------- /source/includes/tsp/patch_userId_tsp_tspId.md.erb: -------------------------------------------------------------------------------- 1 | ## Update a TSP account 2 | 3 | Update a user's TSP account 4 | 5 | > Definition 6 | 7 | ```shell 8 | PATCH https://api.zoom.us/v2/users/{userId}/tsp/{tspId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/tsp/{tspId} \ 15 | -d '{ 16 | "conference_code": "string", 17 | "leader_pin": "string", 18 | "dial_in_numbers": [ 19 | { 20 | "code": "string", 21 | "number": "string", 22 | "type": "string" 23 | } 24 | ] 25 | }' 26 | ``` 27 | 28 | > Example Response 29 | 30 | ```text 31 | 204 No Content 32 | ``` 33 | 34 | Path Arguments |   35 | --- | --- 36 | userId **required** | The user ID or email address 37 | tspId **required** | TSP account index 38 | 39 | Body Arguments |   40 | --- | --- 41 | conference_code **required**
16
| Conference code, numeric value, length is less than 16. 42 | leader_pin **required**
16
| Leader PIN, numeric value, length is less than 16. 43 | dial_in_numbers **required** | List of Dial In Numbers 44 | dial_in_numbers[0].code **required**
6
| Country Code 45 | dial_in_numbers[0].number **required**
16
| Dial-in number, length is less than 16. 46 | dial_in_numbers[0].type *optional* | Number type
`toll` Toll number
`tollfree` Toll free number
-------------------------------------------------------------------------------- /source/includes/reference/_index.md.erb: -------------------------------------------------------------------------------- 1 |
API Reference
2 | 3 | # Introduction 4 | 5 | The Zoom API provides the ability for developers to easily add Video, Voice and Screen Sharing to your application. Our API is a server side implementation designed around REST, it does not support cross-origin resource sharing or access via a client side web application. 6 | 7 | The Zoom API helps manage the pre-meeting experience such as creating, editing and deleting resources like users, meetings and webinars. It also provides access to post-meeting information for tasks such as reporting and analytics. It does not provide access to the in-meeting experience such as current attendee list, who is current speaker or ability to mute participants; if you seek these features please have a look at our SDKs. 8 | 9 | If you are looking to test our v2 APIs using POSTMAN, please check out our recent blog post [version 2 API with postman] (https://developer.zoom.us/blog/using-zoom-apis-version-2-with-postman/) 10 | 11 | ## Endpoint 12 | 13 | `<%= config[:api_host] %>` 14 | 15 | The Zoom API endpoint is pretty straight forward. We require that you send all requests via https, requests sent to http will receive a 302 HTTP response code. The base URL is api.zoom.us followed by the version number of the API, currently at version 2. 16 | 17 | ## Webhooks 18 | 19 | Webhooks can be used as notifications to keep your systems in sync with actions inside Zoom. Find more information about webhooks on the [Developer Portal](https://developer.zoom.us/docs/webhooks/) 20 | -------------------------------------------------------------------------------- /source/includes/billing/get_accountId_plans.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve plan information for a sub account 2 | 3 | Retrieve plan information for a sub account under the master account 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/accounts/{accountId}/plans 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/accounts/{accountId}/plans 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "plan_base": { 26 | "type": "string", 27 | "hosts": "integer" 28 | }, 29 | "plan_zoom_rooms": { 30 | "type": "string", 31 | "hosts": "integer" 32 | }, 33 | "plan_room_connector": { 34 | "type": "string", 35 | "hosts": "integer" 36 | }, 37 | "plan_large_meeting": [ 38 | { 39 | "type": "string", 40 | "hosts": "integer" 41 | } 42 | ], 43 | "plan_webinar": [ 44 | { 45 | "type": "string", 46 | "hosts": "integer" 47 | } 48 | ], 49 | "plan_recording": "string", 50 | "plan_audio": { 51 | "type": "string", 52 | "tollfree_countries": "string", 53 | "premium_countries": "string", 54 | "callout_countries": "string", 55 | "ddi_numbers": "integer" 56 | } 57 | } 58 | ``` 59 | 60 | Path Arguments |   61 | --- | --- 62 | accountId **required** | The account ID 63 | 64 | -------------------------------------------------------------------------------- /source/includes/im_chat/get_chat_sessions_sessionId.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve IM Chat messages 2 | 3 | Retrieve IM Chat messages for a specified period 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/im/chat/sessions/{sessionId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/im/chat/sessions/{sessionId}?from=string&to=string 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "session_id": "string", 26 | "from": "string [date]", 27 | "to": "string [date]", 28 | "page_size": "integer", 29 | "next_page_token": "string", 30 | "messages": [ 31 | { 32 | "message": "string", 33 | "sender": "string", 34 | "date_time": "string [date-time]", 35 | "action": "string", 36 | "action_time": "string [date-time]" 37 | } 38 | ] 39 | } 40 | ``` 41 | 42 | Path Arguments |   43 | --- | --- 44 | sessionId **required** | IM Chat Session ID 45 | 46 | Query Arguments |   47 | --- | --- 48 | from **required** | Start Date 49 | to **required** | End Date 50 | page_size *optional*
30
300
| The number of records returned within a single API call 51 | next_page_token *optional* | Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes. 52 | 53 | -------------------------------------------------------------------------------- /source/includes/billing/patch_accountId_billing.md.erb: -------------------------------------------------------------------------------- 1 | ## Update billing information for a sub account 2 | 3 | Update billing information for a sub account under the master account 4 | 5 | > Definition 6 | 7 | ```shell 8 | PATCH https://api.zoom.us/v2/accounts/{accountId}/billing 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/accounts/{accountId}/billing \ 15 | -d '{ 16 | "first_name": "string", 17 | "last_name": "string", 18 | "email": "string", 19 | "phone_number": "string", 20 | "address": "string", 21 | "apt": "string", 22 | "city": "string", 23 | "state": "string", 24 | "zip": "string", 25 | "country": "string" 26 | }' 27 | ``` 28 | 29 | > Example Response 30 | 31 | ```text 32 | 204 No Content 33 | ``` 34 | 35 | Path Arguments |   36 | --- | --- 37 | accountId **required** | The account ID 38 | 39 | Body Arguments |   40 | --- | --- 41 | first_name *optional* | Billing Contact's first name 42 | last_name *optional* | Billing Contact's last name 43 | email *optional* | Billing Contact's email address 44 | phone_number *optional* | Billing Contact's phone number 45 | address *optional* | Billing Contact's address 46 | apt *optional* | Billing Contact's apartment/suite 47 | city *optional* | Billing Contact's city 48 | state *optional* | Billing Contact's state 49 | zip *optional* | Billing Contact's zip/postal code 50 | country *optional* | Billing Contact's country 51 | 52 | -------------------------------------------------------------------------------- /source/includes/webhooks/patch_webhookId.md.erb: -------------------------------------------------------------------------------- 1 | ## Update a webhook 2 | 3 | Update a webhook 4 | 5 | > Definition 6 | 7 | ```shell 8 | PATCH https://api.zoom.us/v2/webhooks/{webhookId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/webhooks/{webhookId} \ 15 | -d '{ 16 | "url": "string", 17 | "auth_user": "string", 18 | "auth_password": "string", 19 | "events": [ 20 | "string" 21 | ] 22 | }' 23 | ``` 24 | 25 | > Example Response 26 | 27 | ```text 28 | 204 No Content 29 | ``` 30 | 31 | Path Arguments |   32 | --- | --- 33 | webhookId **required** | The webhook ID 34 | 35 | Body Arguments |   36 | --- | --- 37 | url *optional*
256
| Webhook endpoint 38 | auth_user *optional*
128
| Webhook auth user name 39 | auth_password *optional*
64
| Webhook auth password 40 | events *optional* | List of events objects
`meeting_started` The meeting has started.
`meeting_ended` The meeting has ended.
`meeting_jbh` Attendee has joined a meeting before the host.
`meeting_join` Host hasn’t launched the meeting, attendee is waiting.
`recording_completed` All the Cloud Recordings has completed processing and is available.
`participant_joined` Participant has joined the meeting.
`participant_left` Participant has leaved the meeting.
`meeting_registered` Attendee registered for a meeting or webinar.
`recording_transcript_completed` Recording audio transcript files have processed and are available.
41 | 42 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ### This definition is no longer being maintained. Please visit our [new documentation](https://marketplace.zoom.us/docs/api-reference/introduction) to get started using the Zoom API. 2 | 3 | # Zoom API Version 2 4 | 5 | This repo is the source code for our documentation. You can view the documentation [here](https://zoom.github.io/api). 6 | 7 | Feel free to submit [issues](https://github.com/zoom/api/issues) or fork this repo and contribute changes. 8 | 9 | ## Getting Started 10 | 11 | The Zoom API provides the ability for developers to easily add Video, Voice and Screen Sharing to your application. Our API is a server side implementation designed around REST, it does not support cross-origin resource sharing or access via a client side web application. 12 | 13 | The Zoom API helps manage the pre-meeting experience such as creating, editing and deleting resources like users, meetings and webinars. It also provides access to post-meeting information for tasks such as reporting and analytics. It does not provide access to the in-meeting experience such as current attendee list, who is current speaker or ability to mute participants; if you seek these features please have a look at our SDKs. 14 | 15 | # For recent changes to our API, please visit our developer site. 16 | - https://marketplace.zoom.us/docs/changelog 17 | 18 | ## Need help? 19 | 20 | If you're looking for help, try [Developer Support](https://devsupport.zoom.us) or our [Developer Forum](https://devforum.zoom.us). Priority support is also available with [Premier Developer Support](https://zoom.us/docs/en-us/developer-support-plans.html) plans. 21 | -------------------------------------------------------------------------------- /source/includes/im_groups/post_groups.md.erb: -------------------------------------------------------------------------------- 1 | ## Create an IM Group 2 | 3 | Create a IM Group under your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | POST https://api.zoom.us/v2/im/groups 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/im/groups \ 15 | -d '{ 16 | "name": "string", 17 | "type": "string", 18 | "search_by_domain": "boolean", 19 | "search_by_account": "boolean", 20 | "search_by_ma_account": "boolean" 21 | }' 22 | ``` 23 | 24 | > Example Response 25 | 26 | ```text 27 | 201 Created 28 | ``` 29 | 30 | ```json 31 | { 32 | "id": "string", 33 | "name": "string", 34 | "total_members": "integer", 35 | "search_by_domain": "boolean", 36 | "search_by_account": "boolean", 37 | "search_by_ma_account": "boolean" 38 | } 39 | ``` 40 | 41 | Body Arguments |   42 | --- | --- 43 | name *optional*
128
| Group name, must be unique in one account 44 | type *optional*
normal
| IM Group type
`normal` Only members can see the group automatically. Other people can search members in the group.
`shared` All people in the account can see the group and members automatically
`restricted` Nobody can see the group or search members except the members in the group
45 | search_by_domain *optional* | Members can search others in the same email domain 46 | search_by_account *optional* | Members can search others under same account 47 | search_by_ma_account *optional* | Members can search others under same master account, including all sub accounts 48 | 49 | -------------------------------------------------------------------------------- /source/includes/meetings/get_userId_meetings.md.erb: -------------------------------------------------------------------------------- 1 | ## List meetings 2 | 3 | List meetings for a user 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/users/{userId}/meetings 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/meetings 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_number": "integer", 27 | "page_size": "integer", 28 | "total_records": "integer", 29 | "meetings": [ 30 | { 31 | "uuid": "string", 32 | "id": "string", 33 | "host_id": "string", 34 | "topic": "string", 35 | "type": "integer", 36 | "start_time": "string [date-time]", 37 | "duration": "integer", 38 | "timezone": "string", 39 | "created_at": "string [date-time]", 40 | "join_url": "string" 41 | } 42 | ] 43 | } 44 | ``` 45 | 46 | Path Arguments |   47 | --- | --- 48 | userId **required** | The user ID or email address 49 | 50 | Query Arguments |   51 | --- | --- 52 | type *optional*
live
| The meeting type
`scheduled` all the scheduled meetings
`live` all the live meetings
`upcoming` all the upcoming meetings
53 | page_size *optional*
30
300
| The number of records returned within a single API call 54 | page_number *optional*
1
| Current page number of returned records 55 | 56 | -------------------------------------------------------------------------------- /source/includes/reports/get_telephone.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve telephone report 2 | 3 | Retrieve telephone report for a specified period . 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/report/telephone 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/report/telephone?from=string&to=string 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "from": "string [date]", 26 | "to": "string [date]", 27 | "page_count": "integer", 28 | "page_number": "integer", 29 | "page_size": "integer", 30 | "total_records": "integer", 31 | "telephony_usage": [ 32 | { 33 | "meeting_id": "integer", 34 | "phone_number": "string", 35 | "host_name": "string", 36 | "host_email": "string", 37 | "dept": "string", 38 | "start_time": "string [date-time]", 39 | "end_time": "string [date-time]", 40 | "duration": "integer", 41 | "total": "number" 42 | } 43 | ] 44 | } 45 | ``` 46 | 47 | Query Arguments |   48 | --- | --- 49 | type *optional*
1
| Audio type
`1` Toll-free Call-in & Call-out
50 | from **required** | Start Date 51 | to **required** | End Date 52 | page_size *optional*
30
300
| The number of records returned within a single API call 53 | page_number *optional*
1
| Current page number of returned records 54 | 55 | -------------------------------------------------------------------------------- /source/includes/reports/get_users.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve hosts report 2 | 3 | Retrieve active or inactive hosts report for a specified period 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/report/users 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/report/users?from=string&to=string 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "from": "string [date]", 26 | "to": "string [date]", 27 | "page_count": "integer", 28 | "page_number": "integer", 29 | "page_size": "integer", 30 | "total_records": "integer", 31 | "total_meetings": "integer", 32 | "total_participants": "integer", 33 | "total_meeting_minutes": "integer", 34 | "users": [ 35 | { 36 | "id": "string [uuid]", 37 | "email": "string", 38 | "user_name": "string", 39 | "type": "integer", 40 | "dept": "string", 41 | "meetings": "integer", 42 | "participants": "integer", 43 | "meeting_minutes": "integer" 44 | } 45 | ] 46 | } 47 | ``` 48 | 49 | Query Arguments |   50 | --- | --- 51 | type *optional* | Active hosts or inactive hosts
`active` Active hosts
`inactive` Inactive hosts
52 | from **required** | Start Date 53 | to **required** | End Date 54 | page_size *optional*
30
300
| The number of records returned within a single API call 55 | page_number *optional*
1
| Current page number of returned records 56 | 57 | -------------------------------------------------------------------------------- /source/includes/users/patch_userId.md.erb: -------------------------------------------------------------------------------- 1 | ## Update a user 2 | 3 | Update a user on your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | PATCH https://api.zoom.us/v2/users/{userId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId} \ 15 | -d '{ 16 | "first_name": "string", 17 | "last_name": "string", 18 | "type": "integer", 19 | "pmi": "string", 20 | "timezone": "string [date-time]", 21 | "dept": "string", 22 | "vanity_name": "string", 23 | "host_key": "string", 24 | "cms_user_id": "string" 25 | }' 26 | ``` 27 | 28 | > Example Response 29 | 30 | ```text 31 | 204 No Content 32 | ``` 33 | 34 | Path Arguments |   35 | --- | --- 36 | userId **required** | The user ID or email address 37 | 38 | Body Arguments |   39 | --- | --- 40 | first_name *optional*
64
| User's first name. Cannot contain more than 5 Chinese words. 41 | last_name *optional*
64
| User's last name. Cannot contain more than 5 Chinese words. 42 | type *optional* | User's type
`1` basic
`2` pro
`3` corp
43 | pmi *optional*
10
| Personal Meeting ID,length must be 10 44 | timezone *optional* | The time zone id for user profile. For this parameter value please refer to the id value in [timezone](#timezones) list. 45 | dept *optional* | Department for user profile, use for report 46 | vanity_name *optional* | Personal meeting room name 47 | host_key *optional*
6
| Host Key, should be 6-digit number 48 | cms_user_id *optional* | Kaltura User Id 49 | 50 | -------------------------------------------------------------------------------- /source/includes/reports/get_webinars_webinarId_participants.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve webinar participants report 2 | 3 | Retrieve ended webinar participants report 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/report/webinars/{webinarId}/participants 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/report/webinars/{webinarId}/participants 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_size": "integer", 27 | "total_records": "integer", 28 | "next_page_token": "string", 29 | "participants": [ 30 | { 31 | "id": "string [uuid]", 32 | "user_id": "string", 33 | "name": "string", 34 | "user_email": "string", 35 | "join_time": "string [date-time]", 36 | "leave_time": "string [date-time]", 37 | "duration": "integer", 38 | "attentiveness_score": "string" 39 | } 40 | ] 41 | } 42 | ``` 43 | 44 | Path Arguments |   45 | --- | --- 46 | webinarId **required** | The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance. 47 | 48 | Query Arguments |   49 | --- | --- 50 | page_size *optional*
30
300
| The number of records returned within a single API call 51 | next_page_token *optional* | Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes. 52 | 53 | -------------------------------------------------------------------------------- /source/includes/reports/get_meetings_meetingId_participants.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve meeting participants report 2 | 3 | Retrieve ended meeting participants report 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/report/meetings/{meetingId}/participants 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/report/meetings/{meetingId}/participants 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_size": "integer", 27 | "total_records": "integer", 28 | "next_page_token": "string", 29 | "participants": [ 30 | { 31 | "id": "string [uuid]", 32 | "user_id": "string", 33 | "name": "string", 34 | "user_email": "string", 35 | "join_time": "string [date-time]", 36 | "leave_time": "string [date-time]", 37 | "duration": "integer", 38 | "attentiveness_score": "integer" 39 | } 40 | ] 41 | } 42 | ``` 43 | 44 | Path Arguments |   45 | --- | --- 46 | meetingId **required** | The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. 47 | 48 | Query Arguments |   49 | --- | --- 50 | page_size *optional*
30
300
| The number of records returned within a single API call 51 | next_page_token *optional* | Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes. 52 | 53 | -------------------------------------------------------------------------------- /source/includes/users/get_.md.erb: -------------------------------------------------------------------------------- 1 | ## List Users 2 | 3 | List users on your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/users 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_number": "integer", 27 | "page_size": "integer", 28 | "total_records": "integer", 29 | "users": [ 30 | { 31 | "id": "string", 32 | "first_name": "string", 33 | "last_name": "string", 34 | "email": "string", 35 | "type": "integer", 36 | "pmi": "string", 37 | "timezone": "string", 38 | "dept": "string", 39 | "created_at": "string [date-time]", 40 | "last_login_time": "string [date-time]", 41 | "last_client_version": "string", 42 | "group_ids": [ 43 | "string" 44 | ], 45 | "im_group_ids": [ 46 | "string" 47 | ] 48 | } 49 | ] 50 | } 51 | ``` 52 | 53 | Query Arguments |   54 | --- | --- 55 | status *optional*
active
| User status
`active` users with active status
`inactive` users with inactive status
`pending` users with pending status
56 | page_size *optional*
30
300
| The number of records returned within a single API call 57 | page_number *optional*
1
| Current page number of returned records 58 | 59 | -------------------------------------------------------------------------------- /source/javascripts/app/_toc.js: -------------------------------------------------------------------------------- 1 | //= require ../lib/_jquery 2 | //= require ../lib/_jquery_ui 3 | //= require ../lib/_jquery.tocify 4 | //= require ../lib/_imagesloaded.min 5 | (function (global) { 6 | 'use strict'; 7 | 8 | var closeToc = function() { 9 | $(".tocify-wrapper").removeClass('open'); 10 | $("#nav-button").removeClass('open'); 11 | }; 12 | 13 | var makeToc = function() { 14 | global.toc = $("#toc").tocify({ 15 | selectors: 'h1, h2', 16 | extendPage: false, 17 | theme: 'none', 18 | smoothScroll: false, 19 | showEffectSpeed: 0, 20 | hideEffectSpeed: 180, 21 | ignoreSelector: '.toc-ignore', 22 | highlightOffset: 60, 23 | scrollTo: -1, 24 | scrollHistory: true, 25 | labelSelector: 'header', 26 | hashGenerator: function (text, element) { 27 | return element.prop('id'); 28 | } 29 | }).data('toc-tocify'); 30 | 31 | $("#nav-button").click(function() { 32 | $(".tocify-wrapper").toggleClass('open'); 33 | $("#nav-button").toggleClass('open'); 34 | return false; 35 | }); 36 | 37 | $(".page-wrapper").click(closeToc); 38 | $(".tocify-item").click(closeToc); 39 | }; 40 | 41 | // Hack to make already open sections to start opened, 42 | // instead of displaying an ugly animation 43 | function animate() { 44 | setTimeout(function() { 45 | toc.setOption('showEffectSpeed', 180); 46 | }, 50); 47 | } 48 | 49 | $(function() { 50 | makeToc(); 51 | animate(); 52 | setupLanguages($('body').data('languages')); 53 | $('.content').show().imagesLoaded( function() { 54 | global.toc.calculateHeights(); 55 | }); 56 | }); 57 | })(window); 58 | 59 | -------------------------------------------------------------------------------- /source/includes/tsp/post_userId_tsp.md.erb: -------------------------------------------------------------------------------- 1 | ## Add a user's TSP account 2 | 3 | Add a user's TSP account 4 | 5 | > Definition 6 | 7 | ```shell 8 | POST https://api.zoom.us/v2/users/{userId}/tsp 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/tsp \ 15 | -d '{ 16 | "conference_code": "string", 17 | "leader_pin": "string", 18 | "dial_in_numbers": [ 19 | { 20 | "code": "string", 21 | "number": "string", 22 | "type": "string" 23 | } 24 | ] 25 | }' 26 | ``` 27 | 28 | > Example Response 29 | 30 | ```text 31 | 201 Created 32 | ``` 33 | 34 | ```json 35 | { 36 | "conference_code": "string", 37 | "leader_pin": "string", 38 | "dial_in_numbers": [ 39 | { 40 | "code": "string", 41 | "number": "string", 42 | "type": "string" 43 | } 44 | ] 45 | } 46 | ``` 47 | 48 | Path Arguments |   49 | --- | --- 50 | userId **required** | The user ID or email address 51 | 52 | Body Arguments |   53 | --- | --- 54 | conference_code **required**
16
| Conference code, numeric value, length is less than 16. 55 | leader_pin **required**
16
| Leader PIN, numeric value, length is less than 16. 56 | dial_in_numbers **required** | List of Dial In Numbers 57 | dial_in_numbers[0].code **required**
6
| Country Code 58 | dial_in_numbers[0].number **required**
16
| Dial-in number, length is less than 16. 59 | dial_in_numbers[0].type *optional* | Number type
`toll` Toll number
`tollfree` Toll free number
-------------------------------------------------------------------------------- /source/includes/webhooks/post_.md.erb: -------------------------------------------------------------------------------- 1 | ## Create a webhook 2 | 3 | Create a webhook for a account 4 | 5 | > Definition 6 | 7 | ```shell 8 | POST https://api.zoom.us/v2/webhooks 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/webhooks \ 15 | -d '{ 16 | "url": "string", 17 | "auth_user": "string", 18 | "auth_password": "string", 19 | "events": [ 20 | "string" 21 | ] 22 | }' 23 | ``` 24 | 25 | > Example Response 26 | 27 | ```text 28 | 201 Created 29 | ``` 30 | 31 | ```json 32 | { 33 | "webhook_id": "string", 34 | "url": "string", 35 | "auth_user": "string", 36 | "auth_password": "string", 37 | "events": [ 38 | "string" 39 | ], 40 | "created_at": "string [date-time]" 41 | } 42 | ``` 43 | 44 | Body Arguments |   45 | --- | --- 46 | url **required**
256
| Webhook endpoint 47 | auth_user **required**
128
| Webhook auth user name 48 | auth_password **required**
64
| Webhook auth password 49 | events **required** | List of events objects.
`meeting_started` The meeting has started.
`meeting_ended` The meeting has ended.
`meeting_jbh` Attendee has joined a meeting before the host.
`meeting_join` Host hasn’t launched the meeting, attendee is waiting.
`recording_completed` All the Cloud Recordings have completed processing and is available.
`participant_joined` Participant has joined the meeting.
`participant_left` Participant has leaved the meeting.
`meeting_registered` Attendee registered for a meeting or webinar.
`recording_transcript_completed` Recording audio transcript files have processed and are available.
50 | 51 | -------------------------------------------------------------------------------- /source/includes/webinars/get_webinarId.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve a webinar 2 | 3 | Retrieve a webinar 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/webinars/{webinarId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/webinars/{webinarId} 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "uuid": "string", 26 | "id": "string", 27 | "host_id": "string", 28 | "topic": "string", 29 | "type": "integer", 30 | "start_time": "string [date-time]", 31 | "duration": "integer", 32 | "timezone": "string", 33 | "agenda": "string", 34 | "created_at": "string [date-time]", 35 | "start_url": "string", 36 | "join_url": "string", 37 | "occurrences": [ 38 | { 39 | "occurrence_id": "integer", 40 | "start_time": "string [date-time]", 41 | "duration": "integer", 42 | "status": "string" 43 | } 44 | ], 45 | "settings": { 46 | "host_video": "boolean", 47 | "panelists_video": "boolean", 48 | "practice_session": "boolean", 49 | "hd_video": "boolean", 50 | "approval_type": "integer", 51 | "registration_type": "integer", 52 | "audio": "string", 53 | "auto_recording": "string", 54 | "enforce_login": "boolean", 55 | "enforce_login_domains": "string", 56 | "alternative_hosts": "string", 57 | "close_registration": "boolean", 58 | "show_share_button": "boolean", 59 | "allow_multiple_devices": "boolean" 60 | } 61 | } 62 | ``` 63 | 64 | Path Arguments |   65 | --- | --- 66 | webinarId **required** | The webinar ID 67 | 68 | -------------------------------------------------------------------------------- /source/includes/dashboards/get_meetings_meetingId_participants_participantId_sharing.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve sharing/recording details of meeting participant 2 | 3 | Retrieve sharing/recording details of live or past meetings participant 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/metrics/meetings/{meetingId}/participants/{participantId}/sharing 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/metrics/meetings/{meetingId}/participants/{participantId}/sharing 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_size": "integer", 27 | "total_records": "integer", 28 | "next_page_token": "string", 29 | "participants": [ 30 | { 31 | "id": "string", 32 | "user_id": "string", 33 | "user_name": "string", 34 | "details": [ 35 | { 36 | "content": "string", 37 | "start_time": "string", 38 | "end_time": "string" 39 | } 40 | ] 41 | } 42 | ] 43 | } 44 | ``` 45 | 46 | Path Arguments |   47 | --- | --- 48 | meetingId **required** | The meeting ID 49 | participantId **required** | The participant ID 50 | 51 | Query Arguments |   52 | --- | --- 53 | type *optional*
live
| The meeting type
`past` past meetings
`live` live meetings
54 | page_size *optional*
30
300
| The amount of records returns within a single API call. 55 | page_number *optional*
1
| Current page number of returned records. 56 | 57 | -------------------------------------------------------------------------------- /source/includes/dashboards/get_webinars_webinarId_participants_participantId_sharing.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve sharing/recording details of webinar participant 2 | 3 | Retrieve sharing/recording details of live or past webinar participant 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/metrics/webinars/{webinarId}/participants/{participantId}/sharing 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/metrics/webinars/{webinarId}/participants/{participantId}/sharing 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_size": "integer", 27 | "total_records": "integer", 28 | "next_page_token": "string", 29 | "participants": [ 30 | { 31 | "id": "string", 32 | "user_id": "string", 33 | "user_name": "string", 34 | "details": [ 35 | { 36 | "content": "string", 37 | "start_time": "string", 38 | "end_time": "string" 39 | } 40 | ] 41 | } 42 | ] 43 | } 44 | ``` 45 | 46 | Path Arguments |   47 | --- | --- 48 | webinarId **required** | The webinar ID 49 | participantId **required** | The participant ID 50 | 51 | Query Arguments |   52 | --- | --- 53 | type *optional*
live
| The webinar type
`past` past webinars
`live` live webinars
54 | page_size *optional*
30
300
| The amount of records returns within a single API call. 55 | page_number *optional*
1
| Current page number of returned records. 56 | 57 | -------------------------------------------------------------------------------- /source/includes/meetings/get_meetingId.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve a meeting 2 | 3 | Retrieve a meeting's details 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/meetings/{meetingId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/meetings/{meetingId} 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "uuid": "string", 26 | "id": "string", 27 | "host_id": "string", 28 | "topic": "string", 29 | "type": "integer", 30 | "start_time": "string [date-time]", 31 | "duration": "integer", 32 | "timezone": "string", 33 | "created_at": "string [date-time]", 34 | "agenda": "string", 35 | "start_url": "string", 36 | "join_url": "string", 37 | "password": "string", 38 | "h323_password": "string", 39 | "occurrences": [ 40 | { 41 | "occurrence_id": "integer", 42 | "start_time": "string [date-time]", 43 | "duration": "integer", 44 | "status": "string" 45 | } 46 | ], 47 | "settings": { 48 | "host_video": "boolean", 49 | "participant_video": "boolean", 50 | "cn_meeting": "boolean", 51 | "in_meeting": "boolean", 52 | "join_before_host": "boolean", 53 | "mute_upon_entry": "boolean", 54 | "watermark": "boolean", 55 | "use_pmi": "boolean", 56 | "approval_type": "integer", 57 | "registration_type": "integer", 58 | "audio": "string", 59 | "auto_recording": "string", 60 | "enforce_login": "boolean", 61 | "enforce_login_domains": "string", 62 | "alternative_hosts": "string" 63 | } 64 | } 65 | ``` 66 | 67 | Path Arguments |   68 | --- | --- 69 | meetingId **required** | The meeting ID 70 | 71 | -------------------------------------------------------------------------------- /source/includes/reports/get_users_userId_meetings.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve meetings report 2 | 3 | Retrieve ended meetings report for a specified period 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/report/users/{userId}/meetings 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/report/users/{userId}/meetings?from=string&to=string 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "from": "string [date]", 26 | "to": "string [date]", 27 | "page_count": "integer", 28 | "page_size": "integer", 29 | "total_records": "integer", 30 | "next_page_token": "string", 31 | "meetings": [ 32 | { 33 | "uuid": "string [uuid]", 34 | "id": "integer", 35 | "type": "integer", 36 | "topic": "string", 37 | "user_name": "string", 38 | "user_email": "string", 39 | "start_time": "string [date-time]", 40 | "end_time": "string [date-time]", 41 | "duration": "integer", 42 | "total_minutes": "integer", 43 | "participants_count": "integer" 44 | } 45 | ] 46 | } 47 | ``` 48 | 49 | Path Arguments |   50 | --- | --- 51 | userId **required** | The user ID or email address 52 | 53 | Query Arguments |   54 | --- | --- 55 | from **required** | Start Date 56 | to **required** | End Date 57 | page_size *optional*
30
300
| The number of records returned within a single API call 58 | next_page_token *optional* | Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes. 59 | 60 | -------------------------------------------------------------------------------- /source/includes/dashboards/get_meetings_meetingId_participants_sharing.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve sharing/recording details of meeting participant 2 | 3 | Retrieve sharing/recording details of live or past meetings participant 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/metrics/meetings/{meetingId}/participants/sharing 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/metrics/meetings/{meetingId}/participants/sharing 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_size": "integer", 27 | "total_records": "integer", 28 | "next_page_token": "string", 29 | "participants": [ 30 | { 31 | "id": "string", 32 | "user_id": "string", 33 | "user_name": "string", 34 | "details": [ 35 | { 36 | "content": "string", 37 | "start_time": "string", 38 | "end_time": "string" 39 | } 40 | ] 41 | } 42 | ] 43 | } 44 | ``` 45 | 46 | Path Arguments |   47 | --- | --- 48 | meetingId **required** | The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. 49 | 50 | Query Arguments |   51 | --- | --- 52 | type *optional*
live
| The meeting type
`past` past meeting
`live` live meeting
53 | page_size *optional*
30
300
| The number of records returned within a single API call 54 | next_page_token *optional* | Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes. 55 | 56 | -------------------------------------------------------------------------------- /source/includes/dashboards/get_webinars_webinarId_participants_sharing.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve sharing/recording details of webinar participant 2 | 3 | Retrieve sharing/recording details of live or past webinar participant 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/metrics/webinars/{webinarId}/participants/sharing 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/metrics/webinars/{webinarId}/participants/sharing 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_size": "integer", 27 | "total_records": "integer", 28 | "next_page_token": "string", 29 | "participants": [ 30 | { 31 | "id": "string", 32 | "user_id": "string", 33 | "user_name": "string", 34 | "details": [ 35 | { 36 | "content": "string", 37 | "start_time": "string", 38 | "end_time": "string" 39 | } 40 | ] 41 | } 42 | ] 43 | } 44 | ``` 45 | 46 | Path Arguments |   47 | --- | --- 48 | webinarId **required** | The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance. 49 | 50 | Query Arguments |   51 | --- | --- 52 | type *optional*
live
| The webinar type
`past` past webinar
`live` live webinar
53 | page_size *optional*
30
300
| The number of records returned within a single API call 54 | next_page_token *optional* | Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes. 55 | 56 | -------------------------------------------------------------------------------- /source/includes/appendix/_recurrence.md.erb: -------------------------------------------------------------------------------- 1 | # Recurrence Object 2 | 3 | > Daily Recurrence Example 4 | 5 | ```json 6 | { 7 | "type" : 1, 8 | "repeat_interval" : 2, 9 | "end_date_time" : "2017-1-9T3:00:00Z" 10 | } 11 | ``` 12 | 13 | > Weekly Recurrence Example 14 | 15 | ```json 16 | { 17 | "type" : 2, 18 | "repeat_interval" : 2, 19 | "weekly_days" : "1,2,3,4", 20 | "end_times" : 2 21 | } 22 | ``` 23 | 24 | > Monthly Recurrence Examples 25 | 26 | ```json 27 | { 28 | "type" : 3, 29 | "repeat_interval" : 2, 30 | "monthly_week" : 2, 31 | "monthly_week_day" : 2, 32 | "end_date_time" : "2017-1-9T3:00:00Z" 33 | } 34 | ``` 35 | 36 | ```json 37 | { 38 | "type" : 3, 39 | "repeat_interval" : 2, 40 | "monthly_day" : 2, 41 | "end_times" : 2 42 | } 43 | ``` 44 | 45 | Key | Value 46 | --- | --- 47 | type | Recurrence Meeting Type. 1 means Daily, 2 means Weekly, 3 means Monthly 48 | repeat_interval | Recurrence Meeting Repeat Interval. Defaults to 1. For a Daily Meeting, max of 90. For a Weekly Meeting, max of 12. For a Monthly Meeting, max of 3. 49 | weekly_days | Recurrence Meeting Occurs on week days, multiple value separated by comma. 1 means Sunday, 2 means Monday, 3 means Tuesday, 4 means Wednesday, 5 means Thursday, 6 means Friday, 7 means Saturday. 50 | monthly_day | Recurrence Meeting Occurs on a month day. The value range is from 1 to 31. 51 | monthly_week | Recurrence Meeting Occurs on the week of a month. -1 means Last week, 1 means First week, 2 means Second week, 3 means Third week, 4 means Fourth week. 52 | monthly_week_day | Recurrence Meeting Occurs on the week day of a month. A single value: 1 means Sunday, 2 means Monday, 3 means Tuesday, 4 means Wednesday, 5 means Thursday, 6 means Friday, 7 means Saturday. 53 | end_times | Recurrence Meeting End occurrences times. Defaults to 1. Max of 50. 54 | end_date_time | Recurrence Meeting End Date. Should be UTC time, such as 2012-11-25T12:00:00Z. -------------------------------------------------------------------------------- /source/includes/accounts/post_.md.erb: -------------------------------------------------------------------------------- 1 | ## Create a sub account 2 | 3 | Create a sub account under the master account. . 4 | 5 | > Definition 6 | 7 | ```shell 8 | POST https://api.zoom.us/v2/accounts 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/accounts \ 15 | -d '{ 16 | "first_name": "string", 17 | "last_name": "string", 18 | "email": "string", 19 | "password": "string", 20 | "options": { 21 | "share_rc": "boolean", 22 | "room_connectors": "string", 23 | "share_mc": "boolean", 24 | "meeting_connectors": "string", 25 | "pay_mode": "string" 26 | } 27 | }' 28 | ``` 29 | 30 | > Example Response 31 | 32 | ```text 33 | 201 Created 34 | ``` 35 | 36 | ```json 37 | { 38 | "id": "string", 39 | "owner_id": "string", 40 | "owner_email": "string", 41 | "created_at": "string" 42 | } 43 | ``` 44 | 45 | Body Arguments |   46 | --- | --- 47 | first_name **required** | User's first name 48 | last_name **required** | User's last name 49 | email **required** | User's email address 50 | password **required** | User's password 51 | options.share_rc *optional*
false
| Enable Share Virtual Room Connector 52 | options.room_connectors *optional* | Virtual Room Connector, multiple value separated by comma 53 | options.share_mc *optional*
false
| Enable Share Meeting Connector 54 | options.meeting_connectors *optional* | Meeting Connector, multiple values separated by comma 55 | options.pay_mode *optional*
master
| Payee
`master` Master account holder pays
`sub` Sub account holder pays
56 | 57 | -------------------------------------------------------------------------------- /source/includes/dashboards/get_im.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve IM 2 | 3 | Retrieve metrics of Zoom IM 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/metrics/im 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/metrics/im?from=string&to=string 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "from": "string [date]", 26 | "to": "string [date]", 27 | "page_count": "integer", 28 | "page_size": "integer", 29 | "total_records": "integer", 30 | "next_page_token": "string", 31 | "users": [ 32 | { 33 | "user_id": "string", 34 | "user_name": "string", 35 | "email": "string", 36 | "total_send": "integer", 37 | "total_receive": "integer", 38 | "group_send": "integer", 39 | "group_receive": "integer", 40 | "calls_send": "integer", 41 | "calls_receive": "integer", 42 | "files_send": "integer", 43 | "files_receive": "integer", 44 | "images_send": "integer", 45 | "images_receive": "integer", 46 | "voice_send": "integer", 47 | "voice_receive": "integer", 48 | "videos_send": "integer", 49 | "videos_receive": "integer", 50 | "emoji_send": "integer", 51 | "emoji_receive": "integer" 52 | } 53 | ] 54 | } 55 | ``` 56 | 57 | Query Arguments |   58 | --- | --- 59 | from **required** | Start Date 60 | to **required** | End Date 61 | page_size *optional*
30
300
| The number of records returned within a single API call 62 | next_page_token *optional* | Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes. 63 | 64 | -------------------------------------------------------------------------------- /source/includes/dashboards/get_webinars.md.erb: -------------------------------------------------------------------------------- 1 | ## List webinars 2 | 3 | List live webinars or past webinars for a specified period 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/metrics/webinars 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/metrics/webinars?from=string&to=string 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "from": "string [date]", 26 | "to": "string [date]", 27 | "page_count": "integer", 28 | "page_size": "integer", 29 | "total_records": "integer", 30 | "next_page_token": "string", 31 | "webinars": [ 32 | { 33 | "uuid": "string [uuid]", 34 | "id": "integer", 35 | "topic": "string", 36 | "host": "string", 37 | "email": "string", 38 | "user_type": "string", 39 | "start_time": "string [date-time]", 40 | "end_time": "string [date-time]", 41 | "duration": "string", 42 | "participants": "integer", 43 | "has_pstn": "boolean", 44 | "has_voip": "boolean", 45 | "has_3rd_party_audio": "boolean", 46 | "has_video": "boolean", 47 | "has_screen_share": "boolean", 48 | "has_recording": "boolean", 49 | "has_sip": "boolean" 50 | } 51 | ] 52 | } 53 | ``` 54 | 55 | Query Arguments |   56 | --- | --- 57 | type *optional*
live
| The webinar type
`past` past webinars
`live` live webinars
58 | from **required** | Start Date 59 | to **required** | End Date 60 | page_size *optional*
30
300
| The number of records returned within a single API call 61 | next_page_token *optional* | Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes. 62 | 63 | -------------------------------------------------------------------------------- /source/includes/dashboards/get_meetings.md.erb: -------------------------------------------------------------------------------- 1 | ## List meetings 2 | 3 | List live meetings or past meetings for a specified period 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/metrics/meetings 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/metrics/meetings?from=string&to=string 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "from": "string [date]", 26 | "to": "string [date]", 27 | "page_count": "integer", 28 | "page_size": "integer", 29 | "total_records": "integer", 30 | "next_page_token": "string", 31 | "meetings": [ 32 | { 33 | "uuid": "string [uuid]", 34 | "id": "integer", 35 | "topic": "string", 36 | "host": "string", 37 | "email": "string", 38 | "user_type": "string", 39 | "start_time": "string [date-time]", 40 | "end_time": "string [date-time]", 41 | "duration": "string", 42 | "participants": "integer", 43 | "has_pstn": "boolean", 44 | "has_voip": "boolean", 45 | "has_3rd_party_audio": "boolean", 46 | "has_video": "boolean", 47 | "has_screen_share": "boolean", 48 | "has_recording": "boolean", 49 | "has_sip": "boolean" 50 | } 51 | ] 52 | } 53 | ``` 54 | 55 | Query Arguments |   56 | --- | --- 57 | type *optional*
live
| The meeting type
`past` past meetings
`pastOne` past one user meetings
`live` live meetings
58 | from **required** | Start Date 59 | to **required** | End Date 60 | page_size *optional*
30
300
| The number of records returned within a single API call 61 | next_page_token *optional* | Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes. 62 | 63 | -------------------------------------------------------------------------------- /source/javascripts/app/_search.js: -------------------------------------------------------------------------------- 1 | //= require ../lib/_lunr 2 | //= require ../lib/_jquery 3 | //= require ../lib/_jquery.highlight 4 | (function () { 5 | 'use strict'; 6 | 7 | var content, searchResults; 8 | var highlightOpts = { element: 'span', className: 'search-highlight' }; 9 | 10 | var index = new lunr.Index(); 11 | 12 | index.ref('id'); 13 | index.field('title', { boost: 10 }); 14 | index.field('body'); 15 | index.pipeline.add(lunr.trimmer, lunr.stopWordFilter); 16 | 17 | $(populate); 18 | $(bind); 19 | 20 | function populate() { 21 | $('h1, h2').each(function() { 22 | var title = $(this); 23 | var body = title.nextUntil('h1, h2'); 24 | index.add({ 25 | id: title.prop('id'), 26 | title: title.text(), 27 | body: body.text() 28 | }); 29 | }); 30 | } 31 | 32 | function bind() { 33 | content = $('.content'); 34 | searchResults = $('.search-results'); 35 | 36 | $('#input-search').on('keyup', search); 37 | } 38 | 39 | function search(event) { 40 | unhighlight(); 41 | searchResults.addClass('visible'); 42 | 43 | // ESC clears the field 44 | if (event.keyCode === 27) this.value = ''; 45 | 46 | if (this.value) { 47 | var results = index.search(this.value).filter(function(r) { 48 | return r.score > 0.0001; 49 | }); 50 | 51 | if (results.length) { 52 | searchResults.empty(); 53 | $.each(results, function (index, result) { 54 | var elem = document.getElementById(result.ref); 55 | searchResults.append("
  • " + $(elem).text() + "
    • "); 56 | }); 57 | highlight.call(this); 58 | } else { 59 | searchResults.html('
  • '); 60 | $('.search-results li').text('No Results Found for "' + this.value + '"'); 61 | } 62 | } else { 63 | unhighlight(); 64 | searchResults.removeClass('visible'); 65 | } 66 | } 67 | 68 | function highlight() { 69 | if (this.value) content.highlight(this.value, highlightOpts); 70 | } 71 | 72 | function unhighlight() { 73 | content.unhighlight(highlightOpts); 74 | } 75 | })(); 76 | -------------------------------------------------------------------------------- /config.rb: -------------------------------------------------------------------------------- 1 | # Globals 2 | config[:api_host] = 'https://api.zoom.us/v2/' 3 | config[:deveoper_portal] = 'https://zoom.us/developer' 4 | config[:ex_api_key] = 'your_api_key' 5 | config[:ex_api_secret] = 'your_api_secret' 6 | config[:ex_meeting_number] = '123456789' 7 | config[:ex_meeting_topic] = 'Meeting Topic' 8 | config[:ex_email] = 'user@company.com' 9 | config[:ex_password] = 'P@55w0rd' 10 | config[:ex_uuid] = 'unique_id' 11 | config[:ex_first_name] = 'Zoomie' 12 | config[:ex_last_name] = 'Userton' 13 | config[:ex_node_init] = 'var Zoom = require("zoomus")({ 14 | key : "your_api_key", 15 | secret : "your_api_secret" 16 | });' 17 | config[:ex_node_res] = 'function(res){ 18 | if(res.error){ 19 | //handle error 20 | } else { 21 | console.log(res); 22 | } 23 | }' 24 | 25 | # Markdown 26 | set :markdown_engine, :redcarpet 27 | set :markdown, 28 | fenced_code_blocks: true, 29 | smartypants: true, 30 | disable_indented_code_blocks: true, 31 | prettify: true, 32 | tables: true, 33 | with_toc_data: true, 34 | no_intra_emphasis: true 35 | 36 | # Assets 37 | set :css_dir, 'stylesheets' 38 | set :js_dir, 'javascripts' 39 | set :images_dir, 'images' 40 | set :fonts_dir, 'fonts' 41 | 42 | # Activate the syntax highlighter 43 | activate :syntax 44 | ready do 45 | require './lib/multilang.rb' 46 | end 47 | 48 | activate :sprockets 49 | 50 | activate :livereload 51 | 52 | activate :autoprefixer do |config| 53 | config.browsers = ['last 2 version', 'Firefox ESR'] 54 | config.cascade = false 55 | config.inline = true 56 | end 57 | 58 | # Github pages require relative links 59 | activate :relative_assets 60 | set :relative_links, true 61 | 62 | # Build Configuration 63 | configure :build do 64 | # If you're having trouble with Middleman hanging, commenting 65 | # out the following two lines has been known to help 66 | activate :minify_css 67 | activate :minify_javascript 68 | # activate :relative_assets 69 | # activate :asset_hash 70 | # activate :gzip 71 | end 72 | 73 | # Deploy Configuration 74 | # If you want Middleman to listen on a different port, you can set that below 75 | set :port, 4567 -------------------------------------------------------------------------------- /source/includes/meetings/get_meetingId_registrants.md.erb: -------------------------------------------------------------------------------- 1 | ## List a meeting's registrants 2 | 3 | List registrants of a meeting 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/meetings/{meetingId}/registrants 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/meetings/{meetingId}/registrants 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_size": "integer", 27 | "total_records": "integer", 28 | "next_page_token": "string", 29 | "registrants": [ 30 | { 31 | "id": "string", 32 | "email": "string", 33 | "first_name": "string", 34 | "last_name": "string", 35 | "address": "string", 36 | "city": "string", 37 | "country": "string", 38 | "zip": "string", 39 | "state": "string", 40 | "phone": "string", 41 | "industry": "string", 42 | "org": "string", 43 | "job_title": "string", 44 | "purchasing_time_frame": "string", 45 | "role_in_purchase_process": "string", 46 | "no_of_employees": "string", 47 | "comments": "string", 48 | "custom_questions": [ 49 | { 50 | "title": "string", 51 | "value": "string" 52 | } 53 | ], 54 | "status": "string", 55 | "create_time": "string [date-time]", 56 | "join_url": "string [string]" 57 | } 58 | ] 59 | } 60 | ``` 61 | 62 | Path Arguments |   63 | --- | --- 64 | meetingId **required** | The meeting ID 65 | 66 | Query Arguments |   67 | --- | --- 68 | occurrence_id *optional* | The meeting occurrence ID 69 | status *optional*
    approved
    | The registrant status
    `pending` registrants status is pending
    `approved` registrants status is approved
    `denied` registrants status is denied
    70 | page_size *optional*
    30
    300
    | The number of records returned within a single API call 71 | page_number *optional*
    1
    | Current page number of returned records 72 | 73 | -------------------------------------------------------------------------------- /source/includes/webinars/get_webinarId_registrants.md.erb: -------------------------------------------------------------------------------- 1 | ## List a webinar's registrants 2 | 3 | List registrants for a webinar 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/webinars/{webinarId}/registrants 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/webinars/{webinarId}/registrants 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_size": "integer", 27 | "total_records": "integer", 28 | "next_page_token": "string", 29 | "registrants": [ 30 | { 31 | "id": "string", 32 | "email": "string", 33 | "first_name": "string", 34 | "last_name": "string", 35 | "address": "string", 36 | "city": "string", 37 | "country": "string", 38 | "zip": "string", 39 | "state": "string", 40 | "phone": "string", 41 | "industry": "string", 42 | "org": "string", 43 | "job_title": "string", 44 | "purchasing_time_frame": "string", 45 | "role_in_purchase_process": "string", 46 | "no_of_employees": "string", 47 | "comments": "string", 48 | "custom_questions": [ 49 | { 50 | "title": "string", 51 | "value": "string" 52 | } 53 | ], 54 | "status": "string", 55 | "create_time": "string [date-time]", 56 | "join_url": "string [string]" 57 | } 58 | ] 59 | } 60 | ``` 61 | 62 | Path Arguments |   63 | --- | --- 64 | webinarId **required** | The webinar ID 65 | 66 | Query Arguments |   67 | --- | --- 68 | occurrence_id *optional* | The meeting occurrence ID 69 | status *optional*
    approved
    | The registrant status
    `pending` registrants status is pending
    `approved` registrants status is approved
    `denied` registrants status is denied
    70 | page_size *optional*
    30
    300
    | The number of records returned within a single API call 71 | page_number *optional*
    1
    | Current page number of returned records 72 | 73 | -------------------------------------------------------------------------------- /source/includes/dashboards/get_webinars_webinarId_participants.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve webinar participants 2 | 3 | Retrieve live or past webinar participants 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/metrics/webinars/{webinarId}/participants 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/metrics/webinars/{webinarId}/participants 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_size": "integer", 27 | "total_records": "integer", 28 | "next_page_token": "string", 29 | "participants": [ 30 | { 31 | "id": "string [uuid]", 32 | "user_id": "string", 33 | "user_name": "string", 34 | "device": "string", 35 | "ip_address": "string", 36 | "location": "string", 37 | "network_type": "string", 38 | "microphone": "string", 39 | "speaker": "string", 40 | "data_center": "string", 41 | "connection_type": "string", 42 | "join_time": "string [date-time]", 43 | "leave_time": "string [date-time]", 44 | "share_application": "boolean", 45 | "share_desktop": "boolean", 46 | "share_whiteboard": "boolean", 47 | "recording": "boolean", 48 | "pc_name": "string", 49 | "domain": "string", 50 | "mac_addr": "string", 51 | "harddisk_id": "string", 52 | "version": "string" 53 | } 54 | ] 55 | } 56 | ``` 57 | 58 | Path Arguments |   59 | --- | --- 60 | webinarId **required** | The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance. 61 | 62 | Query Arguments |   63 | --- | --- 64 | type *optional*
    live
    | The webinar type
    `past` past webinar
    `live` live webinar
    65 | page_size *optional*
    30
    300
    | The number of records returned within a single API call 66 | next_page_token *optional* | Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes. 67 | 68 | -------------------------------------------------------------------------------- /source/includes/dashboards/get_meetings_meetingId_participants.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve meeting participants 2 | 3 | Retrieve live or past meetings participants 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/metrics/meetings/{meetingId}/participants 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/metrics/meetings/{meetingId}/participants 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "page_count": "integer", 26 | "page_size": "integer", 27 | "total_records": "integer", 28 | "next_page_token": "string", 29 | "participants": [ 30 | { 31 | "id": "string [uuid]", 32 | "user_id": "string", 33 | "user_name": "string", 34 | "device": "string", 35 | "ip_address": "string", 36 | "location": "string", 37 | "network_type": "string", 38 | "microphone": "string", 39 | "speaker": "string", 40 | "data_center": "string", 41 | "connection_type": "string", 42 | "join_time": "string [date-time]", 43 | "leave_time": "string [date-time]", 44 | "share_application": "boolean", 45 | "share_desktop": "boolean", 46 | "share_whiteboard": "boolean", 47 | "recording": "boolean", 48 | "pc_name": "string", 49 | "domain": "string", 50 | "mac_addr": "string", 51 | "harddisk_id": "string", 52 | "version": "string" 53 | } 54 | ] 55 | } 56 | ``` 57 | 58 | Path Arguments |   59 | --- | --- 60 | meetingId **required** | The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. 61 | 62 | Query Arguments |   63 | --- | --- 64 | type *optional*
    live
    | The meeting type
    `past` past meeting
    `pastOne` past one user meeting
    `live` live meeting
    65 | page_size *optional*
    30
    300
    | The number of records returned within a single API call 66 | next_page_token *optional* | Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes. 67 | 68 | -------------------------------------------------------------------------------- /source/includes/users/post_.md.erb: -------------------------------------------------------------------------------- 1 | ## Create a user 2 | 3 | Create a user on your account 4 | 5 | > Definition 6 | 7 | ```shell 8 | POST https://api.zoom.us/v2/users 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users \ 15 | -d '{ 16 | "action": "string", 17 | "user_info": { 18 | "email": "string", 19 | "type": "integer", 20 | "first_name": "string", 21 | "last_name": "string", 22 | "password": "string" 23 | } 24 | }' 25 | ``` 26 | 27 | > Example Response 28 | 29 | ```text 30 | 201 Created 31 | ``` 32 | 33 | ```json 34 | { 35 | "id": "string", 36 | "first_name": "string", 37 | "last_name": "string", 38 | "email": "string", 39 | "type": "integer" 40 | } 41 | ``` 42 | 43 | Body Arguments |   44 | --- | --- 45 | action **required** | Specify how to create the new user
    `create` User will get an email sent from Zoom. There is a confirmation link in this email. User will then need to click this link to activate their account to the Zoom service. The user can set or change their password in Zoom.
    .
    `autoCreate` This action is provided for enterprise customer who has a managed domain. This feature is disabled by default because of the security risk involved in creating a user who does not belong to your domain without notifying the user.

    `custCreate` This action is provided for API partner only. User created in this way has no password and is not able to log into the Zoom web site or client.

    `ssoCreate` This action is provided for enabled "Pre-provisioning SSO User" option. User created in this way has no password. If it is not a basic user, will generate a Personal Vanity URL using user name (no domain) of the provisioning email. If user name or pmi is invalid or occupied, will use random number/random personal vanity URL.

    46 | user_info.email **required**
    128
    | User's email address 47 | user_info.type **required** | User's type
    `1` basic
    `2` pro
    `3` corp
    48 | user_info.first_name *optional*
    64
    | User's first name. Cannot contain more than 5 Chinese words. 49 | user_info.last_name *optional*
    64
    | User's last name. Cannot contain more than 5 Chinese words. 50 | user_info.password *optional* | User’s password. Only for "autoCreate" action. 51 | 52 | -------------------------------------------------------------------------------- /source/includes/cloud_recording/get_userId_recordings.md.erb: -------------------------------------------------------------------------------- 1 | ## List all the recordings 2 | 3 | List all the recordings 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/users/{userId}/recordings 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/recordings?from=string&to=string 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "from": "string [date]", 26 | "to": "string [date]", 27 | "page_count": "integer", 28 | "page_size": "integer", 29 | "total_records": "integer", 30 | "next_page_token": "string", 31 | "meetings": [ 32 | { 33 | "uuid": "string", 34 | "id": "string", 35 | "account_id": "string", 36 | "host_id": "string", 37 | "topic": "string", 38 | "start_time": "string [date-time]", 39 | "duration": "integer", 40 | "total_size": "string", 41 | "recording_count": "string", 42 | "recording_files": [ 43 | { 44 | "id": "string", 45 | "meeting_id": "string", 46 | "recording_start": "string", 47 | "recording_end": "string", 48 | "file_type": "string", 49 | "file_size": "number", 50 | "play_url": "string", 51 | "download_url": "string", 52 | "status": "string", 53 | "deleted_time": "string", 54 | "recording_type": "string" 55 | } 56 | ] 57 | } 58 | ] 59 | } 60 | ``` 61 | 62 | Path Arguments |   63 | --- | --- 64 | userId **required** | The user ID or email address 65 | 66 | Query Arguments |   67 | --- | --- 68 | from **required** | Start Date 69 | to **required** | End Date 70 | page_size *optional*
    30
    300
    | The number of records returned within a single API call 71 | next_page_token *optional* | Next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceed the current page size. The expiration period for this token is 15 minutes. 72 | mc *optional*
    false
    | Query mc 73 | trash *optional*
    false
    | Query trash 74 | 75 | -------------------------------------------------------------------------------- /source/includes/webinars/post_webinarId_registrants.md.erb: -------------------------------------------------------------------------------- 1 | ## Add a webinar registrant 2 | 3 | Add a registrant for a webinar 4 | 5 | > Definition 6 | 7 | ```shell 8 | POST https://api.zoom.us/v2/webinars/{webinarId}/registrants 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/webinars/{webinarId}/registrants \ 15 | -d '{ 16 | "email": "string", 17 | "first_name": "string", 18 | "last_name": "string", 19 | "address": "string", 20 | "city": "string", 21 | "country": "string", 22 | "zip": "string", 23 | "state": "string", 24 | "phone": "string", 25 | "industry": "string", 26 | "org": "string", 27 | "job_title": "string", 28 | "purchasing_time_frame": "string", 29 | "role_in_purchase_process": "string", 30 | "no_of_employees": "string", 31 | "comments": "string", 32 | "custom_questions": [ 33 | { 34 | "title": "string", 35 | "value": "string" 36 | } 37 | ] 38 | }' 39 | ``` 40 | 41 | > Example Response 42 | 43 | ```text 44 | 201 Created 45 | ``` 46 | 47 | ```json 48 | { 49 | "registrant_id": "string", 50 | "id": "string", 51 | "topic": "string", 52 | "start_time": "string [date-time]", 53 | "join_url": "string" 54 | } 55 | ``` 56 | 57 | Path Arguments |   58 | --- | --- 59 | webinarId **required** | The webinar ID 60 | 61 | Query Arguments |   62 | --- | --- 63 | occurrence_ids *optional* | Occurrence IDs, could get this value from Webinar Get API. Multiple value separated by comma. 64 | 65 | Body Arguments |   66 | --- | --- 67 | email **required** | A valid email address 68 | first_name **required** | User’s first name 69 | last_name **required** | User’s last name 70 | address *optional* | Address 71 | city *optional* | City 72 | country *optional* | Country 73 | zip *optional* | Zip/Postal Code 74 | state *optional* | State/Province 75 | phone *optional* | Phone 76 | industry *optional* | Industry 77 | org *optional* | Organization 78 | job_title *optional* | Job Title 79 | purchasing_time_frame *optional* | Purchasing Time Frame
    `Within a month`
    `1-3 months`
    `4-6 months`
    `More than 6 months`
    `No timeframe`
    80 | role_in_purchase_process *optional* | Role in Purchase Process
    `Decision Maker`
    `Evaluator/Recommender`
    `Influencer`
    `Not involved`
    81 | no_of_employees *optional* | Number of Employees
    `1-20`
    `21-50`
    `51-100`
    `101-500`
    `500-1,000`
    `1,001-5,000`
    `5,001-10,000`
    `More than 10,000`
    82 | comments *optional* | Questions & Comments 83 | custom_questions *optional* | Custom Questions 84 | 85 | -------------------------------------------------------------------------------- /source/includes/meetings/post_meetingId_registrants.md.erb: -------------------------------------------------------------------------------- 1 | ## Add a meeting registrant 2 | 3 | Register a participant for a meeting 4 | 5 | > Definition 6 | 7 | ```shell 8 | POST https://api.zoom.us/v2/meetings/{meetingId}/registrants 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/meetings/{meetingId}/registrants \ 15 | -d '{ 16 | "email": "string", 17 | "first_name": "string", 18 | "last_name": "string", 19 | "address": "string", 20 | "city": "string", 21 | "country": "string", 22 | "zip": "string", 23 | "state": "string", 24 | "phone": "string", 25 | "industry": "string", 26 | "org": "string", 27 | "job_title": "string", 28 | "purchasing_time_frame": "string", 29 | "role_in_purchase_process": "string", 30 | "no_of_employees": "string", 31 | "comments": "string", 32 | "custom_questions": [ 33 | { 34 | "title": "string", 35 | "value": "string" 36 | } 37 | ] 38 | }' 39 | ``` 40 | 41 | > Example Response 42 | 43 | ```text 44 | 201 Created 45 | ``` 46 | 47 | ```json 48 | { 49 | "registrant_id": "string", 50 | "id": "string", 51 | "topic": "string", 52 | "start_time": "string [date-time]", 53 | "join_url": "string" 54 | } 55 | ``` 56 | 57 | Path Arguments |   58 | --- | --- 59 | meetingId **required** | The meeting ID 60 | 61 | Query Arguments |   62 | --- | --- 63 | occurrence_ids *optional* | Occurrence IDs. You can find these with the meeting get API. Multiple values separated by comma. 64 | 65 | Body Arguments |   66 | --- | --- 67 | email **required** | A valid email address 68 | first_name **required** | User’s first name 69 | last_name **required** | User’s last name 70 | address *optional* | Address 71 | city *optional* | City 72 | country *optional* | Country 73 | zip *optional* | Zip/Postal Code 74 | state *optional* | State/Province 75 | phone *optional* | Phone 76 | industry *optional* | Industry 77 | org *optional* | Organization 78 | job_title *optional* | Job Title 79 | purchasing_time_frame *optional* | Purchasing Time Frame
    `Within a month`
    `1-3 months`
    `4-6 months`
    `More than 6 months`
    `No timeframe`
    80 | role_in_purchase_process *optional* | Role in Purchase Process
    `Decision Maker`
    `Evaluator/Recommender`
    `Influencer`
    `Not involved`
    81 | no_of_employees *optional* | Number of Employees
    `1-20`
    `21-50`
    `51-100`
    `101-500`
    `500-1,000`
    `1,001-5,000`
    `5,001-10,000`
    `More than 10,000`
    82 | comments *optional* | Questions & Comments 83 | custom_questions *optional* | Custom Questions 84 | 85 | -------------------------------------------------------------------------------- /source/includes/reference/_authentication.md.erb: -------------------------------------------------------------------------------- 1 | # Authentication 2 | 3 | Zoom API version 2 implements [JSON Web Tokens](https://jwt.io) (JWT) for authentication. It is recommended you use one of the existing JWT [libraries](https://jwt.io/#libraries) to generate the token. 4 | 5 | You can pass the token to the API either in the HTTP Authorization Header using 'Bearer' or via Query Parameter in your API call as 'access_token'. 6 | 7 | Header 8 | 9 | `Authorization: Bearer ` 10 | 11 | Query Parameter 12 | 13 | `?access_token=` 14 | 15 | ## Generating Token 16 | 17 | You can find more details and specifics about JWT at [jwt.io](https://jwt.io), below is and example of the minimum properties needed for the Zoom API. 18 | 19 | ### Header 20 | ```json 21 | { 22 | "alg": "HS256", 23 | "typ": "JWT" 24 | } 25 | ``` 26 | 27 | `alg` refers to the algorithm being used, Zoom API uses HMAC SHA256 (HS256 for short) 28 | 29 | `typ` refers to the type of token, always JWT 30 | 31 | ### Payload 32 | ```json 33 | { 34 | "iss": "API_KEY", 35 | "exp": 1496091964000 36 | } 37 | ``` 38 | 39 | `iss` is the issuer of the token, this is your Zoom API Key 40 | 41 | `exp` is the expiration timestamp of the token. It is recommended to use one of the JWT libraries to generate your tokens and to set this timestamp for a short period (like seconds), that way if someone intercepts your token it won't be valid for very long. 42 | 43 | ### Signature 44 | 45 | > Algorithm 46 | 47 | ```java 48 | HMACSHA256( 49 | base64UrlEncode(header) + "." + 50 | base64UrlEncode(payload), 51 | api_secret) 52 | ``` 53 | 54 | > Node.js Library example 55 | 56 | ```javascript 57 | var jwt = require('jsonwebtoken'); 58 | 59 | var payload = { 60 | iss: api_key, 61 | exp: ((new Date()).getTime() + 5000) 62 | }; 63 | 64 | //Automatically creates header, and returns JWT 65 | var token = jwt.sign(payload, api_secret); 66 | ``` 67 | 68 | To the right you'll find an example algorithm for generating a signature, again highly recommend using a library to do this for you 69 | 70 | 71 | ## Example 72 | 73 | The example below is written in PHP and utilizes the [Firebase JWT Library](https://github.com/firebase/php-jwt) installed via [Composer](https://getcomposer.org/). However the concept and idea can be ported to any language and workflow and you can find libraries for your specific language on [jwt.io](https://jwt.io/#libraries) 74 | 75 | The key thing to understand is that the JWT token isn't static, and that it is generated each time you make a request. This makes it unique and more secure; if somehow your token is intercepted it won't be good for long (as in this example 60 seconds) 76 | 77 |
    78 | 79 |
    -------------------------------------------------------------------------------- /source/fonts/slate.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Generated by IcoMoon 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /source/includes/dashboards/get_zoomrooms_zoomroomId.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve Zoom Room 2 | 3 | Retrieve zoom room on account 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/metrics/zoomrooms/{zoomroomId} 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/metrics/zoomrooms/{zoomroomId}?from=string&to=string 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "id": "string", 26 | "room_name": "string", 27 | "calender_name": "string", 28 | "email": "string", 29 | "account_type": "string", 30 | "status": "string", 31 | "device_ip": "string", 32 | "camera": "string", 33 | "microphone": "string", 34 | "speaker": "string", 35 | "last_start_time": "string", 36 | "live_meeting": { 37 | "uuid": "string [uuid]", 38 | "id": "integer", 39 | "topic": "string", 40 | "host": "string", 41 | "email": "string", 42 | "user_type": "string", 43 | "start_time": "string [date-time]", 44 | "end_time": "string [date-time]", 45 | "duration": "string", 46 | "participants": "integer", 47 | "has_pstn": "boolean", 48 | "has_voip": "boolean", 49 | "has_3rd_party_audio": "boolean", 50 | "has_video": "boolean", 51 | "has_screen_share": "boolean", 52 | "has_recording": "boolean", 53 | "has_sip": "boolean" 54 | }, 55 | "past_meetings": { 56 | "from": "string [date]", 57 | "to": "string [date]", 58 | "page_count": "integer", 59 | "page_size": "integer", 60 | "total_records": "integer", 61 | "next_page_token": "string", 62 | "meetings": [ 63 | { 64 | "uuid": "string [uuid]", 65 | "id": "integer", 66 | "topic": "string", 67 | "host": "string", 68 | "email": "string", 69 | "user_type": "string", 70 | "start_time": "string [date-time]", 71 | "end_time": "string [date-time]", 72 | "duration": "string", 73 | "participants": "integer", 74 | "has_pstn": "boolean", 75 | "has_voip": "boolean", 76 | "has_3rd_party_audio": "boolean", 77 | "has_video": "boolean", 78 | "has_screen_share": "boolean", 79 | "has_recording": "boolean", 80 | "has_sip": "boolean" 81 | } 82 | ] 83 | } 84 | } 85 | ``` 86 | 87 | Path Arguments |   88 | --- | --- 89 | zoomroomId **required** | The Zoom Room ID 90 | 91 | Query Arguments |   92 | --- | --- 93 | from **required** | Start Date 94 | to **required** | End Date 95 | page_size *optional*
    30
    300
    | The number of records returned within a single API call 96 | page_number *optional*
    1
    | Current page number of returned records 97 | 98 | -------------------------------------------------------------------------------- /source/includes/users/get_userId_settings.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve a user's settings 2 | 3 | Retrieve a user's settings 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/users/{userId}/settings 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/users/{userId}/settings 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "scheduled_meeting": { 26 | "host_video": "boolean", 27 | "participants_video": "boolean", 28 | "audio_type": "string", 29 | "join_before_host": "boolean", 30 | "force_pmi_jbh_password": "boolean", 31 | "pstn_password_protected": "boolean" 32 | }, 33 | "in_meeting": { 34 | "e2e_encryption": "boolean", 35 | "chat": "boolean", 36 | "private_chat": "boolean", 37 | "auto_saving_chat": "boolean", 38 | "entry_exit_chime": "string", 39 | "record_play_voice": "boolean", 40 | "file_transfer": "boolean", 41 | "feedback": "boolean", 42 | "co_host": "boolean", 43 | "polling": "boolean", 44 | "attendee_on_hold": "boolean", 45 | "annotation": "boolean", 46 | "remote_control": "boolean", 47 | "non_verbal_feedback": "boolean", 48 | "breakout_room": "boolean", 49 | "remote_support": "boolean", 50 | "closed_caption": "boolean", 51 | "group_hd": "boolean", 52 | "virtual_background": "boolean", 53 | "far_end_camera_control": "boolean", 54 | "share_dual_camera": "boolean", 55 | "attention_tracking": "boolean", 56 | "waiting_room": "boolean" 57 | }, 58 | "email_notification": { 59 | "jbh_reminder": "boolean", 60 | "cancel_meeting_reminder": "boolean", 61 | "alternative_host_reminder": "boolean" 62 | }, 63 | "recording": { 64 | "local_recording": "boolean", 65 | "cloud_recording": "boolean", 66 | "record_speaker_view": "boolean", 67 | "record_gallery_view": "boolean", 68 | "record_audio_file": "boolean", 69 | "save_chat_text": "boolean", 70 | "show_timestamp": "boolean", 71 | "recording_audio_transcript": "boolean", 72 | "auto_recording": "string", 73 | "auto_delete_cmr": "boolean", 74 | "auto_delete_cmr_days": "integer" 75 | }, 76 | "telephony": { 77 | "third_party_audio": "boolean", 78 | "audio_conference_info": "string", 79 | "show_international_numbers_link": "boolean" 80 | }, 81 | "feature": { 82 | "meeting_capacity": "integer", 83 | "large_meeting": "boolean", 84 | "large_meeting_capacity": "integer", 85 | "webinar": "boolean", 86 | "webinar_capacity": "integer", 87 | "cn_meeting": "boolean", 88 | "in_meeting": "boolean" 89 | } 90 | } 91 | ``` 92 | 93 | Path Arguments |   94 | --- | --- 95 | userId **required** | The user ID or email address 96 | 97 | Query Arguments |   98 | --- | --- 99 | login_type *optional* |
    `0` Facebook
    `1` Google
    `99` API
    `100` Zoom
    `101` SSO
    100 | 101 | -------------------------------------------------------------------------------- /source/stylesheets/print.css.scss: -------------------------------------------------------------------------------- 1 | @charset "utf-8"; 2 | @import 'normalize'; 3 | @import 'variables'; 4 | @import 'icon-font'; 5 | 6 | /* 7 | Copyright 2008-2013 Concur Technologies, Inc. 8 | 9 | Licensed under the Apache License, Version 2.0 (the "License"); you may 10 | not use this file except in compliance with the License. You may obtain 11 | a copy of the License at 12 | 13 | http://www.apache.org/licenses/LICENSE-2.0 14 | 15 | Unless required by applicable law or agreed to in writing, software 16 | distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 17 | WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 18 | License for the specific language governing permissions and limitations 19 | under the License. 20 | */ 21 | 22 | $print-color: #999; 23 | $print-color-light: #ccc; 24 | $print-font-size: 12px; 25 | 26 | body { 27 | @extend %default-font; 28 | } 29 | 30 | .tocify, .toc-footer, .lang-selector, .search, #nav-button { 31 | display: none; 32 | } 33 | 34 | .tocify-wrapper>img { 35 | margin: 0 auto; 36 | display: block; 37 | } 38 | 39 | .content { 40 | font-size: 12px; 41 | 42 | pre, code { 43 | @extend %code-font; 44 | @extend %break-words; 45 | border: 1px solid $print-color; 46 | border-radius: 5px; 47 | font-size: 0.8em; 48 | } 49 | 50 | pre { 51 | code { 52 | border: 0; 53 | } 54 | } 55 | 56 | pre { 57 | padding: 1.3em; 58 | } 59 | 60 | code { 61 | padding: 0.2em; 62 | } 63 | 64 | table { 65 | border: 1px solid $print-color; 66 | tr { 67 | border-bottom: 1px solid $print-color; 68 | } 69 | td,th { 70 | padding: 0.7em; 71 | } 72 | } 73 | 74 | p { 75 | line-height: 1.5; 76 | } 77 | 78 | a { 79 | text-decoration: none; 80 | color: #000; 81 | } 82 | 83 | h1 { 84 | @extend %header-font; 85 | font-size: 2.5em; 86 | padding-top: 0.5em; 87 | padding-bottom: 0.5em; 88 | margin-top: 1em; 89 | margin-bottom: $h1-margin-bottom; 90 | border: 2px solid $print-color-light; 91 | border-width: 2px 0; 92 | text-align: center; 93 | } 94 | 95 | h2 { 96 | @extend %header-font; 97 | font-size: 1.8em; 98 | margin-top: 2em; 99 | border-top: 2px solid $print-color-light; 100 | padding-top: 0.8em; 101 | } 102 | 103 | h1+h2, h1+div+h2 { 104 | border-top: none; 105 | padding-top: 0; 106 | margin-top: 0; 107 | } 108 | 109 | h3, h4 { 110 | @extend %header-font; 111 | font-size: 0.8em; 112 | margin-top: 1.5em; 113 | margin-bottom: 0.8em; 114 | text-transform: uppercase; 115 | } 116 | 117 | h5, h6 { 118 | text-transform: uppercase; 119 | } 120 | 121 | aside { 122 | padding: 1em; 123 | border: 1px solid $print-color-light; 124 | border-radius: 5px; 125 | margin-top: 1.5em; 126 | margin-bottom: 1.5em; 127 | line-height: 1.6; 128 | } 129 | 130 | aside:before { 131 | vertical-align: middle; 132 | padding-right: 0.5em; 133 | font-size: 14px; 134 | } 135 | 136 | aside.notice:before { 137 | @extend %icon-info-sign; 138 | } 139 | 140 | aside.warning:before { 141 | @extend %icon-exclamation-sign; 142 | } 143 | 144 | aside.success:before { 145 | @extend %icon-ok-sign; 146 | } 147 | } -------------------------------------------------------------------------------- /source/includes/dashboards/get_meetings_meetingId_participants_participantId_qos.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve meeting participant QOS 2 | 3 | Retrieve live or past meetings participant quality of service 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/metrics/meetings/{meetingId}/participants/{participantId}/qos 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/metrics/meetings/{meetingId}/participants/{participantId}/qos 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "user_id": "string [uuid]", 26 | "user_name": "string", 27 | "device": "string", 28 | "ip_address": "string", 29 | "location": "string", 30 | "join_time": "string [date-time]", 31 | "leave_time": "string [date-time]", 32 | "pc_name": "string", 33 | "domain": "string", 34 | "mac_addr": "string", 35 | "harddisk_id": "string", 36 | "version": "string", 37 | "user_qos": { 38 | "date_time": "string [date-time]", 39 | "audio_input": { 40 | "bitrate": "string", 41 | "latency": "string", 42 | "jitter": "string", 43 | "avg_loss": "string", 44 | "max_loss": "string" 45 | }, 46 | "audio_output": { 47 | "bitrate": "string", 48 | "latency": "string", 49 | "jitter": "string", 50 | "avg_loss": "string", 51 | "max_loss": "string" 52 | }, 53 | "video_input": { 54 | "bitrate": "string", 55 | "latency": "string", 56 | "jitter": "string", 57 | "avg_loss": "string", 58 | "max_loss": "string", 59 | "resolution": "string", 60 | "frame_rate": "string" 61 | }, 62 | "video_output": { 63 | "bitrate": "string", 64 | "latency": "string", 65 | "jitter": "string", 66 | "avg_loss": "string", 67 | "max_loss": "string", 68 | "resolution": "string", 69 | "frame_rate": "string" 70 | }, 71 | "as_input": { 72 | "bitrate": "string", 73 | "latency": "string", 74 | "jitter": "string", 75 | "avg_loss": "string", 76 | "max_loss": "string", 77 | "resolution": "string", 78 | "frame_rate": "string" 79 | }, 80 | "as_output": { 81 | "bitrate": "string", 82 | "latency": "string", 83 | "jitter": "string", 84 | "avg_loss": "string", 85 | "max_loss": "string", 86 | "resolution": "string", 87 | "frame_rate": "string" 88 | }, 89 | "cpu_usage": { 90 | "zoom_min_cpu_usage": "string", 91 | "zoom_avg_cpu_usage": "string", 92 | "zoom_max_cpu_usage": "string", 93 | "system_max_cpu_usage": "string" 94 | } 95 | } 96 | } 97 | ``` 98 | 99 | Path Arguments |   100 | --- | --- 101 | meetingId **required** | The meeting ID or meeting UUID. If given meeting ID, will take the last meeting instance. 102 | participantId **required** | Participant ID 103 | 104 | Query Arguments |   105 | --- | --- 106 | type *optional*
    live
    | The meeting type
    `past` past meeting
    `live` live meeting
    107 | 108 | -------------------------------------------------------------------------------- /source/includes/dashboards/get_webinars_webinarId_participants_participantId_qos.md.erb: -------------------------------------------------------------------------------- 1 | ## Retrieve webinar participant QOS 2 | 3 | Retrieve live or past webinar participant quality of service 4 | 5 | > Definition 6 | 7 | ```shell 8 | GET https://api.zoom.us/v2/metrics/webinars/{webinarId}/participants/{participantId}/qos 9 | ``` 10 | 11 | > Example Request 12 | 13 | ```shell 14 | $ curl https://api.zoom.us/v2/metrics/webinars/{webinarId}/participants/{participantId}/qos 15 | ``` 16 | 17 | > Example Response 18 | 19 | ```text 20 | 200 OK 21 | ``` 22 | 23 | ```json 24 | { 25 | "user_id": "string [uuid]", 26 | "user_name": "string", 27 | "device": "string", 28 | "ip_address": "string", 29 | "location": "string", 30 | "join_time": "string [date-time]", 31 | "leave_time": "string [date-time]", 32 | "pc_name": "string", 33 | "domain": "string", 34 | "mac_addr": "string", 35 | "harddisk_id": "string", 36 | "version": "string", 37 | "user_qos": { 38 | "date_time": "string [date-time]", 39 | "audio_input": { 40 | "bitrate": "string", 41 | "latency": "string", 42 | "jitter": "string", 43 | "avg_loss": "string", 44 | "max_loss": "string" 45 | }, 46 | "audio_output": { 47 | "bitrate": "string", 48 | "latency": "string", 49 | "jitter": "string", 50 | "avg_loss": "string", 51 | "max_loss": "string" 52 | }, 53 | "video_input": { 54 | "bitrate": "string", 55 | "latency": "string", 56 | "jitter": "string", 57 | "avg_loss": "string", 58 | "max_loss": "string", 59 | "resolution": "string", 60 | "frame_rate": "string" 61 | }, 62 | "video_output": { 63 | "bitrate": "string", 64 | "latency": "string", 65 | "jitter": "string", 66 | "avg_loss": "string", 67 | "max_loss": "string", 68 | "resolution": "string", 69 | "frame_rate": "string" 70 | }, 71 | "as_input": { 72 | "bitrate": "string", 73 | "latency": "string", 74 | "jitter": "string", 75 | "avg_loss": "string", 76 | "max_loss": "string", 77 | "resolution": "string", 78 | "frame_rate": "string" 79 | }, 80 | "as_output": { 81 | "bitrate": "string", 82 | "latency": "string", 83 | "jitter": "string", 84 | "avg_loss": "string", 85 | "max_loss": "string", 86 | "resolution": "string", 87 | "frame_rate": "string" 88 | }, 89 | "cpu_usage": { 90 | "zoom_min_cpu_usage": "string", 91 | "zoom_avg_cpu_usage": "string", 92 | "zoom_max_cpu_usage": "string", 93 | "system_max_cpu_usage": "string" 94 | } 95 | } 96 | } 97 | ``` 98 | 99 | Path Arguments |   100 | --- | --- 101 | webinarId **required** | The webinar ID or webinar UUID. If given webinar ID, will take the last webinar instance. 102 | participantId **required** | Participant ID 103 | 104 | Query Arguments |   105 | --- | --- 106 | type *optional*
    live
    | The webinar type
    `past` past webinar
    `live` live webinar
    107 | 108 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # CHANGELOG 2 | 3 | ## For the latest Changelog in our APIs please see our developer site 4 | - https://devdocs.zoom.us/guides/welcome/recent-updates 5 | 6 | ## 2017-05-20 7 | 8 | ### Added 9 | 10 | - Meeting: "option_auto_record_type" parameter to create/update API. 11 | - Meeting: "share_application" added to the response of the get API 12 | - Meeting: "share_desktop" added to the response of the get API 13 | - Meeting: "share_whiteboard" added to the response of the get API 14 | - Meeting: "recording" added to the response of the get API 15 | - Webinar: "option_auto_record_type" parameter to create/update API. 16 | - Webinar: "registrant_id" to registration API. 17 | - User: "status" parameter to list/get/getbyemail API. 18 | 19 | ### Notes 20 | 21 | The following attributes would inherit Webinar Account level Settings when create Webinar via API: 22 | - Close registration after event date 23 | - Allow attendees to join from multiple devices 24 | - Show social share buttons on registration page 25 | - Add call log for telehealth API. 26 | 27 | ## 2017-04-08 28 | 29 | ### Added 30 | 31 | - "v1/user/deactivate" API. 32 | - "v1/h323/device/add" API. 33 | - "v1/h323/device/update" API. 34 | - "v1/h323/device/delete" API. 35 | - "v1/h323/device/list" API. 36 | - "enable_attention_tracking" and "enable_waiting_room" parameters to User Create/AutoCreate/CustCreate/Update API. 37 | - "enable_use_pmi" parameter to User AutoCreate/CustCreate/Update API. 38 | - access control to "v1/report/getaudioreport" API. 39 | 40 | ## 2017-02-25 41 | 42 | ### Added 43 | 44 | - "v1/webinar/polls" API. 45 | - "v1/webinar/questions" API. 46 | - "password" and "option_practice_session" parameters to Webinar Create/Update API. 47 | - "enable_phone_participants_password", "enable_auto_delete_cmr" and "auto_delete_cmr_days" parameters to User Create/AutoCreate/CustCreate/Update API 48 | - "enable_only_host_download_cmr" and "enable_same_account_access_cmr" parameters to Account Create/Update API. 49 | 50 | ### Notes 51 | 52 | - Support recurring Webinar feature in Webinar Create/Update/Get/List/Registration List/Delete/Registration API. 53 | 54 | ## 2017-01-15 55 | 56 | ### Added 57 | 58 | - "v1/meeting/register" API. 59 | - "v1/ma/account/plan/subscribe" API. 60 | - "v1/ma/account/plan/add" API. 61 | - "v1/ma/account/plan/update" API. 62 | - "v1/ma/account/plan/get" API. 63 | - "v1/ma/account/billing/update" API. 64 | 65 | Add the following parameters to Account Create/Update API 66 | - enable_share_rc 67 | - share_rc 68 | - enable_share_mc 69 | - share_mc 70 | - pay_mode 71 | - collection_method 72 | 73 | ### Notes 74 | 75 | - Support recurring meeting feature in Meeting Create/Update/Get/List/Delete API. 76 | - Support CPU usage metrics in Qos API. 77 | 78 | ## 2016-12-03 79 | 80 | ## Added 81 | 82 | - "option_host_video" and "option_panelist_video" to Webinar create/update API. 83 | - "network_type" parameter to "v1/metrics/meetings" API. 84 | - "meeting_capacity" parameter to Account create/update API. 85 | - "option_use_pmi" parameter to Meeting create/update API. 86 | - "v1/webinar/rgistrants/list" API. 87 | - "v1/webinar/registrants/approve" API. 88 | - "v1/webinar/panelists" API. 89 | - "v1/webinar/registration/cancel" API. 90 | 91 | Add the following parameters to user API - create/autocreate/autocreate2/custcreate 92 | - disable_private_chat 93 | - disable_group_hd 94 | - enable_e2e_encryption 95 | - enable_silent_mode 96 | - disable_feedback 97 | - disable_cancel_meeting_notification 98 | - enable_breakout_room 99 | - enable_polling 100 | - enable_annotation 101 | - enable_auto_saving_chats 102 | - enable_co_host 103 | - enable_enter_exit_chime 104 | - option_enter_exit_chime_type 105 | - enable_remote_support 106 | - enable_file_transfer 107 | - enable_virtual_background 108 | - enable_closed_caption 109 | - enable_far_end_camera_control 110 | - enable_share_dual_camera 111 | 112 | ### Notes 113 | 114 | - Support to update pending users in API 115 | - Support to delete invite user in API 116 | - Support to get pending user in API 117 | -------------------------------------------------------------------------------- /source/stylesheets/_variables.scss: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright 2008-2013 Concur Technologies, Inc. 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); you may 5 | not use this file except in compliance with the License. You may obtain 6 | a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 12 | WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 13 | License for the specific language governing permissions and limitations 14 | under the License. 15 | */ 16 | 17 | 18 | //////////////////////////////////////////////////////////////////////////////// 19 | // CUSTOMIZE SLATE 20 | //////////////////////////////////////////////////////////////////////////////// 21 | // Use these settings to help adjust the appearance of Slate 22 | 23 | 24 | // BACKGROUND COLORS 25 | //////////////////// 26 | 27 | // nav (left) 28 | $nav-bg: #fafafa !default; 29 | $nav-subitem-bg: #fff !default; 30 | $nav-active-bg: #2D8CFF !default; 31 | $main-bg: #fff !default; 32 | 33 | // code side (right) 34 | $examples-bg: #2d3134 !default; 35 | $lang-select-bg: #242729 !default; 36 | $code-bg: #292929 !default; 37 | $code-annotation-bg: #1c1c1c !default; 38 | $lang-select-active-bg: #2D8CFF !default; // feel free to change this to blue or something 39 | $lang-select-border: #bada55 !default; 40 | $lang-select-pressed-bg: #111 !default; // color of language tab bg when mouse is pressed 41 | 42 | 43 | $aside-notice-bg: #eaf3fe !default; 44 | $aside-warning-bg: #feeaf3 !default; 45 | $aside-success-bg: #f3feea !default; 46 | $search-notice-bg: #feeaf3 !default; 47 | 48 | 49 | // TEXT COLORS 50 | //////////////////// 51 | $main-text: #505050 !default; // main content text color 52 | $nav-text: #505050 !default; 53 | $nav-active-text: #fff !default; 54 | $lang-select-text: #fff !default; // color of unselected language tab text 55 | $lang-select-active-text: #fff !default; // color of selected language tab text 56 | $lang-select-pressed-text: #fff !default; // color of language tab text when mouse is pressed 57 | 58 | 59 | // SIZES 60 | //////////////////// 61 | $nav-width: 230px !default; // width of the navbar 62 | $examples-width: 45% !default; // portion of the screen taken up by code examples 63 | $logo-margin: 20px !default; // margin between nav items and logo, ignored if search is active 64 | $main-padding: 28px !default; // padding to left and right of content & examples 65 | $nav-padding: 15px !default; // padding to left and right of navbar 66 | $nav-v-padding: 10px !default; // padding used vertically around search boxes and results 67 | $nav-indent: 10px !default; // extra padding for ToC subitems 68 | $h1-margin-bottom: 21px !default; // padding under the largest header tags 69 | $tablet-width: 768px !default; // min width before reverting to tablet size 70 | $phone-width: $tablet-width - $nav-width !default; // min width before reverting to mobile size 71 | 72 | 73 | // FONTS 74 | //////////////////// 75 | %default-font { 76 | font-family: 'Open Sans', sans-serif; 77 | font-size: 14px; 78 | } 79 | 80 | %header-font { 81 | @extend %default-font; 82 | font-weight: 500; 83 | } 84 | 85 | %code-font { 86 | font-family: Consolas, Menlo, Monaco, "Lucida Console", "Liberation Mono", "DejaVu Sans Mono", "Bitstream Vera Sans Mono", "Courier New", monospace, serif; 87 | font-size: 13px; 88 | line-height: 1.5; 89 | } 90 | 91 | 92 | // OTHER 93 | //////////////////// 94 | $nav-active-shadow: transparent !default; 95 | $nav-footer-border-color: #666 !default; 96 | $nav-embossed-border-top: transparent !default; 97 | $nav-embossed-border-bottom: transparent !default; 98 | $main-embossed-text-shadow: none !default; 99 | $search-box-border-color: #666 !default; 100 | 101 | 102 | //////////////////////////////////////////////////////////////////////////////// 103 | // INTERNAL 104 | //////////////////////////////////////////////////////////////////////////////// 105 | // These settings are probably best left alone. 106 | 107 | %break-words { 108 | word-break: break-all; 109 | hyphens: auto; 110 | } 111 | --------------------------------------------------------------------------------