zoom-api-js 0.4.4 → 0.4.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +2 -2
- package/CHANGELOG.md +7 -0
- package/dist/index.d.cts +481 -385
- package/dist/index.d.mts +481 -385
- package/dist/index.d.ts +481 -385
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -446,9 +446,9 @@ type ListArchivedFilesVariables = {
|
|
|
446
446
|
* **Prerequisites:**
|
|
447
447
|
* * The [**Meeting and Webinar Archiving** feature](https://support.zoom.us/hc/en-us/articles/4405656451213--Archiving-for-meetings-and-webinars) enabled for your account by [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003).
|
|
448
448
|
*
|
|
449
|
-
* **Scopes:** `recording:read:admin`
|
|
449
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin`
|
|
450
450
|
*
|
|
451
|
-
* **Granular Scopes:** `archiving:read:list_archived_files:admin`,`archiving:read:list_archived_files:master`
|
|
451
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `archiving:read:list_archived_files:admin`,`archiving:read:list_archived_files:master`
|
|
452
452
|
*
|
|
453
453
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
454
454
|
*/
|
|
@@ -561,9 +561,9 @@ type GetArchivedFileStatisticsVariables = {
|
|
|
561
561
|
* **Prerequisites:**
|
|
562
562
|
* * The [**Meeting and Webinar Archiving** feature](https://support.zoom.us/hc/en-us/articles/4405656451213--Archiving-for-meetings-and-webinars) enabled for your account by [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003).
|
|
563
563
|
*
|
|
564
|
-
* **Scopes:** `recording:read:admin`
|
|
564
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin`
|
|
565
565
|
*
|
|
566
|
-
* **Granular Scopes:** `archiving:read:archived_file_statistics:admin`
|
|
566
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `archiving:read:archived_file_statistics:admin`
|
|
567
567
|
*
|
|
568
568
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
569
569
|
*/
|
|
@@ -596,9 +596,9 @@ type UpdateArchivedFileVariables = {
|
|
|
596
596
|
* * [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) must enable the [**Meeting and Webinar Archiving** feature](https://support.zoom.us/hc/en-us/articles/4405656451213--Archiving-for-meetings-and-webinars) for your account.
|
|
597
597
|
* * Open the disabling auto-delete feature in OP. Contact [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to open.
|
|
598
598
|
*
|
|
599
|
-
* **Scopes:** `recording:write`,`recording:write:admin`
|
|
599
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write`,`recording:write:admin`
|
|
600
600
|
*
|
|
601
|
-
* **Granular Scopes:** `archiving:update:archived_file_auto_delete_status`,`archiving:update:archived_file_auto_delete_status:admin`
|
|
601
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `archiving:update:archived_file_auto_delete_status`,`archiving:update:archived_file_auto_delete_status:admin`
|
|
602
602
|
*
|
|
603
603
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
604
604
|
*/
|
|
@@ -932,9 +932,9 @@ type GetArchivedFilesVariables = {
|
|
|
932
932
|
* **Prerequisites:**
|
|
933
933
|
* * The [**Meeting and Webinar Archiving** feature](https://support.zoom.us/hc/en-us/articles/4405656451213--Archiving-for-meetings-and-webinars) enabled for your account by [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003).
|
|
934
934
|
*
|
|
935
|
-
* **Scopes:** `recording:read`
|
|
935
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read`
|
|
936
936
|
*
|
|
937
|
-
* **Granular Scopes:** `archiving:read:archived_files:admin`,`archiving:read:archived_files`
|
|
937
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `archiving:read:archived_files:admin`,`archiving:read:archived_files`
|
|
938
938
|
*
|
|
939
939
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
940
940
|
*/
|
|
@@ -959,9 +959,9 @@ type DeleteArchivedFilesVariables = {
|
|
|
959
959
|
* **Prerequisites:**
|
|
960
960
|
* * The [**Meeting and Webinar Archiving** feature](https://support.zoom.us/hc/en-us/articles/4405656451213--Archiving-for-meetings-and-webinars) enabled for your account by [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003).
|
|
961
961
|
*
|
|
962
|
-
* **Scopes:** `recording:write:admin`
|
|
962
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`
|
|
963
963
|
*
|
|
964
|
-
* **Granular Scopes:** `archiving:delete:archived_files:admin`
|
|
964
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `archiving:delete:archived_files:admin`
|
|
965
965
|
*
|
|
966
966
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
967
967
|
*/
|
|
@@ -972,7 +972,7 @@ type RecordingGetPathParams = {
|
|
|
972
972
|
*
|
|
973
973
|
* To get a webinar's cloud recordings, provide the webinar's ID or UUID. If providing the webinar ID instead of UUID, the response will be for the latest webinar instance.
|
|
974
974
|
*
|
|
975
|
-
* If a UUID starts with `/` or contains `//` (example: `/ajXp112QmuoKj4854875==`), **[double encode](/docs/api
|
|
975
|
+
* If a UUID starts with `/` or contains `//` (example: `/ajXp112QmuoKj4854875==`), **[double encode](/docs/api/using-zoom-apis/#meeting-id-and-uuid) the UUID** before making an API request.
|
|
976
976
|
*
|
|
977
977
|
* @example atsXxhSEQWit9t+U02HXNQ==
|
|
978
978
|
*/
|
|
@@ -1009,11 +1009,11 @@ type RecordingGetResponse = {
|
|
|
1009
1009
|
/**
|
|
1010
1010
|
* The URL to download the recording.
|
|
1011
1011
|
*
|
|
1012
|
-
* If a user has authorized and installed your OAuth app that contains recording scopes, use the `download_access_token` or the user's [OAuth access token](
|
|
1012
|
+
* If a user has authorized and installed your OAuth app that contains recording scopes, use the `download_access_token` or the user's [OAuth access token](/docs/integrations/oauth/) to download the file. Set the `access_token` as a Bearer token in the Authorization header. For example:
|
|
1013
1013
|
*
|
|
1014
1014
|
* `curl -H 'Authorization: Bearer <ACCESS_TOKEN>' https://{{base-domain}}/rec/archive/download/xyz`.
|
|
1015
1015
|
*
|
|
1016
|
-
* **Note:** This field does **not** return for
|
|
1016
|
+
* **Note:** This field does **not** return for Zoom on-premise accounts. Instead, this API returns the `file_path` field. The URL may be a redirect. In that case, use `curl --location` to follow redirects or use another tool, like Postman.
|
|
1017
1017
|
*
|
|
1018
1018
|
* @example https://example.com/rec/download/Qg75t7xZBtEbAkjdlgbfdngBBBB
|
|
1019
1019
|
*/
|
|
@@ -1021,7 +1021,7 @@ type RecordingGetResponse = {
|
|
|
1021
1021
|
/**
|
|
1022
1022
|
* The file path to the on-premise account recording.
|
|
1023
1023
|
*
|
|
1024
|
-
* **Note:** This API only returns this field for
|
|
1024
|
+
* **Note:** This API only returns this field for Zoom On-Premise accounts. It does **not** return the `download_url` field.
|
|
1025
1025
|
*
|
|
1026
1026
|
* @example /9090876528/path01/demo.mp4
|
|
1027
1027
|
*/
|
|
@@ -1037,7 +1037,7 @@ type RecordingGetResponse = {
|
|
|
1037
1037
|
*
|
|
1038
1038
|
* `MP4` - Video file of the recording.
|
|
1039
1039
|
* `M4A` - Audio-only file of the recording.
|
|
1040
|
-
* `TIMELINE` - Timestamp file of the recording in JSON file format. To get a timeline file, the **Add a timestamp to the recording** setting must be enabled in the [recording settings](https://support.zoom.
|
|
1040
|
+
* `TIMELINE` - Timestamp file of the recording in JSON file format. To get a timeline file, the **Add a timestamp to the recording** setting must be enabled in the [recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062627#h_3f14c3a4-d16b-4a3c-bbe5-ef7d24500048). The time will display in the host's timezone, set on their Zoom profile.
|
|
1041
1041
|
*
|
|
1042
1042
|
* `TRANSCRIPT` - Transcription file of the recording in VTT format.
|
|
1043
1043
|
* `CHAT` - A TXT file containing in-meeting chat messages that were sent during the meeting.
|
|
@@ -1111,13 +1111,13 @@ type RecordingGetResponse = {
|
|
|
1111
1111
|
*/
|
|
1112
1112
|
account_id?: string;
|
|
1113
1113
|
/**
|
|
1114
|
-
*
|
|
1114
|
+
* The duration of the meeting's recording.
|
|
1115
1115
|
*
|
|
1116
1116
|
* @example 20
|
|
1117
1117
|
*/
|
|
1118
1118
|
duration?: number;
|
|
1119
1119
|
/**
|
|
1120
|
-
* ID of the user set as the host of the meeting.
|
|
1120
|
+
* The ID of the user set as the host of the meeting.
|
|
1121
1121
|
*
|
|
1122
1122
|
* @example _0ctZtY0REqWalTmwvrdIw
|
|
1123
1123
|
*/
|
|
@@ -1129,7 +1129,7 @@ type RecordingGetResponse = {
|
|
|
1129
1129
|
*/
|
|
1130
1130
|
id?: number;
|
|
1131
1131
|
/**
|
|
1132
|
-
*
|
|
1132
|
+
* The number of recording files returned in the response of this API call. This includes the `recording_files` and `participant_audio_files` files.
|
|
1133
1133
|
*
|
|
1134
1134
|
* @example 22
|
|
1135
1135
|
*/
|
|
@@ -1162,7 +1162,7 @@ type RecordingGetResponse = {
|
|
|
1162
1162
|
* * `2` - Scheduled meeting.
|
|
1163
1163
|
* * `3` - A recurring meeting with no fixed time.
|
|
1164
1164
|
* * `4` - A meeting created via PMI (Personal Meeting ID).
|
|
1165
|
-
* * `7` - A [Personal Audio Conference](https://support.zoom.
|
|
1165
|
+
* * `7` - A [Personal Audio Conference](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0060449) (PAC).
|
|
1166
1166
|
* * `8` - Recurring meeting with a fixed time.
|
|
1167
1167
|
*
|
|
1168
1168
|
* If the recording is of a webinar:
|
|
@@ -1178,7 +1178,7 @@ type RecordingGetResponse = {
|
|
|
1178
1178
|
*/
|
|
1179
1179
|
type?: '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '99';
|
|
1180
1180
|
/**
|
|
1181
|
-
*
|
|
1181
|
+
* The unique meeting identifier. Each instance of the meeting has its own UUID.
|
|
1182
1182
|
*
|
|
1183
1183
|
* @example BOKXuumlTAGXuqwr3bLyuQ==
|
|
1184
1184
|
*/
|
|
@@ -1190,7 +1190,7 @@ type RecordingGetResponse = {
|
|
|
1190
1190
|
*/
|
|
1191
1191
|
recording_play_passcode?: string;
|
|
1192
1192
|
/**
|
|
1193
|
-
* Auto-delete status of a meeting's [cloud recording](https://support.zoom.
|
|
1193
|
+
* Auto-delete status of a meeting's [cloud recording](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062627).
|
|
1194
1194
|
*
|
|
1195
1195
|
* Prerequisite: To get the auto-delete status, the host of the recording must have the recording setting **Delete cloud recordings after a specified number of days** enabled.
|
|
1196
1196
|
*
|
|
@@ -1208,11 +1208,11 @@ type RecordingGetResponse = {
|
|
|
1208
1208
|
*/
|
|
1209
1209
|
participant_audio_files?: {
|
|
1210
1210
|
/**
|
|
1211
|
-
* The URL to download the recording. If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](
|
|
1211
|
+
* The URL to download the recording. If a user has authorized and installed your OAuth app that contains recording scopes, use the user's [OAuth access token](/docs/integrations/oauth/) to download the file, and set the `access_token` as a Bearer token in the Authorization header.
|
|
1212
1212
|
*
|
|
1213
1213
|
* `curl -H 'Authorization: Bearer <ACCESS_TOKEN>' https://{{base-domain}}/rec/archive/download/xyz`
|
|
1214
1214
|
*
|
|
1215
|
-
* **Note:** This field does **not** return for
|
|
1215
|
+
* **Note:** This field does **not** return for Zoom On-Premise accounts. Instead, this API will return the `file_path` field.
|
|
1216
1216
|
*
|
|
1217
1217
|
* @example https://example.com/rec/download/Qg75t7xZBtEbAkjdlgbfdngBBBB
|
|
1218
1218
|
*/
|
|
@@ -1226,7 +1226,7 @@ type RecordingGetResponse = {
|
|
|
1226
1226
|
/**
|
|
1227
1227
|
* The file path to the on-premise account recording.
|
|
1228
1228
|
*
|
|
1229
|
-
* **Note:** This API only returns this field for
|
|
1229
|
+
* **Note:** This API only returns this field for Zoom on-premise accounts. It does **not** return the `download_url` field.
|
|
1230
1230
|
*
|
|
1231
1231
|
* @example /9090876528/path01/demo.mp4
|
|
1232
1232
|
*/
|
|
@@ -1242,7 +1242,7 @@ type RecordingGetResponse = {
|
|
|
1242
1242
|
*
|
|
1243
1243
|
* * `MP4` - Video file.
|
|
1244
1244
|
* * `M4A` - Audio-only file.
|
|
1245
|
-
* * `TIMELINE` - Timestamp file of the recording, in JSON file format. To get a timeline file, the **Add a timestamp to the recording** setting **must** be enabled in the [recording settings](https://support.zoom.
|
|
1245
|
+
* * `TIMELINE` - Timestamp file of the recording, in JSON file format. To get a timeline file, the **Add a timestamp to the recording** setting **must** be enabled in the [recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062627#h_3f14c3a4-d16b-4a3c-bbe5-ef7d24500048). The time will display in the host's timezone.
|
|
1246
1246
|
* * `TRANSCRIPT` - A transcript of the recording, in VTT format.
|
|
1247
1247
|
* * `CHAT` - A text file containing chat messages sent during the meeting.
|
|
1248
1248
|
* * `CC` - A file containing the closed captions of the recording, in VTT file format.
|
|
@@ -1305,13 +1305,13 @@ type RecordingGetVariables = {
|
|
|
1305
1305
|
queryParams?: RecordingGetQueryParams;
|
|
1306
1306
|
} & FetcherExtraProps;
|
|
1307
1307
|
/**
|
|
1308
|
-
*
|
|
1308
|
+
* Returns all of a meeting's [recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062627#h_7420acb5-1897-4061-87b4-5b76e99c03b4). Use the `download_url` property listed in the response to download the recording files. To access a password-protected cloud recording, send the `download_access_token` or the user's [OAuth access token](/docs/integrations/oauth/) as a Bearer token in the Authorization header. For example:
|
|
1309
1309
|
*
|
|
1310
1310
|
* `curl -H 'Authorization: Bearer <ACCESS_TOKEN>' https://{{base-domain}}/rec/archive/download/xyz`
|
|
1311
1311
|
*
|
|
1312
|
-
* **Scopes:** `recording:read`,`phone_recording:read:admin`
|
|
1312
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read`,`phone_recording:read:admin`
|
|
1313
1313
|
*
|
|
1314
|
-
* **Granular Scopes:** `cloud_recording:read:list_recording_files:admin`,`cloud_recording:read:list_recording_files`,`cloud_recording:read:list_recording_files:master`
|
|
1314
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:read:list_recording_files:admin`,`cloud_recording:read:list_recording_files`,`cloud_recording:read:list_recording_files:master`
|
|
1315
1315
|
*
|
|
1316
1316
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1317
1317
|
*/
|
|
@@ -1352,9 +1352,9 @@ type RecordingDeleteVariables = {
|
|
|
1352
1352
|
*
|
|
1353
1353
|
*
|
|
1354
1354
|
*
|
|
1355
|
-
* **Scopes:** `recording:write:admin`,`recording:write`
|
|
1355
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write`
|
|
1356
1356
|
*
|
|
1357
|
-
* **Granular Scopes:** `cloud_recording:delete:meeting_recording`,`cloud_recording:delete:meeting_recording:admin`,`cloud_recording:delete:meeting_recording:master`
|
|
1357
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:delete:meeting_recording`,`cloud_recording:delete:meeting_recording:admin`,`cloud_recording:delete:meeting_recording:master`
|
|
1358
1358
|
*
|
|
1359
1359
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1360
1360
|
*/
|
|
@@ -1482,7 +1482,7 @@ type AnalyticsDetailsVariables = {
|
|
|
1482
1482
|
/**
|
|
1483
1483
|
* Retrieve a meeting or webinar recording's [analytics details](https://support.zoom.us/hc/en-us/articles/205347605-Managing-cloud-recordings#h_0b665029-ce74-4849-9794-d1aa0320d163). **Maximum duration:** 1 month.
|
|
1484
1484
|
*
|
|
1485
|
-
* **Granular Scopes:** `cloud_recording:read:recording_analytics_details`,`cloud_recording:read:recording_analytics_details:master`,`cloud_recording:read:recording_analytics_details:admin`
|
|
1485
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:read:recording_analytics_details`,`cloud_recording:read:recording_analytics_details:master`,`cloud_recording:read:recording_analytics_details:admin`
|
|
1486
1486
|
*/
|
|
1487
1487
|
declare const analyticsDetails: (variables: AnalyticsDetailsVariables, signal?: AbortSignal) => Promise<AnalyticsDetailsResponse>;
|
|
1488
1488
|
type AnalyticsSummaryPathParams = {
|
|
@@ -1560,7 +1560,7 @@ type AnalyticsSummaryVariables = {
|
|
|
1560
1560
|
/**
|
|
1561
1561
|
* Retrieve meeting recording's [analytics summary](https://support.zoom.us/hc/en-us/articles/205347605-Managing-cloud-recordings#h_0b665029-ce74-4849-9794-d1aa0320d163). **Maximum duration:** 1 month.
|
|
1562
1562
|
*
|
|
1563
|
-
* **Granular Scopes:** `cloud_recording:read:recording_analytics_summary`,`cloud_recording:read:recording_analytics_summary:master`,`cloud_recording:read:recording_analytics_summary:admin`
|
|
1563
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:read:recording_analytics_summary`,`cloud_recording:read:recording_analytics_summary:master`,`cloud_recording:read:recording_analytics_summary:admin`
|
|
1564
1564
|
*/
|
|
1565
1565
|
declare const analyticsSummary: (variables: AnalyticsSummaryVariables, signal?: AbortSignal) => Promise<AnalyticsSummaryResponse>;
|
|
1566
1566
|
type MeetingRecordingRegistrantsPathParams = {
|
|
@@ -1809,9 +1809,9 @@ type MeetingRecordingRegistrantsVariables = {
|
|
|
1809
1809
|
*
|
|
1810
1810
|
*
|
|
1811
1811
|
*
|
|
1812
|
-
* **Scopes:** `recording:read:admin`,`recording:read`
|
|
1812
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin`,`recording:read`
|
|
1813
1813
|
*
|
|
1814
|
-
* **Granular Scopes:** `cloud_recording:read:list_recording_registrants`,`cloud_recording:read:list_recording_registrants:admin`,`cloud_recording:read:list_recording_registrants:master`
|
|
1814
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:read:list_recording_registrants`,`cloud_recording:read:list_recording_registrants:admin`,`cloud_recording:read:list_recording_registrants:master`
|
|
1815
1815
|
*
|
|
1816
1816
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
1817
1817
|
*/
|
|
@@ -2013,9 +2013,9 @@ type MeetingRecordingRegistrantCreateVariables = {
|
|
|
2013
2013
|
*
|
|
2014
2014
|
*
|
|
2015
2015
|
*
|
|
2016
|
-
* **Scopes:** `recording:write:admin`,`recording:write`
|
|
2016
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write`
|
|
2017
2017
|
*
|
|
2018
|
-
* **Granular Scopes:** `cloud_recording:write:recording_registrant`,`cloud_recording:write:recording_registrant:master`,`cloud_recording:write:recording_registrant:admin`
|
|
2018
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:write:recording_registrant`,`cloud_recording:write:recording_registrant:master`,`cloud_recording:write:recording_registrant:admin`
|
|
2019
2019
|
*
|
|
2020
2020
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2021
2021
|
*/
|
|
@@ -2089,9 +2089,9 @@ type RecordingRegistrantsQuestionsGetVariables = {
|
|
|
2089
2089
|
*
|
|
2090
2090
|
*
|
|
2091
2091
|
*
|
|
2092
|
-
* **Scopes:** `recording:read:admin`,`recording:read`
|
|
2092
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin`,`recording:read`
|
|
2093
2093
|
*
|
|
2094
|
-
* **Granular Scopes:** `cloud_recording:read:registration_questions`,`cloud_recording:read:registration_questions:master`,`cloud_recording:read:registration_questions:admin`
|
|
2094
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:read:registration_questions`,`cloud_recording:read:registration_questions:master`,`cloud_recording:read:registration_questions:admin`
|
|
2095
2095
|
*
|
|
2096
2096
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2097
2097
|
*/
|
|
@@ -2166,9 +2166,9 @@ type RecordingRegistrantQuestionUpdateVariables = {
|
|
|
2166
2166
|
*
|
|
2167
2167
|
*
|
|
2168
2168
|
*
|
|
2169
|
-
* **Scopes:** `recording:write:admin`,`recording:write`
|
|
2169
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write`
|
|
2170
2170
|
*
|
|
2171
|
-
* **Granular Scopes:** `cloud_recording:update:registration_questions:admin`,`cloud_recording:update:registration_questions`,`cloud_recording:update:registration_questions:master`
|
|
2171
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:update:registration_questions:admin`,`cloud_recording:update:registration_questions`,`cloud_recording:update:registration_questions:master`
|
|
2172
2172
|
*
|
|
2173
2173
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2174
2174
|
*/
|
|
@@ -2212,9 +2212,9 @@ type MeetingRecordingRegistrantStatusVariables = {
|
|
|
2212
2212
|
*
|
|
2213
2213
|
*
|
|
2214
2214
|
*
|
|
2215
|
-
* **Scopes:** `recording:write:admin`,`recording:write`
|
|
2215
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write`
|
|
2216
2216
|
*
|
|
2217
|
-
* **Granular Scopes:** `cloud_recording:update:registrant_status`,`cloud_recording:update:registrant_status:master`,`cloud_recording:update:registrant_status:admin`
|
|
2217
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:update:registrant_status`,`cloud_recording:update:registrant_status:master`,`cloud_recording:update:registrant_status:admin`
|
|
2218
2218
|
*
|
|
2219
2219
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
2220
2220
|
*/
|
|
@@ -2343,9 +2343,9 @@ type RecordingSettingUpdateVariables = {
|
|
|
2343
2343
|
*
|
|
2344
2344
|
* Response includes recording content access information, which requires the current user to have the `View the recording content` permission to access it.
|
|
2345
2345
|
*
|
|
2346
|
-
* **Scopes:** `recording:read:admin`,`recording:read`
|
|
2346
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin`,`recording:read`
|
|
2347
2347
|
*
|
|
2348
|
-
* **Granular Scopes:** `cloud_recording:read:recording_settings`,`cloud_recording:read:recording_settings:admin`,`cloud_recording:read:recording_settings:master`
|
|
2348
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:read:recording_settings`,`cloud_recording:read:recording_settings:admin`,`cloud_recording:read:recording_settings:master`
|
|
2349
2349
|
*
|
|
2350
2350
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2351
2351
|
*/
|
|
@@ -2462,9 +2462,9 @@ type RecordingSettingsUpdateVariables = {
|
|
|
2462
2462
|
* Update settings applied to a meeting's [cloud recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording).
|
|
2463
2463
|
* The request contains the recording content access information, which requires the current user to have the `view recording content` and `recording editing` permissions to access.
|
|
2464
2464
|
*
|
|
2465
|
-
* **Scopes:** `recording:write:admin`,`recording:write`
|
|
2465
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write`
|
|
2466
2466
|
*
|
|
2467
|
-
* **Granular Scopes:** `cloud_recording:update:recording_settings`,`cloud_recording:update:recording_settings:master`,`cloud_recording:update:recording_settings:admin`
|
|
2467
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:update:recording_settings`,`cloud_recording:update:recording_settings:master`,`cloud_recording:update:recording_settings:admin`
|
|
2468
2468
|
*
|
|
2469
2469
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2470
2470
|
*/
|
|
@@ -2508,9 +2508,9 @@ type RecordingDeleteOneVariables = {
|
|
|
2508
2508
|
*
|
|
2509
2509
|
*
|
|
2510
2510
|
*
|
|
2511
|
-
* **Scopes:** `recording:write:admin`,`recording:write`
|
|
2511
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write`
|
|
2512
2512
|
*
|
|
2513
|
-
* **Granular Scopes:** `cloud_recording:delete:recording_file`,`cloud_recording:delete:recording_file:admin`,`cloud_recording:delete:recording_file:master`
|
|
2513
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:delete:recording_file`,`cloud_recording:delete:recording_file:admin`,`cloud_recording:delete:recording_file:master`
|
|
2514
2514
|
*
|
|
2515
2515
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2516
2516
|
*/
|
|
@@ -2551,9 +2551,9 @@ type RecordingStatusUpdateOneVariables = {
|
|
|
2551
2551
|
*
|
|
2552
2552
|
*
|
|
2553
2553
|
*
|
|
2554
|
-
* **Scopes:** `recording:write:admin`,`recording:write`
|
|
2554
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write`
|
|
2555
2555
|
*
|
|
2556
|
-
* **Granular Scopes:** `cloud_recording:update:recover_single_recording`,`cloud_recording:update:recover_single_recording:master`,`cloud_recording:update:recover_single_recording:admin`
|
|
2556
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:update:recover_single_recording`,`cloud_recording:update:recover_single_recording:master`,`cloud_recording:update:recover_single_recording:admin`
|
|
2557
2557
|
*
|
|
2558
2558
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2559
2559
|
*/
|
|
@@ -2588,9 +2588,9 @@ type RecordingStatusUpdateVariables = {
|
|
|
2588
2588
|
*
|
|
2589
2589
|
* * A Pro user with Cloud Recording enabled.
|
|
2590
2590
|
*
|
|
2591
|
-
* **Scopes:** `recording:write:admin`,`recording:write`
|
|
2591
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write`
|
|
2592
2592
|
*
|
|
2593
|
-
* **Granular Scopes:** `cloud_recording:update:recover_meeting_recordings`,`cloud_recording:update:recover_meeting_recordings:master`,`cloud_recording:update:recover_meeting_recordings:admin`
|
|
2593
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:update:recover_meeting_recordings`,`cloud_recording:update:recover_meeting_recordings:master`,`cloud_recording:update:recover_meeting_recordings:admin`
|
|
2594
2594
|
*
|
|
2595
2595
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2596
2596
|
*/
|
|
@@ -2957,9 +2957,9 @@ type RecordingsListVariables = {
|
|
|
2957
2957
|
* * Must have a Pro or a higher plan.
|
|
2958
2958
|
* * Must enable Cloud Recording on the user's account.
|
|
2959
2959
|
*
|
|
2960
|
-
* **Scopes:** `recording:read:admin`,`recording:read`
|
|
2960
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin`,`recording:read`
|
|
2961
2961
|
*
|
|
2962
|
-
* **Granular Scopes:** `cloud_recording:read:list_user_recordings`,`cloud_recording:read:list_user_recordings:master`,`cloud_recording:read:list_user_recordings:admin`
|
|
2962
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:read:list_user_recordings`,`cloud_recording:read:list_user_recordings:master`,`cloud_recording:read:list_user_recordings:admin`
|
|
2963
2963
|
*
|
|
2964
2964
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
2965
2965
|
*/
|
|
@@ -3184,7 +3184,7 @@ type ListDevicesVariables = {
|
|
|
3184
3184
|
*
|
|
3185
3185
|
*
|
|
3186
3186
|
*
|
|
3187
|
-
* **Scopes:** `device:read:admin`,`device:write:admin`
|
|
3187
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:admin`,`device:write:admin`
|
|
3188
3188
|
*
|
|
3189
3189
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
3190
3190
|
*/
|
|
@@ -3271,7 +3271,7 @@ type AddDeviceVariables = {
|
|
|
3271
3271
|
*
|
|
3272
3272
|
* **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`
|
|
3273
3273
|
*
|
|
3274
|
-
* **Scopes:** `device:write:admin`
|
|
3274
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin`
|
|
3275
3275
|
*
|
|
3276
3276
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
3277
3277
|
*/
|
|
@@ -3338,9 +3338,9 @@ type GetzdmgroupinfoVariables = {
|
|
|
3338
3338
|
/**
|
|
3339
3339
|
* Get Zoom Device Manager (ZDM) group information for an account.
|
|
3340
3340
|
*
|
|
3341
|
-
* **Scopes:** `device:read:admin`
|
|
3341
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:admin`
|
|
3342
3342
|
*
|
|
3343
|
-
* **Granular Scopes:** `device:read:list_groups:admin`,`device:read:list_groups:master`
|
|
3343
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:list_groups:admin`,`device:read:list_groups:master`
|
|
3344
3344
|
*
|
|
3345
3345
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
3346
3346
|
*/
|
|
@@ -3375,9 +3375,9 @@ type AssigndevicetoauserCommonareaVariables = {
|
|
|
3375
3375
|
* **Prerequisites:**
|
|
3376
3376
|
* * Device must be enrolled in Zoom Device Management (ZDM).
|
|
3377
3377
|
*
|
|
3378
|
-
* **Scopes:** `device:write:admin`
|
|
3378
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin`
|
|
3379
3379
|
*
|
|
3380
|
-
* **Granular Scopes:** `device:write:zpa_device:admin`,`device:write:zpa_device:master`
|
|
3380
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:zpa_device:admin`,`device:write:zpa_device:master`
|
|
3381
3381
|
*
|
|
3382
3382
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
3383
3383
|
*/
|
|
@@ -3471,9 +3471,9 @@ type GetZpaDeviceListProfileSettingOfaUserVariables = {
|
|
|
3471
3471
|
/**
|
|
3472
3472
|
* Get a user's Zoom Phone Appliance (ZPA) device profile settings. For user-level apps, pass the `me` value instead of the `userId` parameter.
|
|
3473
3473
|
*
|
|
3474
|
-
* **Scopes:** `device:read:admin`
|
|
3474
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:admin`
|
|
3475
3475
|
*
|
|
3476
|
-
* **Granular Scopes:** `device:read:user_setting:admin`,`device:read:user_setting:master`
|
|
3476
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:user_setting:admin`,`device:read:user_setting:master`
|
|
3477
3477
|
*
|
|
3478
3478
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
3479
3479
|
*/
|
|
@@ -3539,9 +3539,9 @@ type UpgradeZpasAppVariables = {
|
|
|
3539
3539
|
*
|
|
3540
3540
|
* * Account owner or admin permissions.
|
|
3541
3541
|
*
|
|
3542
|
-
* **Scopes:** `device:write:admin`
|
|
3542
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin`
|
|
3543
3543
|
*
|
|
3544
|
-
* **Granular Scopes:** `device:write:zpa_os_app:admin`,`device:write:zpa_os_app:master`
|
|
3544
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:zpa_os_app:admin`,`device:write:zpa_os_app:master`
|
|
3545
3545
|
*
|
|
3546
3546
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
3547
3547
|
*/
|
|
@@ -3567,9 +3567,9 @@ type DeleteZpaDeviceByVendorAndMacAddressVariables = {
|
|
|
3567
3567
|
/**
|
|
3568
3568
|
* Remove a ZPA device from the device manager, by vendor and mac address.
|
|
3569
3569
|
*
|
|
3570
|
-
* **Scopes:** `device:write:admin`
|
|
3570
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin`
|
|
3571
3571
|
*
|
|
3572
|
-
* **Granular Scopes:** `device:delete:zpa_device:admin`,`device:delete:zpa_device:master`
|
|
3572
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:delete:zpa_device:admin`,`device:delete:zpa_device:master`
|
|
3573
3573
|
*
|
|
3574
3574
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
3575
3575
|
*/
|
|
@@ -3628,9 +3628,9 @@ type GetZpaVersioninfoVariables = {
|
|
|
3628
3628
|
/**
|
|
3629
3629
|
* Get ZPA firmware and app version information that can be upgraded for devices.
|
|
3630
3630
|
*
|
|
3631
|
-
* **Scopes:** `device:read:admin`
|
|
3631
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:admin`
|
|
3632
3632
|
*
|
|
3633
|
-
* **Granular Scopes:** `device:read:list_zpa_versions:admin`,`device:read:list_zpa_versions:master`
|
|
3633
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:list_zpa_versions:admin`,`device:read:list_zpa_versions:master`
|
|
3634
3634
|
*
|
|
3635
3635
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
3636
3636
|
*/
|
|
@@ -3773,7 +3773,7 @@ type GetDeviceVariables = {
|
|
|
3773
3773
|
/**
|
|
3774
3774
|
* Retrieve a device's details.
|
|
3775
3775
|
*
|
|
3776
|
-
* **Scopes:** `device:read:admin`,`device:write:admin`
|
|
3776
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:admin`,`device:write:admin`
|
|
3777
3777
|
*
|
|
3778
3778
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
3779
3779
|
*/
|
|
@@ -3796,7 +3796,7 @@ type DeleteDeviceVariables = {
|
|
|
3796
3796
|
* **Prerequisites:**
|
|
3797
3797
|
* * Device must be enrolled in ZMD (Zoom Device Management)
|
|
3798
3798
|
*
|
|
3799
|
-
* **Scopes:** `device:write:admin`
|
|
3799
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin`
|
|
3800
3800
|
*
|
|
3801
3801
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
3802
3802
|
*/
|
|
@@ -3849,7 +3849,7 @@ type UpdateDeviceVariables = {
|
|
|
3849
3849
|
* **Prerequisites:**
|
|
3850
3850
|
* * Device must be enrolled in ZMD (Zoom Device Management)
|
|
3851
3851
|
*
|
|
3852
|
-
* **Scopes:** `device:write:admin`
|
|
3852
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin`
|
|
3853
3853
|
*
|
|
3854
3854
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
3855
3855
|
*/
|
|
@@ -3878,9 +3878,9 @@ type AssginGroupVariables = {
|
|
|
3878
3878
|
/**
|
|
3879
3879
|
* Assign a device to a new group.
|
|
3880
3880
|
*
|
|
3881
|
-
* **Scopes:** `device:write:admin`
|
|
3881
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin`
|
|
3882
3882
|
*
|
|
3883
|
-
* **Granular Scopes:** `device:write:group:admin`,`device:write:group:master`
|
|
3883
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:group:admin`,`device:write:group:master`
|
|
3884
3884
|
*
|
|
3885
3885
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3886
3886
|
*/
|
|
@@ -3924,9 +3924,9 @@ type ChangeDeviceAssociationVariables = {
|
|
|
3924
3924
|
/**
|
|
3925
3925
|
* Change a device's association from one Zoom Room to another. **Prerequisites:** Device must be enrolled in ZDM (Zoom Device Management).
|
|
3926
3926
|
*
|
|
3927
|
-
* **Scopes:** `device:write:admin`
|
|
3927
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin`
|
|
3928
3928
|
*
|
|
3929
|
-
* **Granular Scopes:** `device:update:zdm_device_assignment:admin`
|
|
3929
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:update:zdm_device_assignment:admin`
|
|
3930
3930
|
*
|
|
3931
3931
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
3932
3932
|
*/
|
|
@@ -4041,9 +4041,9 @@ type DeviceListVariables = {
|
|
|
4041
4041
|
*
|
|
4042
4042
|
*
|
|
4043
4043
|
*
|
|
4044
|
-
* **Scopes:** `h323:read:admin`
|
|
4044
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323:read:admin`
|
|
4045
4045
|
*
|
|
4046
|
-
* **Granular Scopes:** `h323_device:read:list_devices:admin`
|
|
4046
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323_device:read:list_devices:admin`
|
|
4047
4047
|
*
|
|
4048
4048
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
4049
4049
|
*/
|
|
@@ -4128,9 +4128,9 @@ type DeviceCreateVariables = {
|
|
|
4128
4128
|
*
|
|
4129
4129
|
*
|
|
4130
4130
|
*
|
|
4131
|
-
* **Scopes:** `h323:write:admin`
|
|
4131
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323:write:admin`
|
|
4132
4132
|
*
|
|
4133
|
-
* **Granular Scopes:** `h323_device:write:device:admin`
|
|
4133
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323_device:write:device:admin`
|
|
4134
4134
|
*
|
|
4135
4135
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
4136
4136
|
*/
|
|
@@ -4153,9 +4153,9 @@ type DeviceDeleteVariables = {
|
|
|
4153
4153
|
*
|
|
4154
4154
|
*
|
|
4155
4155
|
*
|
|
4156
|
-
* **Scopes:** `h323:write:admin`
|
|
4156
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323:write:admin`
|
|
4157
4157
|
*
|
|
4158
|
-
* **Granular Scopes:** `h323_device:delete:device:admin`
|
|
4158
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323_device:delete:device:admin`
|
|
4159
4159
|
*
|
|
4160
4160
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
4161
4161
|
*/
|
|
@@ -4212,9 +4212,9 @@ type DeviceUpdateVariables = {
|
|
|
4212
4212
|
*
|
|
4213
4213
|
*
|
|
4214
4214
|
*
|
|
4215
|
-
* **Scopes:** `h323:write:admin`
|
|
4215
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323:write:admin`
|
|
4216
4216
|
*
|
|
4217
|
-
* **Granular Scopes:** `h323_device:update:device:admin`
|
|
4217
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323_device:update:device:admin`
|
|
4218
4218
|
*
|
|
4219
4219
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
4220
4220
|
*/
|
|
@@ -4255,9 +4255,9 @@ type DeleteMeetingChatMessageByIdVariables = {
|
|
|
4255
4255
|
* **Prerequisites:**
|
|
4256
4256
|
* * Have Zoom enable the DLP for the in-meeting chat feature to use this API.
|
|
4257
4257
|
*
|
|
4258
|
-
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
4258
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
4259
4259
|
*
|
|
4260
|
-
* **Granular Scopes:** `meeting:delete:live_meeting_chat_message`,`meeting:delete:live_meeting_chat_message:admin`
|
|
4260
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:live_meeting_chat_message`,`meeting:delete:live_meeting_chat_message:admin`
|
|
4261
4261
|
*
|
|
4262
4262
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
4263
4263
|
*/
|
|
@@ -4295,9 +4295,9 @@ type UpdateMeetingChatMessageByIdVariables = {
|
|
|
4295
4295
|
/**
|
|
4296
4296
|
* Update a message in a live meeting, based on ID. **Prerequisites:** * Have Zoom enable the DLP for the in-meeting chat feature to use this API.
|
|
4297
4297
|
*
|
|
4298
|
-
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
4298
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
4299
4299
|
*
|
|
4300
|
-
* **Granular Scopes:** `meeting:update:live_meeting_chat_message`,`meeting:update:live_meeting_chat_message:admin`
|
|
4300
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:live_meeting_chat_message`,`meeting:update:live_meeting_chat_message:admin`
|
|
4301
4301
|
*
|
|
4302
4302
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
4303
4303
|
*/
|
|
@@ -4490,9 +4490,9 @@ type InMeetingControlVariables = {
|
|
|
4490
4490
|
* * Recording control: [Cloud recording](https://support.zoom.us/hc/en-us/articles/360060231472-Enabling-cloud-recording) must be enabled on the account.
|
|
4491
4491
|
* * The user calling this API must be the host or an alternative meeting host.
|
|
4492
4492
|
*
|
|
4493
|
-
* **Scopes:** `meeting:write`,`meeting:write:admin`,`meeting:master`
|
|
4493
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`,`meeting:master`
|
|
4494
4494
|
*
|
|
4495
|
-
* **Granular Scopes:** `meeting:update:in_meeting_controls`,`meeting:update:in_meeting_controls:admin`
|
|
4495
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:in_meeting_controls`,`meeting:update:in_meeting_controls:admin`
|
|
4496
4496
|
*
|
|
4497
4497
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
4498
4498
|
*/
|
|
@@ -4648,9 +4648,9 @@ type ListmeetingsummariesVariables = {
|
|
|
4648
4648
|
* * The Meeting Summary with AI Companion feature enabled in the host's account.
|
|
4649
4649
|
* * E2ee meetings do not have summary feature enabled.
|
|
4650
4650
|
*
|
|
4651
|
-
* **Scopes:** `meeting_summary:read:admin`
|
|
4651
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_summary:read:admin`
|
|
4652
4652
|
*
|
|
4653
|
-
* **Granular Scopes:** `meeting:read:list_summaries:admin`
|
|
4653
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_summaries:admin`
|
|
4654
4654
|
*
|
|
4655
4655
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
4656
4656
|
*/
|
|
@@ -5770,9 +5770,9 @@ type MeetingVariables = {
|
|
|
5770
5770
|
* **Prerequisites**:
|
|
5771
5771
|
* * Host user must have a Zoom Meetings Basic license or higher.
|
|
5772
5772
|
*
|
|
5773
|
-
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
5773
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
5774
5774
|
*
|
|
5775
|
-
* **Granular Scopes:** `meeting:read:meeting`,`meeting:read:meeting:admin`
|
|
5775
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:meeting`,`meeting:read:meeting:admin`
|
|
5776
5776
|
*
|
|
5777
5777
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
5778
5778
|
*/
|
|
@@ -5824,9 +5824,9 @@ type MeetingDeleteVariables = {
|
|
|
5824
5824
|
* **Prerequisites**:
|
|
5825
5825
|
* * For recurring meetings, the `occurrence_id` is required to delete a specific occurrence. If not provided, the entire recurring series will be deleted.
|
|
5826
5826
|
*
|
|
5827
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
5827
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
5828
5828
|
*
|
|
5829
|
-
* **Granular Scopes:** `meeting:delete:meeting`,`meeting:delete:meeting:admin`
|
|
5829
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:meeting`,`meeting:delete:meeting:admin`
|
|
5830
5830
|
*
|
|
5831
5831
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
5832
5832
|
*/
|
|
@@ -6788,9 +6788,9 @@ type MeetingUpdateVariables = {
|
|
|
6788
6788
|
* * The `recurrence` object is required only when updating the entire series of a recurring meeting with `type=8`.
|
|
6789
6789
|
* * This API has a rate limit of **100 requests per day**. You can update a meeting for a maximum of 100 times within a 24-hour period.
|
|
6790
6790
|
*
|
|
6791
|
-
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
6791
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
6792
6792
|
*
|
|
6793
|
-
* **Granular Scopes:** `meeting:update:meeting:admin`,`meeting:update:meeting`
|
|
6793
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:meeting:admin`,`meeting:update:meeting`
|
|
6794
6794
|
*
|
|
6795
6795
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
6796
6796
|
*/
|
|
@@ -7159,9 +7159,9 @@ type CreateBatchPollsVariables = {
|
|
|
7159
7159
|
* * Polling feature must be enabled in the host's account.
|
|
7160
7160
|
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
7161
7161
|
*
|
|
7162
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
7162
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
7163
7163
|
*
|
|
7164
|
-
* **Granular Scopes:** `meeting:write:batch_polls`,`meeting:write:batch_polls:admin`
|
|
7164
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:batch_polls`,`meeting:write:batch_polls:admin`
|
|
7165
7165
|
*
|
|
7166
7166
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7167
7167
|
*/
|
|
@@ -7257,9 +7257,9 @@ type AddBatchRegistrantsVariables = {
|
|
|
7257
7257
|
*
|
|
7258
7258
|
*
|
|
7259
7259
|
*
|
|
7260
|
-
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
7260
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
7261
7261
|
*
|
|
7262
|
-
* **Granular Scopes:** `meeting:write:batch_registrants`,`meeting:write:batch_registrants:admin`
|
|
7262
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:batch_registrants`,`meeting:write:batch_registrants:admin`
|
|
7263
7263
|
*
|
|
7264
7264
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
7265
7265
|
*/
|
|
@@ -7323,9 +7323,9 @@ type MeetingInvitationVariables = {
|
|
|
7323
7323
|
* **Prerequisites**:
|
|
7324
7324
|
* * Host user must have a Zoom Meetings Basic license or higher.
|
|
7325
7325
|
*
|
|
7326
|
-
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
7326
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
7327
7327
|
*
|
|
7328
|
-
* **Granular Scopes:** `meeting:read:invitation`,`meeting:read:invitation:admin`
|
|
7328
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:invitation`,`meeting:read:invitation:admin`
|
|
7329
7329
|
*
|
|
7330
7330
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7331
7331
|
*/
|
|
@@ -7417,9 +7417,9 @@ type MeetingInviteLinksCreateVariables = {
|
|
|
7417
7417
|
* **Prerequisites**:
|
|
7418
7418
|
* * The `ttl` value, in seconds, defines the invite link's expiration time. It must be between `0` or no expiration and `7776000` or 90 days, and has a default value of `7200` or 2 hours.
|
|
7419
7419
|
*
|
|
7420
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
7420
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
7421
7421
|
*
|
|
7422
|
-
* **Granular Scopes:** `meeting:write:invite_links`,`meeting:write:invite_links:admin`
|
|
7422
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:invite_links`,`meeting:write:invite_links:admin`
|
|
7423
7423
|
*
|
|
7424
7424
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7425
7425
|
*/
|
|
@@ -7461,9 +7461,9 @@ type MeetingLiveStreamingJoinTokenVariables = {
|
|
|
7461
7461
|
* * A Pro or higher plan for the meeting host.
|
|
7462
7462
|
* * The **Allow livestreaming of meetings** user setting enabled in the Zoom web portal.
|
|
7463
7463
|
*
|
|
7464
|
-
* **Scopes:** `meeting_token:read:admin:live_streaming`,`meeting_token:read:live_streaming`
|
|
7464
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_token:read:admin:live_streaming`,`meeting_token:read:live_streaming`
|
|
7465
7465
|
*
|
|
7466
|
-
* **Granular Scopes:** `meeting:read:live_streaming_token`,`meeting:read:live_streaming_token:admin`
|
|
7466
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:live_streaming_token`,`meeting:read:live_streaming_token:admin`
|
|
7467
7467
|
*
|
|
7468
7468
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7469
7469
|
*/
|
|
@@ -7505,9 +7505,9 @@ type MeetingLocalArchivingArchiveTokenVariables = {
|
|
|
7505
7505
|
* * A Pro or higher plan for the meeting host.
|
|
7506
7506
|
* * The **Archive meetings and webinars** account setting enabled in the Zoom web portal.
|
|
7507
7507
|
*
|
|
7508
|
-
* **Scopes:** `meeting_token:read:admin:local_archiving`
|
|
7508
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_token:read:admin:local_archiving`
|
|
7509
7509
|
*
|
|
7510
|
-
* **Granular Scopes:** `meeting:read:local_archiving_token:admin`
|
|
7510
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:local_archiving_token:admin`
|
|
7511
7511
|
*
|
|
7512
7512
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7513
7513
|
*/
|
|
@@ -7557,9 +7557,9 @@ type MeetingLocalRecordingJoinTokenVariables = {
|
|
|
7557
7557
|
* **Prerequisites:**
|
|
7558
7558
|
* * The **Local recording** user setting enabled in the Zoom web portal.
|
|
7559
7559
|
*
|
|
7560
|
-
* **Scopes:** `meeting_token:read:admin:local_recording`,`meeting_token:read:local_recording`
|
|
7560
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_token:read:admin:local_recording`,`meeting_token:read:local_recording`
|
|
7561
7561
|
*
|
|
7562
|
-
* **Granular Scopes:** `meeting:read:local_recording_token`,`meeting:read:local_recording_token:admin`
|
|
7562
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:local_recording_token`,`meeting:read:local_recording_token:admin`
|
|
7563
7563
|
*
|
|
7564
7564
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7565
7565
|
*/
|
|
@@ -7615,9 +7615,9 @@ type GetMeetingLiveStreamDetailsVariables = {
|
|
|
7615
7615
|
*
|
|
7616
7616
|
*
|
|
7617
7617
|
*
|
|
7618
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
7618
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
7619
7619
|
*
|
|
7620
|
-
* **Granular Scopes:** `meeting:read:livestream`,`meeting:read:livestream:admin`
|
|
7620
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:livestream`,`meeting:read:livestream:admin`
|
|
7621
7621
|
*
|
|
7622
7622
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7623
7623
|
*/
|
|
@@ -7674,9 +7674,9 @@ type MeetingLiveStreamUpdateVariables = {
|
|
|
7674
7674
|
* **Prerequisites:**
|
|
7675
7675
|
* * Meeting host must have a Pro license.
|
|
7676
7676
|
*
|
|
7677
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
7677
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
7678
7678
|
*
|
|
7679
|
-
* **Granular Scopes:** `meeting:update:livestream`,`meeting:update:livestream:admin`
|
|
7679
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:livestream`,`meeting:update:livestream:admin`
|
|
7680
7680
|
*
|
|
7681
7681
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7682
7682
|
*/
|
|
@@ -7753,9 +7753,9 @@ type MeetingLiveStreamStatusUpdateVariables = {
|
|
|
7753
7753
|
* **Prerequisites:**
|
|
7754
7754
|
* * Meeting host must have a Pro license.
|
|
7755
7755
|
*
|
|
7756
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
7756
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
7757
7757
|
*
|
|
7758
|
-
* **Granular Scopes:** `meeting:update:livestream_status`,`meeting:update:livestream_status:admin`
|
|
7758
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:livestream_status`,`meeting:update:livestream_status:admin`
|
|
7759
7759
|
*
|
|
7760
7760
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7761
7761
|
*/
|
|
@@ -7871,10 +7871,13 @@ type GetameetingsummaryResponse = {
|
|
|
7871
7871
|
* The summary overview.
|
|
7872
7872
|
*
|
|
7873
7873
|
* @example Meeting overview
|
|
7874
|
+
* @deprecated true
|
|
7874
7875
|
*/
|
|
7875
7876
|
summary_overview?: string;
|
|
7876
7877
|
/**
|
|
7877
7878
|
* The summary content details.
|
|
7879
|
+
*
|
|
7880
|
+
* @deprecated true
|
|
7878
7881
|
*/
|
|
7879
7882
|
summary_details?: {
|
|
7880
7883
|
/**
|
|
@@ -7892,8 +7895,15 @@ type GetameetingsummaryResponse = {
|
|
|
7892
7895
|
}[];
|
|
7893
7896
|
/**
|
|
7894
7897
|
* The next steps.
|
|
7898
|
+
*
|
|
7899
|
+
* @deprecated true
|
|
7895
7900
|
*/
|
|
7896
7901
|
next_steps?: string[];
|
|
7902
|
+
/**
|
|
7903
|
+
* The edited summary content.
|
|
7904
|
+
*
|
|
7905
|
+
* @deprecated true
|
|
7906
|
+
*/
|
|
7897
7907
|
edited_summary?: {
|
|
7898
7908
|
/**
|
|
7899
7909
|
* The user edited summary overview.
|
|
@@ -7912,6 +7922,64 @@ type GetameetingsummaryResponse = {
|
|
|
7912
7922
|
*/
|
|
7913
7923
|
next_steps?: string[];
|
|
7914
7924
|
};
|
|
7925
|
+
/**
|
|
7926
|
+
* The complete meeting summary in Markdown format. This unified field is used for all summaries. For compatibility, the legacy fields `summary_overview`, `summary_details`, `next_steps`, and `edited_summary` are still returned, but are deprecated and will not be supported in the future.
|
|
7927
|
+
*
|
|
7928
|
+
* @example ## Key takeaways
|
|
7929
|
+
- Mobile app performance issues are affecting user retention.
|
|
7930
|
+
- New onboarding flow received positive feedback from beta testers.
|
|
7931
|
+
- Need to prioritize accessibility improvements.
|
|
7932
|
+
- Customer support response time has improved by 25%.
|
|
7933
|
+
|
|
7934
|
+
## Discussed topics
|
|
7935
|
+
### Mobile App Performance
|
|
7936
|
+
Discussion of recent performance metrics and user complaints
|
|
7937
|
+
- **Details**
|
|
7938
|
+
- Sarah (Product): Reports of app crashes increased 15% this month
|
|
7939
|
+
- Mike (Engineering): Memory optimization needed in latest release
|
|
7940
|
+
- Tom (QA): Identified memory leak in photo upload feature
|
|
7941
|
+
- **Conclusion**
|
|
7942
|
+
- Implement performance monitoring tools
|
|
7943
|
+
- Prioritize memory optimization in next sprint
|
|
7944
|
+
|
|
7945
|
+
### Onboarding Flow
|
|
7946
|
+
Review of beta testing results for new user onboarding
|
|
7947
|
+
- **Details**
|
|
7948
|
+
- Rachel (UX): 90% completion rate in beta testing
|
|
7949
|
+
- David (Product): Positive feedback on simplified registration
|
|
7950
|
+
- **Conclusion**
|
|
7951
|
+
- Ready for full rollout next month
|
|
7952
|
+
- Need to monitor analytics post-launch
|
|
7953
|
+
|
|
7954
|
+
### Accessibility Compliance
|
|
7955
|
+
Discussion of current accessibility status and needed improvements
|
|
7956
|
+
- **Details**
|
|
7957
|
+
- Lisa (Design): Screen reader compatibility issues identified
|
|
7958
|
+
- John (Engineering): WCAG compliance at 80%
|
|
7959
|
+
- **Conclusion**
|
|
7960
|
+
- Create accessibility improvement roadmap
|
|
7961
|
+
- Schedule external audit
|
|
7962
|
+
|
|
7963
|
+
## Challenges
|
|
7964
|
+
* Resource constraints for performance optimization
|
|
7965
|
+
* Integration testing environment stability issues
|
|
7966
|
+
* Lack of accessibility expertise in the team
|
|
7967
|
+
|
|
7968
|
+
## Action items
|
|
7969
|
+
- **Sarah**
|
|
7970
|
+
- Prepare performance monitoring implementation plan
|
|
7971
|
+
- Schedule follow-up meeting with engineering team
|
|
7972
|
+
- **Mike**
|
|
7973
|
+
- Investigate memory leak fix
|
|
7974
|
+
- Document performance optimization guidelines
|
|
7975
|
+
- **Lisa**
|
|
7976
|
+
- Create accessibility improvement proposal
|
|
7977
|
+
- Research accessibility testing tools
|
|
7978
|
+
- **Rachel**
|
|
7979
|
+
- Prepare onboarding analytics dashboard
|
|
7980
|
+
- Document beta testing findings
|
|
7981
|
+
*/
|
|
7982
|
+
summary_content?: string;
|
|
7915
7983
|
};
|
|
7916
7984
|
type GetameetingsummaryVariables = {
|
|
7917
7985
|
pathParams: GetameetingsummaryPathParams;
|
|
@@ -7919,14 +7987,14 @@ type GetameetingsummaryVariables = {
|
|
|
7919
7987
|
/**
|
|
7920
7988
|
* Display information about a meeting summary.
|
|
7921
7989
|
*
|
|
7922
|
-
* **Prerequisites
|
|
7990
|
+
* **Prerequisites**
|
|
7923
7991
|
* * Host user type must have a Pro or higher plan.
|
|
7924
|
-
* * Enable the Meeting Summary with AI Companion feature in the host's account.
|
|
7992
|
+
* * Enable the **Meeting Summary with AI Companion** feature in the host's account.
|
|
7925
7993
|
* * E2ee meetings do not have summary feature enabled.
|
|
7926
7994
|
*
|
|
7927
|
-
* **Scopes:** `meeting_summary:read`,`meeting_summary:read:admin`
|
|
7995
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_summary:read`,`meeting_summary:read:admin`
|
|
7928
7996
|
*
|
|
7929
|
-
* **Granular Scopes:** `meeting:read:summary`,`meeting:read:summary:admin`
|
|
7997
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:summary`,`meeting:read:summary:admin`
|
|
7930
7998
|
*
|
|
7931
7999
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7932
8000
|
*/
|
|
@@ -7975,9 +8043,9 @@ type MeetingAppAddVariables = {
|
|
|
7975
8043
|
* * The meeting must not be a live meeting.
|
|
7976
8044
|
* * The **Zoom Apps Quick Launch Button** setting enabled in the Zoom web portal.
|
|
7977
8045
|
*
|
|
7978
|
-
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
8046
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
7979
8047
|
*
|
|
7980
|
-
* **Granular Scopes:** `meeting:write:open_app`,`meeting:write:open_app:admin`
|
|
8048
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:open_app`,`meeting:write:open_app:admin`
|
|
7981
8049
|
*
|
|
7982
8050
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7983
8051
|
*/
|
|
@@ -8004,9 +8072,9 @@ type MeetingAppDeleteVariables = {
|
|
|
8004
8072
|
* * The meeting must not be a live meeting.
|
|
8005
8073
|
* * The **Zoom Apps Quick Launch Button** setting enabled in the Zoom web portal.
|
|
8006
8074
|
*
|
|
8007
|
-
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
8075
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
8008
8076
|
*
|
|
8009
|
-
* **Granular Scopes:** `meeting:delete:open_app`,`meeting:delete:open_app:admin`
|
|
8077
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:open_app`,`meeting:delete:open_app:admin`
|
|
8010
8078
|
*
|
|
8011
8079
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
8012
8080
|
*/
|
|
@@ -8251,9 +8319,9 @@ type MeetingPollsVariables = {
|
|
|
8251
8319
|
* * Host user type must be **Pro** or higher plan.
|
|
8252
8320
|
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
8253
8321
|
*
|
|
8254
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
8322
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
8255
8323
|
*
|
|
8256
|
-
* **Granular Scopes:** `meeting:read:list_polls`,`meeting:read:list_polls:admin`
|
|
8324
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_polls`,`meeting:read:list_polls:admin`
|
|
8257
8325
|
*
|
|
8258
8326
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
8259
8327
|
*/
|
|
@@ -8653,9 +8721,9 @@ type MeetingPollCreateVariables = {
|
|
|
8653
8721
|
* * Polling feature must be enabled in the host's account.
|
|
8654
8722
|
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
8655
8723
|
*
|
|
8656
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
8724
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
8657
8725
|
*
|
|
8658
|
-
* **Granular Scopes:** `meeting:write:poll`,`meeting:write:poll:admin`
|
|
8726
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:poll`,`meeting:write:poll:admin`
|
|
8659
8727
|
*
|
|
8660
8728
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
8661
8729
|
*/
|
|
@@ -8881,9 +8949,9 @@ type MeetingPollGetVariables = {
|
|
|
8881
8949
|
* * Host must have Pro or higher plan.
|
|
8882
8950
|
* * Enable the **Meeting Polls/Quizzes** setting in the Zoom web portal.
|
|
8883
8951
|
*
|
|
8884
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
8952
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
8885
8953
|
*
|
|
8886
|
-
* **Granular Scopes:** `meeting:read:poll`,`meeting:read:poll:admin`
|
|
8954
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:poll`,`meeting:read:poll:admin`
|
|
8887
8955
|
*
|
|
8888
8956
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
8889
8957
|
*/
|
|
@@ -9094,9 +9162,9 @@ type MeetingPollUpdateVariables = {
|
|
|
9094
9162
|
* * The **Meeting Polls/Quizzes** setting enabled in the Zoom web portal.
|
|
9095
9163
|
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
9096
9164
|
*
|
|
9097
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
9165
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
9098
9166
|
*
|
|
9099
|
-
* **Granular Scopes:** `meeting:update:poll`,`meeting:update:poll:admin`
|
|
9167
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:poll`,`meeting:update:poll:admin`
|
|
9100
9168
|
*
|
|
9101
9169
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9102
9170
|
*/
|
|
@@ -9131,9 +9199,9 @@ type MeetingPollDeleteVariables = {
|
|
|
9131
9199
|
* * Polling feature should be enabled in the host's account.
|
|
9132
9200
|
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
9133
9201
|
*
|
|
9134
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
9202
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
9135
9203
|
*
|
|
9136
|
-
* **Granular Scopes:** `meeting:delete:poll`,`meeting:delete:poll:admin`
|
|
9204
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:poll`,`meeting:delete:poll:admin`
|
|
9137
9205
|
*
|
|
9138
9206
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9139
9207
|
*/
|
|
@@ -9413,9 +9481,9 @@ type MeetingRegistrantsVariables = {
|
|
|
9413
9481
|
* * Host user type must be **Pro** or higher plan.
|
|
9414
9482
|
* * Registration must be enabled for the meeting.
|
|
9415
9483
|
*
|
|
9416
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
9484
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
9417
9485
|
*
|
|
9418
|
-
* **Granular Scopes:** `meeting:read:list_registrants`,`meeting:read:list_registrants:admin`
|
|
9486
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_registrants`,`meeting:read:list_registrants:admin`
|
|
9419
9487
|
*
|
|
9420
9488
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
9421
9489
|
*/
|
|
@@ -9690,9 +9758,9 @@ type MeetingRegistrantCreateVariables = {
|
|
|
9690
9758
|
* **Prerequisites:**
|
|
9691
9759
|
* * The host must be a **Licensed** user type.
|
|
9692
9760
|
*
|
|
9693
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
9761
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
9694
9762
|
*
|
|
9695
|
-
* **Granular Scopes:** `meeting:write:registrant`,`meeting:write:registrant:admin`
|
|
9763
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:registrant`,`meeting:write:registrant:admin`
|
|
9696
9764
|
*
|
|
9697
9765
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9698
9766
|
*/
|
|
@@ -9765,9 +9833,9 @@ type MeetingRegistrantsQuestionsGetVariables = {
|
|
|
9765
9833
|
* * Host user type must be **Pro** or higher plan.
|
|
9766
9834
|
* * Registration must be enabled for the meeting.
|
|
9767
9835
|
*
|
|
9768
|
-
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
9836
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
9769
9837
|
*
|
|
9770
|
-
* **Granular Scopes:** `meeting:read:list_registration_questions`,`meeting:read:list_registration_questions:admin`
|
|
9838
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_registration_questions`,`meeting:read:list_registration_questions:admin`
|
|
9771
9839
|
*
|
|
9772
9840
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9773
9841
|
*/
|
|
@@ -9841,9 +9909,9 @@ type MeetingRegistrantQuestionUpdateVariables = {
|
|
|
9841
9909
|
* * Host user type must be **Pro** or higher plan.
|
|
9842
9910
|
* * Registration must be enabled for the meeting.
|
|
9843
9911
|
*
|
|
9844
|
-
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
9912
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
9845
9913
|
*
|
|
9846
|
-
* **Granular Scopes:** `meeting:update:registration_question`,`meeting:update:registration_question:admin`
|
|
9914
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:registration_question`,`meeting:update:registration_question:admin`
|
|
9847
9915
|
*
|
|
9848
9916
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9849
9917
|
*/
|
|
@@ -9906,9 +9974,9 @@ type MeetingRegistrantStatusVariables = {
|
|
|
9906
9974
|
* * Host user type must be **Pro** or higher plan.
|
|
9907
9975
|
* * Registration must be enabled for the meeting.
|
|
9908
9976
|
*
|
|
9909
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
9977
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
9910
9978
|
*
|
|
9911
|
-
* **Granular Scopes:** `meeting:update:registrant_status`,`meeting:update:registrant_status:admin`
|
|
9979
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:registrant_status`,`meeting:update:registrant_status:admin`
|
|
9912
9980
|
*
|
|
9913
9981
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
9914
9982
|
*/
|
|
@@ -10112,9 +10180,9 @@ type MeetingRegistrantGetVariables = {
|
|
|
10112
10180
|
* **Prerequisites:**
|
|
10113
10181
|
* * The account must have a Meeting plan
|
|
10114
10182
|
*
|
|
10115
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
10183
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
10116
10184
|
*
|
|
10117
|
-
* **Granular Scopes:** `meeting:read:registrant`,`meeting:read:registrant:admin`
|
|
10185
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:registrant`,`meeting:read:registrant:admin`
|
|
10118
10186
|
*
|
|
10119
10187
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10120
10188
|
*/
|
|
@@ -10156,9 +10224,9 @@ type MeetingregistrantdeleteVariables = {
|
|
|
10156
10224
|
* * The `registration_type` must be 2 or 3 to require the `occurrence_id` field.
|
|
10157
10225
|
* * If the `registration_type` is 1, the `occurrence_id` is not needed, as registrants can attend any occurrence.
|
|
10158
10226
|
*
|
|
10159
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
10227
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
10160
10228
|
*
|
|
10161
|
-
* **Granular Scopes:** `meeting:delete:registrant`,`meeting:delete:registrant:admin`
|
|
10229
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:registrant`,`meeting:delete:registrant:admin`
|
|
10162
10230
|
*
|
|
10163
10231
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10164
10232
|
*/
|
|
@@ -10220,9 +10288,9 @@ type GetSipDialingWithPasscodeVariables = {
|
|
|
10220
10288
|
* **Prerequisites**:
|
|
10221
10289
|
* * The SIP URI is valid for 2 hours, or 7200 seconds, by default. After this period, the URI will expire and the API must be called again to retrieve a new one.
|
|
10222
10290
|
*
|
|
10223
|
-
* **Scopes:** `meeting:write:sip_dialing`,`meeting:write:admin:sip_dialing`
|
|
10291
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:sip_dialing`,`meeting:write:admin:sip_dialing`
|
|
10224
10292
|
*
|
|
10225
|
-
* **Granular Scopes:** `meeting:write:sip_dialing`,`meeting:write:sip_dialing:admin`
|
|
10293
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:sip_dialing`,`meeting:write:sip_dialing:admin`
|
|
10226
10294
|
*
|
|
10227
10295
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
10228
10296
|
*/
|
|
@@ -10259,9 +10327,9 @@ type MeetingStatusVariables = {
|
|
|
10259
10327
|
* **Prerequisites**:
|
|
10260
10328
|
* * Host user must have a Zoom Meetings Basic license or higher.
|
|
10261
10329
|
*
|
|
10262
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
10330
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
10263
10331
|
*
|
|
10264
|
-
* **Granular Scopes:** `meeting:update:status`,`meeting:update:status:admin`
|
|
10332
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:status`,`meeting:update:status:admin`
|
|
10265
10333
|
*
|
|
10266
10334
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10267
10335
|
*/
|
|
@@ -10478,9 +10546,9 @@ type MeetingSurveyGetVariables = {
|
|
|
10478
10546
|
/**
|
|
10479
10547
|
* Display information about a [meeting survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting). **Prerequisites:** * The host has a **Pro** license. * The [**Meeting Survey**](https://support.zoom.us/hc/en-us/articles/4404939095053-Enabling-meeting-surveys) feature is enabled on the host's account. * The meeting must be a scheduled meeting. Instant meetings do not have survey features enabled.
|
|
10480
10548
|
*
|
|
10481
|
-
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
10549
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
10482
10550
|
*
|
|
10483
|
-
* **Granular Scopes:** `meeting:read:survey`,`meeting:read:survey:admin`
|
|
10551
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:survey`,`meeting:read:survey:admin`
|
|
10484
10552
|
*
|
|
10485
10553
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10486
10554
|
*/
|
|
@@ -10508,9 +10576,9 @@ type MeetingSurveyDeleteVariables = {
|
|
|
10508
10576
|
* * The [**Meeting Survey**](https://support.zoom.us/hc/en-us/articles/4404939095053-Enabling-meeting-surveys) feature enabled in the host's account.
|
|
10509
10577
|
* * The meeting must be a scheduled meeting. Instant meetings do not have survey features enabled.
|
|
10510
10578
|
*
|
|
10511
|
-
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
10579
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
10512
10580
|
*
|
|
10513
|
-
* **Granular Scopes:** `meeting:delete:survey`,`meeting:delete:survey:admin`
|
|
10581
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:survey`,`meeting:delete:survey:admin`
|
|
10514
10582
|
*
|
|
10515
10583
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10516
10584
|
*/
|
|
@@ -10728,9 +10796,9 @@ type MeetingSurveyUpdateVariables = {
|
|
|
10728
10796
|
/**
|
|
10729
10797
|
* Update a [meeting survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting). **Prerequisites:** * The host must be a **Pro** user type. * The [**Meeting Survey**](https://support.zoom.us/hc/en-us/articles/4404939095053-Enabling-meeting-surveys) feature is enabled in the host's account. * The meeting must be a scheduled meeting. Instant meetings do not have survey features enabled.
|
|
10730
10798
|
*
|
|
10731
|
-
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
10799
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
10732
10800
|
*
|
|
10733
|
-
* **Granular Scopes:** `meeting:update:survey`,`meeting:update:survey:admin`
|
|
10801
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:survey`,`meeting:update:survey:admin`
|
|
10734
10802
|
*
|
|
10735
10803
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10736
10804
|
*/
|
|
@@ -10778,9 +10846,9 @@ type MeetingTokenVariables = {
|
|
|
10778
10846
|
* * The **Closed captioning** setting enabled in the Zoom web portal.
|
|
10779
10847
|
* * The **Allow use of caption API Token to integrate with third-party closed captioning services** setting enabled.
|
|
10780
10848
|
*
|
|
10781
|
-
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
10849
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
10782
10850
|
*
|
|
10783
|
-
* **Granular Scopes:** `meeting:read:token`,`meeting:read:token:admin`
|
|
10851
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:token`,`meeting:read:token:admin`
|
|
10784
10852
|
*
|
|
10785
10853
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10786
10854
|
*/
|
|
@@ -10903,9 +10971,9 @@ type PastMeetingDetailsVariables = {
|
|
|
10903
10971
|
* * The meeting must have ended before you can retrieve the data.
|
|
10904
10972
|
* * You cannot access a meeting that occurred more than one year ago.
|
|
10905
10973
|
*
|
|
10906
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
10974
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
10907
10975
|
*
|
|
10908
|
-
* **Granular Scopes:** `meeting:read:past_meeting`,`meeting:read:past_meeting:admin`
|
|
10976
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:past_meeting`,`meeting:read:past_meeting:admin`
|
|
10909
10977
|
*
|
|
10910
10978
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10911
10979
|
*/
|
|
@@ -10950,9 +11018,9 @@ type PastMeetingsVariables = {
|
|
|
10950
11018
|
* * The meeting must have already occurred at least once. This endpoint only returns instances of meetings that have ended.
|
|
10951
11019
|
* * You cannot retrieve instances for meetings that occurred more than 15 months ago.
|
|
10952
11020
|
*
|
|
10953
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
11021
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
10954
11022
|
*
|
|
10955
|
-
* **Granular Scopes:** `meeting:read:list_past_instances`,`meeting:read:list_past_instances:admin`
|
|
11023
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_past_instances`,`meeting:read:list_past_instances:admin`
|
|
10956
11024
|
*
|
|
10957
11025
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
10958
11026
|
*/
|
|
@@ -11105,9 +11173,9 @@ type PastMeetingParticipantsVariables = {
|
|
|
11105
11173
|
* **Note**: Please double encode your UUID when using this API if the UUID begins with a '/'or contains '//' in it.
|
|
11106
11174
|
*
|
|
11107
11175
|
*
|
|
11108
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
11176
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
11109
11177
|
*
|
|
11110
|
-
* **Granular Scopes:** `meeting:read:list_past_participants`,`meeting:read:list_past_participants:admin`
|
|
11178
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_past_participants`,`meeting:read:list_past_participants:admin`
|
|
11111
11179
|
*
|
|
11112
11180
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
11113
11181
|
*/
|
|
@@ -11197,9 +11265,9 @@ type ListPastMeetingPollsVariables = {
|
|
|
11197
11265
|
* * Host user type must be **Pro**.
|
|
11198
11266
|
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
11199
11267
|
*
|
|
11200
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
11268
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
11201
11269
|
*
|
|
11202
|
-
* **Granular Scopes:** `meeting:read:list_poll_results`,`meeting:read:list_poll_results:admin`
|
|
11270
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_poll_results`,`meeting:read:list_poll_results:admin`
|
|
11203
11271
|
*
|
|
11204
11272
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
11205
11273
|
*/
|
|
@@ -11276,9 +11344,9 @@ type ListPastMeetingQAVariables = {
|
|
|
11276
11344
|
* * The meeting must have ended before you can retrieve the data.
|
|
11277
11345
|
* * You cannot retrieve Q&A data for meetings that occurred more than 15 months ago.
|
|
11278
11346
|
*
|
|
11279
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
11347
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
11280
11348
|
*
|
|
11281
|
-
* **Granular Scopes:** `meeting:read:past_qa`,`meeting:read:past_qa:admin`
|
|
11349
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:past_qa`,`meeting:read:past_qa:admin`
|
|
11282
11350
|
*
|
|
11283
11351
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
11284
11352
|
*/
|
|
@@ -11333,9 +11401,9 @@ type ListMeetingTemplatesVariables = {
|
|
|
11333
11401
|
* **Prerequisites**:
|
|
11334
11402
|
* * Host user must have a Zoom Meetings Basic license or higher.
|
|
11335
11403
|
*
|
|
11336
|
-
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
11404
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
11337
11405
|
*
|
|
11338
|
-
* **Granular Scopes:** `meeting:read:list_templates`,`meeting:read:list_templates:admin`
|
|
11406
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_templates`,`meeting:read:list_templates:admin`
|
|
11339
11407
|
*
|
|
11340
11408
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
11341
11409
|
*/
|
|
@@ -11403,9 +11471,9 @@ type MeetingTemplateCreateVariables = {
|
|
|
11403
11471
|
* * Host user must have a Zoom Meetings Basic license or higher.
|
|
11404
11472
|
* * You can only create up to 40 meeting templates.
|
|
11405
11473
|
*
|
|
11406
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
11474
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
11407
11475
|
*
|
|
11408
|
-
* **Granular Scopes:** `meeting:write:template`,`meeting:write:template:admin`
|
|
11476
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:template`,`meeting:write:template:admin`
|
|
11409
11477
|
*
|
|
11410
11478
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
11411
11479
|
*/
|
|
@@ -11602,9 +11670,9 @@ type MeetingsVariables = {
|
|
|
11602
11670
|
* * This API only returns a user's [unexpired meetings](https://support.zoom.us/hc/en-us/articles/201362373-Meeting-ID#h_c73f9b08-c1c0-4a1a-b538-e01ebb98e844).
|
|
11603
11671
|
* * When `type` is set to `upcoming`, `upcoming_meetings`, or `previous_meetings`, only a maximum of 6 months of meeting data will be returned.
|
|
11604
11672
|
*
|
|
11605
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
11673
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
11606
11674
|
*
|
|
11607
|
-
* **Granular Scopes:** `meeting:read:list_meetings`,`meeting:read:list_meetings:admin`
|
|
11675
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_meetings`,`meeting:read:list_meetings:admin`
|
|
11608
11676
|
*
|
|
11609
11677
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
11610
11678
|
*/
|
|
@@ -13542,9 +13610,9 @@ type MeetingCreateVariables = {
|
|
|
13542
13610
|
* * For security reasons, the recommended way to programmatically get the updated `start_url` value after expiry is to call the [**Get a meeting**](/docs/api/meetings/#tag/meetings/GET/meetings/{meetingId}) API. Refer to the `start_url` value in the response.
|
|
13543
13611
|
* * **100 requests per day**. The rate limit is applied against the `userId` of the **meeting host** used to make the request.
|
|
13544
13612
|
*
|
|
13545
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
13613
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
13546
13614
|
*
|
|
13547
|
-
* **Granular Scopes:** `meeting:write:meeting`,`meeting:write:meeting:admin`
|
|
13615
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:meeting`,`meeting:write:meeting:admin`
|
|
13548
13616
|
*
|
|
13549
13617
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
13550
13618
|
*/
|
|
@@ -13651,9 +13719,9 @@ type ListUpcomingMeetingVariables = {
|
|
|
13651
13719
|
* **Prerequisites**:
|
|
13652
13720
|
* * To retrieve data for Zoom meetings that the user has been invited to from a third-party calendar (Google, Exchange, Office 365, Apple iCloud), the [**Calendar and Contacts Integration**](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0069503) must be enabled in the Zoom Web Portal.
|
|
13653
13721
|
*
|
|
13654
|
-
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
13722
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
13655
13723
|
*
|
|
13656
|
-
* **Granular Scopes:** `meeting:read:list_upcoming_meetings`,`meeting:read:list_upcoming_meetings:admin`
|
|
13724
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_upcoming_meetings`,`meeting:read:list_upcoming_meetings:admin`
|
|
13657
13725
|
*
|
|
13658
13726
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
13659
13727
|
*/
|
|
@@ -13741,9 +13809,9 @@ type UserPACsVariables = {
|
|
|
13741
13809
|
* * A Pro or higher plan with an [Audio Conferencing](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) subscription.
|
|
13742
13810
|
* * The [**Personal Audio Conference**](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference#h_01F5BPM447M6QDJXX50RSFXKJ3) setting enabled in the user's profile.
|
|
13743
13811
|
*
|
|
13744
|
-
* **Scopes:** `pac:read:admin`,`pac:read`
|
|
13812
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `pac:read:admin`,`pac:read`
|
|
13745
13813
|
*
|
|
13746
|
-
* **Granular Scopes:** `pac:read:list_pac_accounts`,`pac:read:list_pac_accounts:admin`
|
|
13814
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `pac:read:list_pac_accounts`,`pac:read:list_pac_accounts:admin`
|
|
13747
13815
|
*
|
|
13748
13816
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
13749
13817
|
*/
|
|
@@ -13860,9 +13928,9 @@ type ReportSignInSignOutActivitiesVariables = {
|
|
|
13860
13928
|
*
|
|
13861
13929
|
*
|
|
13862
13930
|
*
|
|
13863
|
-
* **Scopes:** `report:read:admin`
|
|
13931
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
13864
13932
|
*
|
|
13865
|
-
* **Granular Scopes:** `report:read:user_activities:admin`
|
|
13933
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:user_activities:admin`
|
|
13866
13934
|
*
|
|
13867
13935
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
13868
13936
|
*/
|
|
@@ -13931,9 +13999,9 @@ type GetBillingReportVariables = FetcherExtraProps;
|
|
|
13931
13999
|
*
|
|
13932
14000
|
*
|
|
13933
14001
|
*
|
|
13934
|
-
* **Scopes:** `report:read:admin`
|
|
14002
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
13935
14003
|
*
|
|
13936
|
-
* **Granular Scopes:** `report:read:billing:admin`
|
|
14004
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:billing:admin`
|
|
13937
14005
|
*
|
|
13938
14006
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
13939
14007
|
*/
|
|
@@ -14013,9 +14081,9 @@ type GetBillingInvoicesReportsVariables = {
|
|
|
14013
14081
|
*
|
|
14014
14082
|
*
|
|
14015
14083
|
*
|
|
14016
|
-
* **Scopes:** `report:read:admin`
|
|
14084
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
14017
14085
|
*
|
|
14018
|
-
* **Granular Scopes:** `report:read:billing_invoice:admin`
|
|
14086
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:billing_invoice:admin`
|
|
14019
14087
|
*
|
|
14020
14088
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
14021
14089
|
*/
|
|
@@ -14103,7 +14171,7 @@ type ReportCloudRecordingVariables = {
|
|
|
14103
14171
|
*
|
|
14104
14172
|
*
|
|
14105
14173
|
*
|
|
14106
|
-
* **Scopes:** `report:read:admin`
|
|
14174
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
14107
14175
|
*
|
|
14108
14176
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
14109
14177
|
*/
|
|
@@ -14193,7 +14261,7 @@ type ReportDailyVariables = {
|
|
|
14193
14261
|
*
|
|
14194
14262
|
*
|
|
14195
14263
|
*
|
|
14196
|
-
* **Scopes:** `report:read:admin`
|
|
14264
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
14197
14265
|
*
|
|
14198
14266
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
14199
14267
|
*/
|
|
@@ -14620,9 +14688,9 @@ type GethistorymeetingandwebinarlistVariables = {
|
|
|
14620
14688
|
/**
|
|
14621
14689
|
* Retrieve a list of history meetings and webinars.
|
|
14622
14690
|
*
|
|
14623
|
-
* **Scopes:** `report:read:admin`
|
|
14691
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
14624
14692
|
*
|
|
14625
|
-
* **Granular Scopes:** `report:read:list_history_meetings:admin`
|
|
14693
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_history_meetings:admin`
|
|
14626
14694
|
*
|
|
14627
14695
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
14628
14696
|
*/
|
|
@@ -14757,9 +14825,9 @@ type ReportMeetingactivitylogsVariables = {
|
|
|
14757
14825
|
/**
|
|
14758
14826
|
* Retrieve a list of a meeting activity logs. Contact Zoom Support to enable the meeting audit trail log feature on your account.
|
|
14759
14827
|
*
|
|
14760
|
-
* **Scopes:** `report:read:admin`
|
|
14828
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
14761
14829
|
*
|
|
14762
|
-
* **Granular Scopes:** `report:read:meeting_activity_log:admin`
|
|
14830
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:meeting_activity_log:admin`
|
|
14763
14831
|
*
|
|
14764
14832
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
14765
14833
|
*/
|
|
@@ -14902,9 +14970,9 @@ type ReportMeetingDetailsVariables = {
|
|
|
14902
14970
|
*
|
|
14903
14971
|
*
|
|
14904
14972
|
*
|
|
14905
|
-
* **Scopes:** `report:read:admin`
|
|
14973
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
14906
14974
|
*
|
|
14907
|
-
* **Granular Scopes:** `report:read:meeting:admin`
|
|
14975
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:meeting:admin`
|
|
14908
14976
|
*
|
|
14909
14977
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
14910
14978
|
*/
|
|
@@ -15082,9 +15150,9 @@ type ReportMeetingParticipantsVariables = {
|
|
|
15082
15150
|
* **Prerequisites:**
|
|
15083
15151
|
* * A Pro or a higher plan.
|
|
15084
15152
|
*
|
|
15085
|
-
* **Scopes:** `report:read:admin`
|
|
15153
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
15086
15154
|
*
|
|
15087
|
-
* **Granular Scopes:** `report:read:list_meeting_participants:admin`
|
|
15155
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_meeting_participants:admin`
|
|
15088
15156
|
*
|
|
15089
15157
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
15090
15158
|
*/
|
|
@@ -15188,9 +15256,9 @@ type ReportMeetingPollsVariables = {
|
|
|
15188
15256
|
* **Prerequisites:**
|
|
15189
15257
|
* * A Pro or a higher plan.
|
|
15190
15258
|
*
|
|
15191
|
-
* **Scopes:** `report:read:admin`
|
|
15259
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
15192
15260
|
*
|
|
15193
|
-
* **Granular Scopes:** `report:read:list_meeting_polls:admin`
|
|
15261
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_meeting_polls:admin`
|
|
15194
15262
|
*
|
|
15195
15263
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
15196
15264
|
*/
|
|
@@ -15346,9 +15414,9 @@ type ReportMeetingQAVariables = {
|
|
|
15346
15414
|
*
|
|
15347
15415
|
* * Pro plan or higher.
|
|
15348
15416
|
*
|
|
15349
|
-
* **Scopes:** `report:read:admin`
|
|
15417
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
15350
15418
|
*
|
|
15351
|
-
* **Granular Scopes:** `report:read:meeting_qna:admin`
|
|
15419
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:meeting_qna:admin`
|
|
15352
15420
|
*
|
|
15353
15421
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
15354
15422
|
*/
|
|
@@ -15466,9 +15534,9 @@ type ReportMeetingSurveyVariables = {
|
|
|
15466
15534
|
*
|
|
15467
15535
|
* * Pro or a higher plan.
|
|
15468
15536
|
*
|
|
15469
|
-
* **Scopes:** `report:read:admin`
|
|
15537
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
15470
15538
|
*
|
|
15471
|
-
* **Granular Scopes:** `report:read:meeting_survey:admin`
|
|
15539
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:meeting_survey:admin`
|
|
15472
15540
|
*
|
|
15473
15541
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
15474
15542
|
*/
|
|
@@ -15589,9 +15657,9 @@ type ReportOperationLogsVariables = {
|
|
|
15589
15657
|
*
|
|
15590
15658
|
* * Pro or higher plan.
|
|
15591
15659
|
*
|
|
15592
|
-
* **Scopes:** `report:read:admin`
|
|
15660
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
15593
15661
|
*
|
|
15594
|
-
* **Granular Scopes:** `report:read:operation_logs:admin`
|
|
15662
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:operation_logs:admin`
|
|
15595
15663
|
*
|
|
15596
15664
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
15597
15665
|
*/
|
|
@@ -15822,9 +15890,9 @@ type ReportTelephoneVariables = {
|
|
|
15822
15890
|
*
|
|
15823
15891
|
* * Pro or higher plan.
|
|
15824
15892
|
*
|
|
15825
|
-
* **Scopes:** `report:read:admin`
|
|
15893
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
15826
15894
|
*
|
|
15827
|
-
* **Granular Scopes:** `report:read:telephone:admin`
|
|
15895
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:telephone:admin`
|
|
15828
15896
|
*
|
|
15829
15897
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
15830
15898
|
*/
|
|
@@ -15960,9 +16028,9 @@ type ReportUpcomingEventsVariables = {
|
|
|
15960
16028
|
* **Prerequisites:**
|
|
15961
16029
|
* * A Pro or higher plan
|
|
15962
16030
|
*
|
|
15963
|
-
* **Scopes:** `report:read:admin`
|
|
16031
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
15964
16032
|
*
|
|
15965
|
-
* **Granular Scopes:** `report:read:upcoming_meetings_webinars:admin`
|
|
16033
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:upcoming_meetings_webinars:admin`
|
|
15966
16034
|
*
|
|
15967
16035
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
15968
16036
|
*/
|
|
@@ -16191,9 +16259,9 @@ type ReportUsersVariables = {
|
|
|
16191
16259
|
*
|
|
16192
16260
|
* * Pro or higher plan.
|
|
16193
16261
|
*
|
|
16194
|
-
* **Scopes:** `report:read:admin`
|
|
16262
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
16195
16263
|
*
|
|
16196
|
-
* **Granular Scopes:** `report:read:list_users:admin`
|
|
16264
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_users:admin`
|
|
16197
16265
|
*
|
|
16198
16266
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
16199
16267
|
*/
|
|
@@ -16499,9 +16567,9 @@ type ReportMeetingsVariables = {
|
|
|
16499
16567
|
*
|
|
16500
16568
|
* * Pro or higher plan.
|
|
16501
16569
|
*
|
|
16502
|
-
* **Scopes:** `report:read:admin`
|
|
16570
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
16503
16571
|
*
|
|
16504
|
-
* **Granular Scopes:** `report:read:user:admin`
|
|
16572
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:user:admin`
|
|
16505
16573
|
*
|
|
16506
16574
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
16507
16575
|
*/
|
|
@@ -16645,9 +16713,9 @@ type ReportWebinarDetailsVariables = {
|
|
|
16645
16713
|
*
|
|
16646
16714
|
* * Pro or higher plan with Webinar add-on.
|
|
16647
16715
|
*
|
|
16648
|
-
* **Scopes:** `report:read:admin`
|
|
16716
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
16649
16717
|
*
|
|
16650
|
-
* **Granular Scopes:** `report:read:webinar:admin`
|
|
16718
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:webinar:admin`
|
|
16651
16719
|
*
|
|
16652
16720
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
16653
16721
|
*/
|
|
@@ -16819,9 +16887,9 @@ type ReportWebinarParticipantsVariables = {
|
|
|
16819
16887
|
* **Prerequisites:**
|
|
16820
16888
|
* * A Pro or a higher plan with Webinar add-on enabled.
|
|
16821
16889
|
*
|
|
16822
|
-
* **Scopes:** `report:read:admin`
|
|
16890
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
16823
16891
|
*
|
|
16824
|
-
* **Granular Scopes:** `report:read:list_webinar_participants:admin`
|
|
16892
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_webinar_participants:admin`
|
|
16825
16893
|
*
|
|
16826
16894
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
16827
16895
|
*/
|
|
@@ -16929,9 +16997,9 @@ type ReportWebinarPollsVariables = {
|
|
|
16929
16997
|
*
|
|
16930
16998
|
* * Pro or a higher plan with Webinar add-on enabled.
|
|
16931
16999
|
*
|
|
16932
|
-
* **Scopes:** `report:read:admin`
|
|
17000
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
16933
17001
|
*
|
|
16934
|
-
* **Granular Scopes:** `report:read:list_webinar_polls:admin`
|
|
17002
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_webinar_polls:admin`
|
|
16935
17003
|
*
|
|
16936
17004
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
16937
17005
|
*/
|
|
@@ -17089,9 +17157,9 @@ type ReportWebinarQAVariables = {
|
|
|
17089
17157
|
*
|
|
17090
17158
|
* * Pro or a higher plan with the Webinar add-on enabled.
|
|
17091
17159
|
*
|
|
17092
|
-
* **Scopes:** `report:read:admin`
|
|
17160
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
17093
17161
|
*
|
|
17094
|
-
* **Granular Scopes:** `report:read:webinar_qna:admin`
|
|
17162
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:webinar_qna:admin`
|
|
17095
17163
|
*
|
|
17096
17164
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
17097
17165
|
*/
|
|
@@ -17211,9 +17279,9 @@ type ReportWebinarSurveyVariables = {
|
|
|
17211
17279
|
*
|
|
17212
17280
|
* * Pro or a higher plan with Webinar add-on enabled.
|
|
17213
17281
|
*
|
|
17214
|
-
* **Scopes:** `report:read:admin`
|
|
17282
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
17215
17283
|
*
|
|
17216
|
-
* **Granular Scopes:** `report:read:webinar_survey:admin`
|
|
17284
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:webinar_survey:admin`
|
|
17217
17285
|
*
|
|
17218
17286
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
17219
17287
|
*/
|
|
@@ -17400,9 +17468,9 @@ type ListSipPhonesVariables = {
|
|
|
17400
17468
|
* * User must enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.
|
|
17401
17469
|
*
|
|
17402
17470
|
*
|
|
17403
|
-
* **Scopes:** `sip_phone:read:admin`
|
|
17471
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:read:admin`
|
|
17404
17472
|
*
|
|
17405
|
-
* **Granular Scopes:** `sip_phone:read:list_sip_phones:admin`
|
|
17473
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:read:list_sip_phones:admin`
|
|
17406
17474
|
*
|
|
17407
17475
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
17408
17476
|
*/
|
|
@@ -17648,9 +17716,9 @@ type CreateSIPPhoneVariables = {
|
|
|
17648
17716
|
* * The account owner or account admin must first enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.
|
|
17649
17717
|
*
|
|
17650
17718
|
*
|
|
17651
|
-
* **Scopes:** `sip_phone:write:admin`
|
|
17719
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin`
|
|
17652
17720
|
*
|
|
17653
|
-
* **Granular Scopes:** `sip_phone:write:sip_phone:admin`
|
|
17721
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:sip_phone:admin`
|
|
17654
17722
|
*
|
|
17655
17723
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
17656
17724
|
*/
|
|
@@ -17746,6 +17814,13 @@ type ListSIPPhonePhonesResponse = {
|
|
|
17746
17814
|
* @example 4000
|
|
17747
17815
|
*/
|
|
17748
17816
|
voice_mail?: string;
|
|
17817
|
+
/**
|
|
17818
|
+
* The displayed phone number associated with the user can be either in extension format or E.164 format. You can specify the displayed number when the dialable number differs from the SIP username.
|
|
17819
|
+
*
|
|
17820
|
+
* @maxLength 64
|
|
17821
|
+
* @example 5551110105
|
|
17822
|
+
*/
|
|
17823
|
+
display_number?: string;
|
|
17749
17824
|
/**
|
|
17750
17825
|
* Defined a set of basic components of SIP network architecture, including proxy_server, register_server and transport_protocol.
|
|
17751
17826
|
*/
|
|
@@ -17833,9 +17908,9 @@ type ListSIPPhonePhonesVariables = {
|
|
|
17833
17908
|
* * User must enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.
|
|
17834
17909
|
*
|
|
17835
17910
|
*
|
|
17836
|
-
* **Scopes:** `sip_phone:read:admin`
|
|
17911
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:read:admin`
|
|
17837
17912
|
*
|
|
17838
|
-
* **Granular Scopes:** `sip_phone:read:list_sip_phones:admin`
|
|
17913
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:read:list_sip_phones:admin`
|
|
17839
17914
|
*
|
|
17840
17915
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
17841
17916
|
*/
|
|
@@ -17899,6 +17974,13 @@ type EnableSIPPhonePhonesResponse = {
|
|
|
17899
17974
|
* @example 4000
|
|
17900
17975
|
*/
|
|
17901
17976
|
voice_mail?: string;
|
|
17977
|
+
/**
|
|
17978
|
+
* The displayed phone number associated with the user can be either in extension format or E.164 format. You can specify the displayed number when the dialable number differs from the SIP username.
|
|
17979
|
+
*
|
|
17980
|
+
* @maxLength 64
|
|
17981
|
+
* @example 5551110105
|
|
17982
|
+
*/
|
|
17983
|
+
display_number?: string;
|
|
17902
17984
|
/**
|
|
17903
17985
|
* Defined a set of basic components of SIP network architecture, including proxy_server, register_server and transport_protocol.
|
|
17904
17986
|
*/
|
|
@@ -18024,6 +18106,13 @@ type EnableSIPPhonePhonesRequestBody = {
|
|
|
18024
18106
|
* @example 4000
|
|
18025
18107
|
*/
|
|
18026
18108
|
voice_mail?: string;
|
|
18109
|
+
/**
|
|
18110
|
+
* The displayed phone number associated with the user can be either in extension format or E.164 format. You can specify the displayed number when the dialable number differs from the SIP username.
|
|
18111
|
+
*
|
|
18112
|
+
* @maxLength 64
|
|
18113
|
+
* @example 5551110105
|
|
18114
|
+
*/
|
|
18115
|
+
display_number?: string;
|
|
18027
18116
|
/**
|
|
18028
18117
|
* Defined a set of basic components of SIP network architecture, including proxy_server, register_server and transport_protocol.
|
|
18029
18118
|
*/
|
|
@@ -18111,9 +18200,9 @@ type EnableSIPPhonePhonesVariables = {
|
|
|
18111
18200
|
* * The account owner or account admin must first enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.
|
|
18112
18201
|
*
|
|
18113
18202
|
*
|
|
18114
|
-
* **Scopes:** `sip_phone:write:admin`
|
|
18203
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin`
|
|
18115
18204
|
*
|
|
18116
|
-
* **Granular Scopes:** `sip_phone:write:sip_phone:admin`
|
|
18205
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:sip_phone:admin`
|
|
18117
18206
|
*
|
|
18118
18207
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18119
18208
|
*/
|
|
@@ -18137,9 +18226,9 @@ type DeleteSIPPhonePhonesVariables = {
|
|
|
18137
18226
|
* * Currently only supported on Cisco and Avaya PBX systems.
|
|
18138
18227
|
* * The user must enable **SIP Phone Integration** by contacting the [Zoom Sales](https://zoom.us/contactsales) team.
|
|
18139
18228
|
*
|
|
18140
|
-
* **Scopes:** `sip_phone:write:admin`
|
|
18229
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin`
|
|
18141
18230
|
*
|
|
18142
|
-
* **Granular Scopes:** `sip_phone:delete:sip_phone:admin`
|
|
18231
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:delete:sip_phone:admin`
|
|
18143
18232
|
*
|
|
18144
18233
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18145
18234
|
*/
|
|
@@ -18198,72 +18287,79 @@ type UpdateSIPPhonePhonesRequestBody = {
|
|
|
18198
18287
|
*/
|
|
18199
18288
|
voice_mail?: string;
|
|
18200
18289
|
/**
|
|
18201
|
-
*
|
|
18290
|
+
* The displayed phone number associated with the user can be either in extension format or E.164 format. You can specify the displayed number when the dialable number differs from the SIP username.
|
|
18291
|
+
*
|
|
18292
|
+
* @maxLength 64
|
|
18293
|
+
* @example 5551110105
|
|
18294
|
+
*/
|
|
18295
|
+
display_number?: string;
|
|
18296
|
+
/**
|
|
18297
|
+
* Defined a set of basic components of SIP network architecture, including proxy_server, register_server and transport_protocol.
|
|
18202
18298
|
*/
|
|
18203
18299
|
server?: {
|
|
18204
18300
|
/**
|
|
18205
|
-
* The IP address of the proxy server for SIP requests.
|
|
18301
|
+
* The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server.
|
|
18206
18302
|
*
|
|
18207
18303
|
* @example 192.0.2.2
|
|
18208
18304
|
*/
|
|
18209
18305
|
proxy_server?: string;
|
|
18210
18306
|
/**
|
|
18211
|
-
* The IP address of the server that accepts REGISTER requests.
|
|
18307
|
+
* The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address.
|
|
18212
18308
|
*
|
|
18213
18309
|
* @example 192.0.2.2
|
|
18214
18310
|
*/
|
|
18215
18311
|
register_server?: string;
|
|
18216
18312
|
/**
|
|
18217
18313
|
* Protocols supported by the SIP provider.
|
|
18218
|
-
*
|
|
18314
|
+
* The value must be either `UDP`, `TCP`, `TLS`, `AUTO`.
|
|
18219
18315
|
*
|
|
18220
18316
|
* @example UDP
|
|
18221
18317
|
*/
|
|
18222
18318
|
transport_protocol?: 'UDP' | 'TCP' | 'TLS' | 'AUTO';
|
|
18223
18319
|
};
|
|
18224
18320
|
/**
|
|
18225
|
-
* Defined a set of basic components of SIP network architecture, including
|
|
18321
|
+
* Defined a set of basic components of SIP network architecture, including proxy_server, register_server and transport_protocol.
|
|
18226
18322
|
*/
|
|
18227
18323
|
server_2?: {
|
|
18228
18324
|
/**
|
|
18229
|
-
* The IP address of the proxy server for SIP requests.
|
|
18325
|
+
* The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server.
|
|
18230
18326
|
*
|
|
18231
18327
|
* @example 192.0.2.2
|
|
18232
18328
|
*/
|
|
18233
18329
|
proxy_server?: string;
|
|
18234
18330
|
/**
|
|
18235
|
-
* The IP address of the server that accepts REGISTER requests.
|
|
18331
|
+
* The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address.
|
|
18236
18332
|
*
|
|
18237
18333
|
* @example 192.0.2.2
|
|
18238
18334
|
*/
|
|
18239
18335
|
register_server?: string;
|
|
18240
18336
|
/**
|
|
18241
18337
|
* Protocols supported by the SIP provider.
|
|
18242
|
-
*
|
|
18338
|
+
* The value must be either `UDP`, `TCP`, `TLS`, `AUTO`.
|
|
18243
18339
|
*
|
|
18244
18340
|
* @example UDP
|
|
18245
18341
|
*/
|
|
18246
18342
|
transport_protocol?: 'UDP' | 'TCP' | 'TLS' | 'AUTO';
|
|
18247
18343
|
};
|
|
18248
18344
|
/**
|
|
18249
|
-
* Defined a set of basic components of SIP network architecture, including
|
|
18345
|
+
* Defined a set of basic components of SIP network architecture, including proxy_server, register_server and transport_protocol.
|
|
18250
18346
|
*/
|
|
18251
18347
|
server_3?: {
|
|
18252
18348
|
/**
|
|
18253
|
-
* The IP address of the proxy server for SIP requests.
|
|
18349
|
+
* The IP address of the proxy server for SIP requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address. If you are not using a proxy server, this value can be the same as the Register Server.
|
|
18254
18350
|
*
|
|
18255
18351
|
* @example 192.0.2.2
|
|
18256
18352
|
*/
|
|
18257
18353
|
proxy_server?: string;
|
|
18258
18354
|
/**
|
|
18259
|
-
* The IP address of the server that accepts REGISTER requests.
|
|
18355
|
+
* The IP address of the server that accepts REGISTER requests. Note that if you are using the UDP transport protocol, the default port is 5060. If you are using UDP with a different port number, that port number must be included with the IP address.
|
|
18260
18356
|
*
|
|
18261
18357
|
* @example 192.0.2.2
|
|
18262
18358
|
*/
|
|
18263
18359
|
register_server?: string;
|
|
18264
18360
|
/**
|
|
18265
18361
|
* Protocols supported by the SIP provider.
|
|
18266
|
-
*
|
|
18362
|
+
* The value must be either `UDP`, `TCP`, `TLS`, `AUTO`.
|
|
18267
18363
|
*
|
|
18268
18364
|
* @example UDP
|
|
18269
18365
|
*/
|
|
@@ -18285,9 +18381,9 @@ type UpdateSIPPhonePhonesVariables = {
|
|
|
18285
18381
|
* * The account owner or account admin must first enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.
|
|
18286
18382
|
*
|
|
18287
18383
|
*
|
|
18288
|
-
* **Scopes:** `sip_phone:write:admin`
|
|
18384
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin`
|
|
18289
18385
|
*
|
|
18290
|
-
* **Granular Scopes:** `sip_phone:update:sip_phone:admin`
|
|
18386
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:update:sip_phone:admin`
|
|
18291
18387
|
*
|
|
18292
18388
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18293
18389
|
*/
|
|
@@ -18311,9 +18407,9 @@ type DeleteSIPPhoneVariables = {
|
|
|
18311
18407
|
* * Currently only supported on Cisco and Avaya PBX systems.
|
|
18312
18408
|
* * The user must enable **SIP Phone Integration** by contacting the [Zoom Sales](https://zoom.us/contactsales) team.
|
|
18313
18409
|
*
|
|
18314
|
-
* **Scopes:** `sip_phone:write:admin`
|
|
18410
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin`
|
|
18315
18411
|
*
|
|
18316
|
-
* **Granular Scopes:** `sip_phone:delete:sip_phone:admin`
|
|
18412
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:delete:sip_phone:admin`
|
|
18317
18413
|
*
|
|
18318
18414
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18319
18415
|
*/
|
|
@@ -18436,9 +18532,9 @@ type UpdateSIPPhoneVariables = {
|
|
|
18436
18532
|
/**
|
|
18437
18533
|
* Update information of a specific SIP phone on a Zoom account. n Zoom's Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a Softphone registration to supported premise based PBX system. End users will have the ability to have Softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. **Prerequisites**:* Currently only supported on Cisco and Avaya PBX systems. * The account owner or account admin must first enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.
|
|
18438
18534
|
*
|
|
18439
|
-
* **Scopes:** `sip_phone:write:admin`
|
|
18535
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin`
|
|
18440
18536
|
*
|
|
18441
|
-
* **Granular Scopes:** `sip_phone:update:sip_phone:admin`
|
|
18537
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:update:sip_phone:admin`
|
|
18442
18538
|
*
|
|
18443
18539
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18444
18540
|
*/
|
|
@@ -18518,9 +18614,9 @@ type TspVariables = FetcherExtraProps;
|
|
|
18518
18614
|
*
|
|
18519
18615
|
* * A Pro or a higher plan.
|
|
18520
18616
|
*
|
|
18521
|
-
* **Scopes:** `tsp:read:admin`
|
|
18617
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:admin`
|
|
18522
18618
|
*
|
|
18523
|
-
* **Granular Scopes:** `tsp:read:tsp:admin`
|
|
18619
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:tsp:admin`
|
|
18524
18620
|
*
|
|
18525
18621
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18526
18622
|
*/
|
|
@@ -18582,9 +18678,9 @@ type TspUpdateVariables = {
|
|
|
18582
18678
|
*
|
|
18583
18679
|
*
|
|
18584
18680
|
*
|
|
18585
|
-
* **Scopes:** `tsp:write:admin`
|
|
18681
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`
|
|
18586
18682
|
*
|
|
18587
|
-
* **Granular Scopes:** `tsp:update:tsp:admin`
|
|
18683
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:update:tsp:admin`
|
|
18588
18684
|
*
|
|
18589
18685
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18590
18686
|
*/
|
|
@@ -18671,9 +18767,9 @@ type UserTSPsVariables = {
|
|
|
18671
18767
|
/**
|
|
18672
18768
|
* List all of a user's TSP accounts. A user can have a maximum of two TSP accounts.
|
|
18673
18769
|
*
|
|
18674
|
-
* **Scopes:** `tsp:read:admin`,`tsp:read`
|
|
18770
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:admin`,`tsp:read`
|
|
18675
18771
|
*
|
|
18676
|
-
* **Granular Scopes:** `tsp:read:list_tsp_accounts`,`tsp:read:list_tsp_accounts:admin`
|
|
18772
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:list_tsp_accounts`,`tsp:read:list_tsp_accounts:admin`
|
|
18677
18773
|
*
|
|
18678
18774
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
18679
18775
|
*/
|
|
@@ -18823,9 +18919,9 @@ type UserTSPCreateVariables = {
|
|
|
18823
18919
|
*
|
|
18824
18920
|
*
|
|
18825
18921
|
*
|
|
18826
|
-
* **Scopes:** `tsp:write:admin`,`tsp:write`
|
|
18922
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`,`tsp:write`
|
|
18827
18923
|
*
|
|
18828
|
-
* **Granular Scopes:** `tsp:write:tsp_account`,`tsp:write:tsp_account:admin`
|
|
18924
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:tsp_account`,`tsp:write:tsp_account:admin`
|
|
18829
18925
|
*
|
|
18830
18926
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18831
18927
|
*/
|
|
@@ -18856,9 +18952,9 @@ type TspUrlUpdateVariables = {
|
|
|
18856
18952
|
* A global dial-in page can provide a list of global access numbers to use to conduct audio conferencing. Call this API to set the URL for a global dial-in page of a user whose Zoom account has TSP and special TSP with third-party audio conferencing options enabled.
|
|
18857
18953
|
*
|
|
18858
18954
|
*
|
|
18859
|
-
* **Scopes:** `tsp:write:admin`,`tsp:write`
|
|
18955
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`,`tsp:write`
|
|
18860
18956
|
*
|
|
18861
|
-
* **Granular Scopes:** `tsp:update:tsp_settings`,`tsp:update:tsp_settings:admin`
|
|
18957
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:update:tsp_settings`,`tsp:update:tsp_settings:admin`
|
|
18862
18958
|
*
|
|
18863
18959
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18864
18960
|
*/
|
|
@@ -18952,9 +19048,9 @@ type UserTSPVariables = {
|
|
|
18952
19048
|
*
|
|
18953
19049
|
*
|
|
18954
19050
|
*
|
|
18955
|
-
* **Scopes:** `tsp:read:admin`,`tsp:read`
|
|
19051
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:admin`,`tsp:read`
|
|
18956
19052
|
*
|
|
18957
|
-
* **Granular Scopes:** `tsp:read:tsp_account`,`tsp:read:tsp_account:admin`
|
|
19053
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:tsp_account`,`tsp:read:tsp_account:admin`
|
|
18958
19054
|
*
|
|
18959
19055
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18960
19056
|
*/
|
|
@@ -18981,9 +19077,9 @@ type UserTSPDeleteVariables = {
|
|
|
18981
19077
|
*
|
|
18982
19078
|
*
|
|
18983
19079
|
*
|
|
18984
|
-
* **Scopes:** `tsp:write:admin`,`tsp:write`
|
|
19080
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`,`tsp:write`
|
|
18985
19081
|
*
|
|
18986
|
-
* **Granular Scopes:** `tsp:delete:tsp_account`,`tsp:delete:tsp_account:admin`
|
|
19082
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:delete:tsp_account`,`tsp:delete:tsp_account:admin`
|
|
18987
19083
|
*
|
|
18988
19084
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18989
19085
|
*/
|
|
@@ -19071,9 +19167,9 @@ type UserTSPUpdateVariables = {
|
|
|
19071
19167
|
*
|
|
19072
19168
|
*
|
|
19073
19169
|
*
|
|
19074
|
-
* **Scopes:** `tsp:write:admin`,`tsp:write`
|
|
19170
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`,`tsp:write`
|
|
19075
19171
|
*
|
|
19076
|
-
* **Granular Scopes:** `tsp:update:tsp_account`,`tsp:update:tsp_account:admin`
|
|
19172
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:update:tsp_account`,`tsp:update:tsp_account:admin`
|
|
19077
19173
|
*
|
|
19078
19174
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
19079
19175
|
*/
|
|
@@ -19127,9 +19223,9 @@ type TrackingfieldListVariables = FetcherExtraProps;
|
|
|
19127
19223
|
* **Prerequisites:**
|
|
19128
19224
|
* * A Business, Education, API or higher plan.
|
|
19129
19225
|
*
|
|
19130
|
-
* **Scopes:** `tracking_fields:read:admin`
|
|
19226
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:read:admin`
|
|
19131
19227
|
*
|
|
19132
|
-
* **Granular Scopes:** `tracking_field:read:list_tracking_fields:admin`
|
|
19228
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_field:read:list_tracking_fields:admin`
|
|
19133
19229
|
*
|
|
19134
19230
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
19135
19231
|
*/
|
|
@@ -19198,9 +19294,9 @@ type TrackingfieldCreateVariables = {
|
|
|
19198
19294
|
* **Prerequisites:**
|
|
19199
19295
|
* * A Business, Education, API or higher plan.
|
|
19200
19296
|
*
|
|
19201
|
-
* **Scopes:** `tracking_fields:write:admin`
|
|
19297
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:write:admin`
|
|
19202
19298
|
*
|
|
19203
|
-
* **Granular Scopes:** `tracking_field:write:tracking_field:admin`
|
|
19299
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_field:write:tracking_field:admin`
|
|
19204
19300
|
*
|
|
19205
19301
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
19206
19302
|
*/
|
|
@@ -19253,9 +19349,9 @@ type TrackingfieldGetVariables = {
|
|
|
19253
19349
|
* **Prerequisites:**
|
|
19254
19350
|
* * A Business, Education, API or higher plan.
|
|
19255
19351
|
*
|
|
19256
|
-
* **Scopes:** `tracking_fields:read:admin`
|
|
19352
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:read:admin`
|
|
19257
19353
|
*
|
|
19258
|
-
* **Granular Scopes:** `tracking_field:read:tracking_field:admin`
|
|
19354
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_field:read:tracking_field:admin`
|
|
19259
19355
|
*
|
|
19260
19356
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
19261
19357
|
*/
|
|
@@ -19278,9 +19374,9 @@ type TrackingfieldDeleteVariables = {
|
|
|
19278
19374
|
* **Prerequisites:**
|
|
19279
19375
|
* * A Business, Education, API or higher plan.
|
|
19280
19376
|
*
|
|
19281
|
-
* **Scopes:** `tracking_fields:write:admin`
|
|
19377
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:write:admin`
|
|
19282
19378
|
*
|
|
19283
|
-
* **Granular Scopes:** `tracking_field:delete:tracking_field:admin`
|
|
19379
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_field:delete:tracking_field:admin`
|
|
19284
19380
|
*
|
|
19285
19381
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
19286
19382
|
*/
|
|
@@ -19328,9 +19424,9 @@ type TrackingfieldUpdateVariables = {
|
|
|
19328
19424
|
* **Prerequisites:**
|
|
19329
19425
|
* * A Business, Education, API or higher plan.
|
|
19330
19426
|
*
|
|
19331
|
-
* **Scopes:** `tracking_fields:write:admin`
|
|
19427
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:write:admin`
|
|
19332
19428
|
*
|
|
19333
|
-
* **Granular Scopes:** `tracking_field:update:tracking_field:admin`
|
|
19429
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_field:update:tracking_field:admin`
|
|
19334
19430
|
*
|
|
19335
19431
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
19336
19432
|
*/
|
|
@@ -19369,9 +19465,9 @@ type DeleteWebinarChatMessageByIdVariables = {
|
|
|
19369
19465
|
* **Prerequisites:**
|
|
19370
19466
|
* * Have Zoom enable the DLP for the in-meeting chat feature to use this API.
|
|
19371
19467
|
*
|
|
19372
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
19468
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
19373
19469
|
*
|
|
19374
|
-
* **Granular Scopes:** `webinar:delete:live_webinar_chat_message`,`webinar:delete:live_webinar_chat_message:admin`
|
|
19470
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:live_webinar_chat_message`,`webinar:delete:live_webinar_chat_message:admin`
|
|
19375
19471
|
*
|
|
19376
19472
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
19377
19473
|
*/
|
|
@@ -19625,9 +19721,9 @@ type WebinarAbsenteesVariables = {
|
|
|
19625
19721
|
*
|
|
19626
19722
|
*
|
|
19627
19723
|
*
|
|
19628
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
19724
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
19629
19725
|
*
|
|
19630
|
-
* **Granular Scopes:** `webinar:read:list_absentees`,`webinar:read:list_absentees:admin`
|
|
19726
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_absentees`,`webinar:read:list_absentees:admin`
|
|
19631
19727
|
*
|
|
19632
19728
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
19633
19729
|
*/
|
|
@@ -19671,9 +19767,9 @@ type PastWebinarsVariables = {
|
|
|
19671
19767
|
*
|
|
19672
19768
|
*
|
|
19673
19769
|
*
|
|
19674
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
19770
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
19675
19771
|
*
|
|
19676
|
-
* **Granular Scopes:** `webinar:read:list_past_instances`,`webinar:read:list_past_instances:admin`
|
|
19772
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_past_instances`,`webinar:read:list_past_instances:admin`
|
|
19677
19773
|
*
|
|
19678
19774
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
19679
19775
|
*/
|
|
@@ -19819,9 +19915,9 @@ type ListWebinarParticipantsVariables = {
|
|
|
19819
19915
|
* **Prerequisites:**
|
|
19820
19916
|
* * A Pro or higher plan with a webinar add-on.
|
|
19821
19917
|
*
|
|
19822
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
19918
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
19823
19919
|
*
|
|
19824
|
-
* **Granular Scopes:** `webinar:read:list_past_participants:admin`,`webinar:read:list_past_participants`
|
|
19920
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_past_participants:admin`,`webinar:read:list_past_participants`
|
|
19825
19921
|
*
|
|
19826
19922
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
19827
19923
|
*/
|
|
@@ -19912,9 +20008,9 @@ type ListPastWebinarPollResultsVariables = {
|
|
|
19912
20008
|
*
|
|
19913
20009
|
*
|
|
19914
20010
|
*
|
|
19915
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
20011
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
19916
20012
|
*
|
|
19917
|
-
* **Granular Scopes:** `webinar:read:list_past_polls`,`webinar:read:list_past_polls:admin`
|
|
20013
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_past_polls`,`webinar:read:list_past_polls:admin`
|
|
19918
20014
|
*
|
|
19919
20015
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
19920
20016
|
*/
|
|
@@ -19994,9 +20090,9 @@ type ListPastWebinarQAVariables = {
|
|
|
19994
20090
|
*
|
|
19995
20091
|
*
|
|
19996
20092
|
*
|
|
19997
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
20093
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
19998
20094
|
*
|
|
19999
|
-
* **Granular Scopes:** `webinar:read:past_qa`,`webinar:read:past_qa:admin`
|
|
20095
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:past_qa`,`webinar:read:past_qa:admin`
|
|
20000
20096
|
*
|
|
20001
20097
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
20002
20098
|
*/
|
|
@@ -20047,9 +20143,9 @@ type ListWebinarTemplatesVariables = {
|
|
|
20047
20143
|
/**
|
|
20048
20144
|
* Display a list of a user's [webinar templates](https://support.zoom.us/hc/en-us/articles/115001079746-Webinar-Templates). For user-level apps, pass [the `me` value](/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter. When you schedule a webinar, save the settings for that webinar as a template for scheduling future webinars. To use a template when scheduling a webinar, use the `id` value in this API response in the `template_id` field of the [**Create a webinar**](/docs/api-reference/zoom-api/methods#operation/webinarCreate) API. **Prerequisites:** * A Pro or a higher account with the [Zoom Webinar plan](https://zoom.us/pricing/webinar).
|
|
20049
20145
|
*
|
|
20050
|
-
* **Scopes:** `webinar:read`,`webinar:read:admin`
|
|
20146
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read`,`webinar:read:admin`
|
|
20051
20147
|
*
|
|
20052
|
-
* **Granular Scopes:** `webinar:read:list_templates`,`webinar:read:list_templates:admin`
|
|
20148
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_templates`,`webinar:read:list_templates:admin`
|
|
20053
20149
|
*/
|
|
20054
20150
|
declare const listWebinarTemplates: (variables: ListWebinarTemplatesVariables, signal?: AbortSignal) => Promise<ListWebinarTemplatesResponse>;
|
|
20055
20151
|
type WebinarTemplateCreatePathParams = {
|
|
@@ -20113,9 +20209,9 @@ type WebinarTemplateCreateVariables = {
|
|
|
20113
20209
|
*
|
|
20114
20210
|
*
|
|
20115
20211
|
*
|
|
20116
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
20212
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
20117
20213
|
*
|
|
20118
|
-
* **Granular Scopes:** `webinar:write:template`,`webinar:write:template:admin`
|
|
20214
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:template`,`webinar:write:template:admin`
|
|
20119
20215
|
*
|
|
20120
20216
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
20121
20217
|
*/
|
|
@@ -20287,9 +20383,9 @@ type WebinarsVariables = {
|
|
|
20287
20383
|
* **Prerequisites**
|
|
20288
20384
|
* * A Pro or higher plan with the webinar add-on.
|
|
20289
20385
|
*
|
|
20290
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
20386
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
20291
20387
|
*
|
|
20292
|
-
* **Granular Scopes:** `webinar:read:list_webinars`,`webinar:read:list_webinars:admin`
|
|
20388
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_webinars`,`webinar:read:list_webinars:admin`
|
|
20293
20389
|
*
|
|
20294
20390
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
20295
20391
|
*/
|
|
@@ -21825,9 +21921,9 @@ type WebinarCreateVariables = {
|
|
|
21825
21921
|
* **Prerequisites:**
|
|
21826
21922
|
* * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on.
|
|
21827
21923
|
*
|
|
21828
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
21924
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
21829
21925
|
*
|
|
21830
|
-
* **Granular Scopes:** `webinar:write:webinar`,`webinar:write:webinar:admin`
|
|
21926
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:webinar`,`webinar:write:webinar:admin`
|
|
21831
21927
|
*
|
|
21832
21928
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
21833
21929
|
*/
|
|
@@ -22661,9 +22757,9 @@ type WebinarVariables = {
|
|
|
22661
22757
|
* **Prerequisites:**
|
|
22662
22758
|
* * Pro or higher plan with a Webinar add-on.
|
|
22663
22759
|
*
|
|
22664
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
22760
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
22665
22761
|
*
|
|
22666
|
-
* **Granular Scopes:** `webinar:read:webinar`,`webinar:read:webinar:admin`
|
|
22762
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:webinar`,`webinar:read:webinar:admin`
|
|
22667
22763
|
*
|
|
22668
22764
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
22669
22765
|
*/
|
|
@@ -22708,9 +22804,9 @@ type WebinarDeleteVariables = {
|
|
|
22708
22804
|
*
|
|
22709
22805
|
* * Pro or higher plan with the webinar add-on.
|
|
22710
22806
|
*
|
|
22711
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
22807
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
22712
22808
|
*
|
|
22713
|
-
* **Granular Scopes:** `webinar:delete:webinar`,`webinar:delete:webinar:admin`
|
|
22809
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:webinar`,`webinar:delete:webinar:admin`
|
|
22714
22810
|
*
|
|
22715
22811
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
22716
22812
|
*/
|
|
@@ -23448,9 +23544,9 @@ type WebinarUpdateVariables = {
|
|
|
23448
23544
|
* **Prerequisites**
|
|
23449
23545
|
* * A Pro or higher plan with a webinar add-on.
|
|
23450
23546
|
*
|
|
23451
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
23547
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
23452
23548
|
*
|
|
23453
|
-
* **Granular Scopes:** `webinar:update:webinar`,`webinar:update:webinar:admin`
|
|
23549
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:webinar`,`webinar:update:webinar:admin`
|
|
23454
23550
|
*
|
|
23455
23551
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
23456
23552
|
*/
|
|
@@ -23533,9 +23629,9 @@ type AddBatchWebinarRegistrantsVariables = {
|
|
|
23533
23629
|
*
|
|
23534
23630
|
*
|
|
23535
23631
|
*
|
|
23536
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
23632
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
23537
23633
|
*
|
|
23538
|
-
* **Granular Scopes:** `webinar:write:batch_registrants`,`webinar:write:batch_registrants:admin`
|
|
23634
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:batch_registrants`,`webinar:write:batch_registrants:admin`
|
|
23539
23635
|
*
|
|
23540
23636
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
23541
23637
|
*/
|
|
@@ -23633,9 +23729,9 @@ type GetWebinarBrandingVariables = {
|
|
|
23633
23729
|
/**
|
|
23634
23730
|
* Get the webinar's [session branding](https://support.zoom.us/hc/en-us/articles/4836268732045-Using-Webinar-Session-Branding) information. Session branding lets hosts visually customize a webinar by setting a webinar wallpaper that displays behind video tiles. Session branding also lets hosts set the virtual background for and apply name tags to hosts, alternative hosts, panelists, interpreters, and speakers. **Prerequisites:** * A Pro or higher plan with the Webinar add-on. * The **Webinar Session Branding** setting enabled.
|
|
23635
23731
|
*
|
|
23636
|
-
* **Scopes:** `webinar:read`,`webinar:read:admin`
|
|
23732
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read`,`webinar:read:admin`
|
|
23637
23733
|
*
|
|
23638
|
-
* **Granular Scopes:** `webinar:read:branding`,`webinar:read:branding:admin`
|
|
23734
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:branding`,`webinar:read:branding:admin`
|
|
23639
23735
|
*
|
|
23640
23736
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
23641
23737
|
*/
|
|
@@ -23741,9 +23837,9 @@ type CreateWebinarBrandingNameTagVariables = {
|
|
|
23741
23837
|
* Create a webinar's [session branding](https://support.zoom.us/hc/en-us/articles/4836268732045-Using-Webinar-Session-Branding) name tag. There's a limit of 20 name tags per webinar. **Prerequisites:**
|
|
23742
23838
|
* * The **Webinar Session Branding** setting enabled.
|
|
23743
23839
|
*
|
|
23744
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
23840
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
23745
23841
|
*
|
|
23746
|
-
* **Granular Scopes:** `webinar:write:branding_name_tag`,`webinar:write:branding_name_tag:admin`
|
|
23842
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:branding_name_tag`,`webinar:write:branding_name_tag:admin`
|
|
23747
23843
|
*
|
|
23748
23844
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
23749
23845
|
*/
|
|
@@ -23776,9 +23872,9 @@ type DeleteWebinarBrandingNameTagVariables = {
|
|
|
23776
23872
|
* **Prerequisites:**
|
|
23777
23873
|
* * The **Webinar Session Branding** setting enabled.
|
|
23778
23874
|
*
|
|
23779
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
23875
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
23780
23876
|
*
|
|
23781
|
-
* **Granular Scopes:** `webinar:delete:branding_name_tag`,`webinar:delete:branding_name_tag:admin`
|
|
23877
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:branding_name_tag`,`webinar:delete:branding_name_tag:admin`
|
|
23782
23878
|
*
|
|
23783
23879
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
23784
23880
|
*/
|
|
@@ -23852,9 +23948,9 @@ type UpdateWebinarBrandingNameTagVariables = {
|
|
|
23852
23948
|
* Update a webinar's [session branding](https://support.zoom.us/hc/en-us/articles/4836268732045-Using-Webinar-Session-Branding) name tag. **Prerequisites:**
|
|
23853
23949
|
* * The **Webinar Session Branding** setting enabled.
|
|
23854
23950
|
*
|
|
23855
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
23951
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
23856
23952
|
*
|
|
23857
|
-
* **Granular Scopes:** `webinar:update:branding_name_tag`,`webinar:update:branding_name_tag:admin`
|
|
23953
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:branding_name_tag`,`webinar:update:branding_name_tag:admin`
|
|
23858
23954
|
*
|
|
23859
23955
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
23860
23956
|
*/
|
|
@@ -23938,9 +24034,9 @@ type UploadWebinarBrandingVBVariables = {
|
|
|
23938
24034
|
* **Prerequisites:**
|
|
23939
24035
|
* * The **Webinar Session Branding** setting enabled.
|
|
23940
24036
|
*
|
|
23941
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
24037
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
23942
24038
|
*
|
|
23943
|
-
* **Granular Scopes:** `webinar:write:branding_virtual_background`,`webinar:write:branding_virtual_background:admin`
|
|
24039
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:branding_virtual_background`,`webinar:write:branding_virtual_background:admin`
|
|
23944
24040
|
*
|
|
23945
24041
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
23946
24042
|
*/
|
|
@@ -23973,9 +24069,9 @@ type DeleteWebinarBrandingVBVariables = {
|
|
|
23973
24069
|
* **Prerequisites:**
|
|
23974
24070
|
* * The **Webinar Session Branding** setting enabled.
|
|
23975
24071
|
*
|
|
23976
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
24072
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
23977
24073
|
*
|
|
23978
|
-
* **Granular Scopes:** `webinar:delete:branding_virtual_background`,`webinar:delete:branding_virtual_background:admin`
|
|
24074
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:branding_virtual_background`,`webinar:delete:branding_virtual_background:admin`
|
|
23979
24075
|
*
|
|
23980
24076
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
23981
24077
|
*/
|
|
@@ -24014,9 +24110,9 @@ type SetWebinarBrandingVBVariables = {
|
|
|
24014
24110
|
* **Prerequisites:**
|
|
24015
24111
|
* * The **Webinar Session Branding** setting enabled.
|
|
24016
24112
|
*
|
|
24017
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
24113
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
24018
24114
|
*
|
|
24019
|
-
* **Granular Scopes:** `webinar:update:branding_virtual_background`,`webinar:update:branding_virtual_background:admin`
|
|
24115
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:branding_virtual_background`,`webinar:update:branding_virtual_background:admin`
|
|
24020
24116
|
*
|
|
24021
24117
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24022
24118
|
*/
|
|
@@ -24080,9 +24176,9 @@ type UploadWebinarBrandingWallpaperVariables = {
|
|
|
24080
24176
|
* **Prerequisites:**
|
|
24081
24177
|
* * The **Webinar Session Branding** setting enabled.
|
|
24082
24178
|
*
|
|
24083
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
24179
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
24084
24180
|
*
|
|
24085
|
-
* **Granular Scopes:** `webinar:write:branding_wallpaper`,`webinar:write:branding_wallpaper:admin`
|
|
24181
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:branding_wallpaper`,`webinar:write:branding_wallpaper:admin`
|
|
24086
24182
|
*
|
|
24087
24183
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
24088
24184
|
*/
|
|
@@ -24106,9 +24202,9 @@ type DeleteWebinarBrandingWallpaperVariables = {
|
|
|
24106
24202
|
* **Prerequisites:**
|
|
24107
24203
|
* * The **Webinar Session Branding** setting enabled.
|
|
24108
24204
|
*
|
|
24109
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
24205
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
24110
24206
|
*
|
|
24111
|
-
* **Granular Scopes:** `webinar:delete:branding_wallpaper`,`webinar:delete:branding_wallpaper:admin`
|
|
24207
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:branding_wallpaper`,`webinar:delete:branding_wallpaper:admin`
|
|
24112
24208
|
*
|
|
24113
24209
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24114
24210
|
*/
|
|
@@ -24199,9 +24295,9 @@ type WebinarInviteLinksCreateVariables = {
|
|
|
24199
24295
|
*
|
|
24200
24296
|
* * Business, Education or API Plan with the Webinar add-on.
|
|
24201
24297
|
*
|
|
24202
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
24298
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
24203
24299
|
*
|
|
24204
|
-
* **Granular Scopes:** `webinar:write:invite_links`,`webinar:write:invite_links:admin`
|
|
24300
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:invite_links`,`webinar:write:invite_links:admin`
|
|
24205
24301
|
*
|
|
24206
24302
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24207
24303
|
*/
|
|
@@ -24241,9 +24337,9 @@ type WebinarLiveStreamingJoinTokenVariables = {
|
|
|
24241
24337
|
* * A Pro or higher plan with a Webinar add-on.
|
|
24242
24338
|
* * The **Allow livestreaming of webinars** user setting enabled in the Zoom web portal.
|
|
24243
24339
|
*
|
|
24244
|
-
* **Scopes:** `webinar_token:read:admin:live_streaming`,`webinar_token:read:live_streaming`
|
|
24340
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar_token:read:admin:live_streaming`,`webinar_token:read:live_streaming`
|
|
24245
24341
|
*
|
|
24246
|
-
* **Granular Scopes:** `webinar:read:live_streaming_token`,`webinar:read:live_streaming_token:admin`
|
|
24342
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:live_streaming_token`,`webinar:read:live_streaming_token:admin`
|
|
24247
24343
|
*
|
|
24248
24344
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24249
24345
|
*/
|
|
@@ -24283,9 +24379,9 @@ type WebinarLocalArchivingArchiveTokenVariables = {
|
|
|
24283
24379
|
* * A Pro or higher plan with a Webinar Add-on.
|
|
24284
24380
|
* * The **Archive meetings and webinars** account setting enabled in the Zoom web portal.
|
|
24285
24381
|
*
|
|
24286
|
-
* **Scopes:** `webinar_token:read:admin:local_archiving`
|
|
24382
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar_token:read:admin:local_archiving`
|
|
24287
24383
|
*
|
|
24288
|
-
* **Granular Scopes:** `webinar:read:local_archiving_token:admin`
|
|
24384
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:local_archiving_token:admin`
|
|
24289
24385
|
*
|
|
24290
24386
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24291
24387
|
*/
|
|
@@ -24325,9 +24421,9 @@ type WebinarLocalRecordingJoinTokenVariables = {
|
|
|
24325
24421
|
* * A Pro or higher plan with a Webinar add-on.
|
|
24326
24422
|
* * The **Local recording** user setting enabled in the Zoom web portal.
|
|
24327
24423
|
*
|
|
24328
|
-
* **Scopes:** `webinar_token:read:admin:local_recording`,`webinar_token:read:local_recording`
|
|
24424
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar_token:read:admin:local_recording`,`webinar_token:read:local_recording`
|
|
24329
24425
|
*
|
|
24330
|
-
* **Granular Scopes:** `webinar:read:local_recording_token`,`webinar:read:local_recording_token:admin`
|
|
24426
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:local_recording_token`,`webinar:read:local_recording_token:admin`
|
|
24331
24427
|
*
|
|
24332
24428
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24333
24429
|
*/
|
|
@@ -24385,9 +24481,9 @@ type GetWebinarLiveStreamDetailsVariables = {
|
|
|
24385
24481
|
*
|
|
24386
24482
|
*
|
|
24387
24483
|
*
|
|
24388
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
24484
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
24389
24485
|
*
|
|
24390
|
-
* **Granular Scopes:** `webinar:read:livestream`,`webinar:read:livestream:admin`
|
|
24486
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:livestream`,`webinar:read:livestream:admin`
|
|
24391
24487
|
*
|
|
24392
24488
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24393
24489
|
*/
|
|
@@ -24449,9 +24545,9 @@ type WebinarLiveStreamUpdateVariables = {
|
|
|
24449
24545
|
*
|
|
24450
24546
|
*
|
|
24451
24547
|
*
|
|
24452
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
24548
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
24453
24549
|
*
|
|
24454
|
-
* **Granular Scopes:** `webinar:update:livestream`,`webinar:update:livestream:admin`
|
|
24550
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:livestream`,`webinar:update:livestream:admin`
|
|
24455
24551
|
*
|
|
24456
24552
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24457
24553
|
*/
|
|
@@ -24514,9 +24610,9 @@ type WebinarLiveStreamStatusUpdateVariables = {
|
|
|
24514
24610
|
*
|
|
24515
24611
|
*
|
|
24516
24612
|
*
|
|
24517
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
24613
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
24518
24614
|
*
|
|
24519
|
-
* **Granular Scopes:** `webinar:update:livestream_status`,`webinar:update:livestream_status:admin`
|
|
24615
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:livestream_status`,`webinar:update:livestream_status:admin`
|
|
24520
24616
|
*
|
|
24521
24617
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24522
24618
|
*/
|
|
@@ -24615,9 +24711,9 @@ type WebinarPanelistsVariables = {
|
|
|
24615
24711
|
* * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar).
|
|
24616
24712
|
*
|
|
24617
24713
|
*
|
|
24618
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
24714
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
24619
24715
|
*
|
|
24620
|
-
* **Granular Scopes:** `webinar:read:list_panelists`,`webinar:read:list_panelists:admin`
|
|
24716
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_panelists`,`webinar:read:list_panelists:admin`
|
|
24621
24717
|
*
|
|
24622
24718
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
24623
24719
|
*/
|
|
@@ -24714,9 +24810,9 @@ type WebinarPanelistCreateVariables = {
|
|
|
24714
24810
|
* * Pro or a higher plan with the [Webinar Add-on](https://zoom.us/webinar).
|
|
24715
24811
|
*
|
|
24716
24812
|
*
|
|
24717
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
24813
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
24718
24814
|
*
|
|
24719
|
-
* **Granular Scopes:** `webinar:write:panelist`,`webinar:write:panelist:admin`
|
|
24815
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:panelist`,`webinar:write:panelist:admin`
|
|
24720
24816
|
*
|
|
24721
24817
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
24722
24818
|
*/
|
|
@@ -24742,9 +24838,9 @@ type WebinarPanelistsDeleteVariables = {
|
|
|
24742
24838
|
* * Pro or a higher plan with the [webinar add-on](https://zoom.us/webinar).
|
|
24743
24839
|
*
|
|
24744
24840
|
*
|
|
24745
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
24841
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
24746
24842
|
*
|
|
24747
|
-
* **Granular Scopes:** `webinar:delete:panelist`,`webinar:delete:panelist:admin`
|
|
24843
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:panelist`,`webinar:delete:panelist:admin`
|
|
24748
24844
|
*
|
|
24749
24845
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24750
24846
|
*/
|
|
@@ -24778,9 +24874,9 @@ type WebinarPanelistDeleteVariables = {
|
|
|
24778
24874
|
* * Pro or a higher plan with the [webinar add-on](https://zoom.us/webinar).
|
|
24779
24875
|
*
|
|
24780
24876
|
*
|
|
24781
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
24877
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
24782
24878
|
*
|
|
24783
|
-
* **Granular Scopes:** `webinar:delete:panelist`,`webinar:delete:panelist:admin`
|
|
24879
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:panelist`,`webinar:delete:panelist:admin`
|
|
24784
24880
|
*
|
|
24785
24881
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24786
24882
|
*/
|
|
@@ -25019,9 +25115,9 @@ type WebinarPollsVariables = {
|
|
|
25019
25115
|
*
|
|
25020
25116
|
*
|
|
25021
25117
|
*
|
|
25022
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
25118
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
25023
25119
|
*
|
|
25024
|
-
* **Granular Scopes:** `webinar:read:list_polls`,`webinar:read:list_polls:admin`
|
|
25120
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_polls`,`webinar:read:list_polls:admin`
|
|
25025
25121
|
*
|
|
25026
25122
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
25027
25123
|
*/
|
|
@@ -25414,9 +25510,9 @@ type WebinarPollCreateVariables = {
|
|
|
25414
25510
|
*
|
|
25415
25511
|
*
|
|
25416
25512
|
*
|
|
25417
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
25513
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
25418
25514
|
*
|
|
25419
|
-
* **Granular Scopes:** `webinar:write:poll`,`webinar:write:poll:admin`
|
|
25515
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:poll`,`webinar:write:poll:admin`
|
|
25420
25516
|
*
|
|
25421
25517
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
25422
25518
|
*/
|
|
@@ -25639,9 +25735,9 @@ type WebinarPollGetVariables = {
|
|
|
25639
25735
|
*
|
|
25640
25736
|
*
|
|
25641
25737
|
*
|
|
25642
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
25738
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
25643
25739
|
*
|
|
25644
|
-
* **Granular Scopes:** `webinar:read:poll`,`webinar:read:poll:admin`
|
|
25740
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:poll`,`webinar:read:poll:admin`
|
|
25645
25741
|
*
|
|
25646
25742
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
25647
25743
|
*/
|
|
@@ -25848,9 +25944,9 @@ type WebinarPollUpdateVariables = {
|
|
|
25848
25944
|
*
|
|
25849
25945
|
*
|
|
25850
25946
|
*
|
|
25851
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
25947
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
25852
25948
|
*
|
|
25853
|
-
* **Granular Scopes:** `webinar:update:poll`,`webinar:update:poll:admin`
|
|
25949
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:poll`,`webinar:update:poll:admin`
|
|
25854
25950
|
*
|
|
25855
25951
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
25856
25952
|
*/
|
|
@@ -25880,9 +25976,9 @@ type WebinarPollDeleteVariables = {
|
|
|
25880
25976
|
*
|
|
25881
25977
|
*
|
|
25882
25978
|
*
|
|
25883
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
25979
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
25884
25980
|
*
|
|
25885
|
-
* **Granular Scopes:** `webinar:delete:poll`,`webinar:delete:poll:admin`
|
|
25981
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:poll`,`webinar:delete:poll:admin`
|
|
25886
25982
|
*
|
|
25887
25983
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
25888
25984
|
*/
|
|
@@ -26161,9 +26257,9 @@ type WebinarRegistrantsVariables = {
|
|
|
26161
26257
|
*
|
|
26162
26258
|
*
|
|
26163
26259
|
*
|
|
26164
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
26260
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
26165
26261
|
*
|
|
26166
|
-
* **Granular Scopes:** `webinar:read:list_registrants`,`webinar:read:list_registrants:admin`
|
|
26262
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_registrants`,`webinar:read:list_registrants:admin`
|
|
26167
26263
|
*
|
|
26168
26264
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
26169
26265
|
*/
|
|
@@ -26425,9 +26521,9 @@ type WebinarRegistrantCreateVariables = {
|
|
|
26425
26521
|
* **Prerequisites:**
|
|
26426
26522
|
* * A Pro or higher plan with the Webinar add-on.
|
|
26427
26523
|
*
|
|
26428
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
26524
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
26429
26525
|
*
|
|
26430
|
-
* **Granular Scopes:** `webinar:write:registrant`,`webinar:write:registrant:admin`
|
|
26526
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:registrant`,`webinar:write:registrant:admin`
|
|
26431
26527
|
*
|
|
26432
26528
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
26433
26529
|
*/
|
|
@@ -26501,9 +26597,9 @@ type WebinarRegistrantsQuestionsGetVariables = {
|
|
|
26501
26597
|
* * Pro or higher plan with the webinar add-on.
|
|
26502
26598
|
*
|
|
26503
26599
|
*
|
|
26504
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
26600
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
26505
26601
|
*
|
|
26506
|
-
* **Granular Scopes:** `webinar:read:list_registration_questions`,`webinar:read:list_registration_questions:admin`
|
|
26602
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_registration_questions`,`webinar:read:list_registration_questions:admin`
|
|
26507
26603
|
*
|
|
26508
26604
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
26509
26605
|
*/
|
|
@@ -26578,9 +26674,9 @@ type WebinarRegistrantQuestionUpdateVariables = {
|
|
|
26578
26674
|
* * Registration option for Webinar should be set as required to use this API.
|
|
26579
26675
|
*
|
|
26580
26676
|
*
|
|
26581
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
26677
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
26582
26678
|
*
|
|
26583
|
-
* **Granular Scopes:** `webinar:update:registration_question`,`webinar:update:registration_question:admin`
|
|
26679
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:registration_question`,`webinar:update:registration_question:admin`
|
|
26584
26680
|
*
|
|
26585
26681
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
26586
26682
|
*/
|
|
@@ -26642,9 +26738,9 @@ type WebinarRegistrantStatusVariables = {
|
|
|
26642
26738
|
/**
|
|
26643
26739
|
* Update webinar registrants' registration status. You can approve or deny a registrant, or revoke a registrant's approval.
|
|
26644
26740
|
*
|
|
26645
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
26741
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
26646
26742
|
*
|
|
26647
|
-
* **Granular Scopes:** `webinar:update:registrant_status`,`webinar:update:registrant_status:admin`
|
|
26743
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:registrant_status`,`webinar:update:registrant_status:admin`
|
|
26648
26744
|
*
|
|
26649
26745
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
26650
26746
|
*/
|
|
@@ -26867,9 +26963,9 @@ type WebinarRegistrantGetVariables = {
|
|
|
26867
26963
|
*
|
|
26868
26964
|
* * The account must have a webinar plan.
|
|
26869
26965
|
*
|
|
26870
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
26966
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
26871
26967
|
*
|
|
26872
|
-
* **Granular Scopes:** `webinar:read:registrant`,`webinar:read:registrant:admin`
|
|
26968
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:registrant`,`webinar:read:registrant:admin`
|
|
26873
26969
|
*
|
|
26874
26970
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
26875
26971
|
*/
|
|
@@ -26907,9 +27003,9 @@ type DeleteWebinarRegistrantVariables = {
|
|
|
26907
27003
|
*
|
|
26908
27004
|
*
|
|
26909
27005
|
*
|
|
26910
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
27006
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
26911
27007
|
*
|
|
26912
|
-
* **Granular Scopes:** `webinar:delete:registrant`,`webinar:delete:registrant:admin`
|
|
27008
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:registrant`,`webinar:delete:registrant:admin`
|
|
26913
27009
|
*
|
|
26914
27010
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
26915
27011
|
*/
|
|
@@ -26968,9 +27064,9 @@ type GetWebinarSipDialingWithPasscodeVariables = {
|
|
|
26968
27064
|
/**
|
|
26969
27065
|
* Get a webinar's SIP URI. The URI consists of the webinar ID, an optional user-supplied passcode, and participant identifier code. The API return data also includes additional fields to indicate whether the API caller has a valid Cloud Room Connector subscription, the participant identifier code from the URI, and the SIP URI validity period in seconds.
|
|
26970
27066
|
*
|
|
26971
|
-
* **Scopes:** `webinar:write:sip_dialing`,`webinar:write:admin:sip_dialing`
|
|
27067
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:sip_dialing`,`webinar:write:admin:sip_dialing`
|
|
26972
27068
|
*
|
|
26973
|
-
* **Granular Scopes:** `webinar:write:sip_dialing`,`webinar:write:sip_dialing:admin`
|
|
27069
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:sip_dialing`,`webinar:write:sip_dialing:admin`
|
|
26974
27070
|
*
|
|
26975
27071
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
26976
27072
|
*/
|
|
@@ -27003,9 +27099,9 @@ type WebinarStatusVariables = {
|
|
|
27003
27099
|
*
|
|
27004
27100
|
* * The account must hold a valid [Webinar plan](https://zoom.us/webinar).
|
|
27005
27101
|
*
|
|
27006
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
27102
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
27007
27103
|
*
|
|
27008
|
-
* **Granular Scopes:** `webinar:update:status`,`webinar:update:status:admin`
|
|
27104
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:status`,`webinar:update:status:admin`
|
|
27009
27105
|
*
|
|
27010
27106
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
27011
27107
|
*/
|
|
@@ -27237,9 +27333,9 @@ type WebinarSurveyGetVariables = {
|
|
|
27237
27333
|
* * A Pro or higher plan with the Webinar add-on.
|
|
27238
27334
|
* * The [**Webinar Survey**](https://support.zoom.us/hc/en-us/articles/360061293191-Enabling-webinar-survey) feature enabled in the host's account.
|
|
27239
27335
|
*
|
|
27240
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
27336
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
27241
27337
|
*
|
|
27242
|
-
* **Granular Scopes:** `webinar:read:survey`,`webinar:read:survey:admin`
|
|
27338
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:survey`,`webinar:read:survey:admin`
|
|
27243
27339
|
*
|
|
27244
27340
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
27245
27341
|
*/
|
|
@@ -27264,9 +27360,9 @@ type WebinarSurveyDeleteVariables = {
|
|
|
27264
27360
|
* * A Pro or higher plan with the Webinar Add-on.
|
|
27265
27361
|
* * The [**Webinar Survey**](https://support.zoom.us/hc/en-us/articles/360061293191-Enabling-webinar-survey) feature enabled in the host's account.
|
|
27266
27362
|
*
|
|
27267
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
27363
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
27268
27364
|
*
|
|
27269
|
-
* **Granular Scopes:** `webinar:delete:survey`,`webinar:delete:survey:admin`
|
|
27365
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:survey`,`webinar:delete:survey:admin`
|
|
27270
27366
|
*
|
|
27271
27367
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
27272
27368
|
*/
|
|
@@ -27495,9 +27591,9 @@ type WebinarSurveyUpdateVariables = {
|
|
|
27495
27591
|
/**
|
|
27496
27592
|
* Update a [webinar survey](https://support.zoom.us/hc/en-us/articles/360048745651). **Prerequisites:** * A Pro or higher plan with the Webinar add-on. * Enable the [**Webinar Survey**](https://support.zoom.us/hc/en-us/articles/360061293191-Enabling-webinar-survey) feature in the host's account.
|
|
27497
27593
|
*
|
|
27498
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
27594
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
27499
27595
|
*
|
|
27500
|
-
* **Granular Scopes:** `webinar:update:survey`,`webinar:update:survey:admin`
|
|
27596
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:survey`,`webinar:update:survey:admin`
|
|
27501
27597
|
*
|
|
27502
27598
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
27503
27599
|
*/
|
|
@@ -27545,9 +27641,9 @@ type WebinarTokenVariables = {
|
|
|
27545
27641
|
* *
|
|
27546
27642
|
* * The **Allow use of caption API Token to integrate with 3rd-party Closed Captioning services** setting enabled.
|
|
27547
27643
|
*
|
|
27548
|
-
* **Scopes:** `webinar:read`,`webinar:read:admin`
|
|
27644
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read`,`webinar:read:admin`
|
|
27549
27645
|
*
|
|
27550
|
-
* **Granular Scopes:** `webinar:read:token`,`webinar:read:token:admin`
|
|
27646
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:token`,`webinar:read:token:admin`
|
|
27551
27647
|
*
|
|
27552
27648
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
27553
27649
|
*/
|
|
@@ -27618,9 +27714,9 @@ type GetTrackingSourcesVariables = {
|
|
|
27618
27714
|
* * Registration must be required for the Webinar.
|
|
27619
27715
|
*
|
|
27620
27716
|
*
|
|
27621
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
27717
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
27622
27718
|
*
|
|
27623
|
-
* **Granular Scopes:** `webinar:read:list_tracking_sources`,`webinar:read:list_tracking_sources:admin`
|
|
27719
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_tracking_sources`,`webinar:read:list_tracking_sources:admin`
|
|
27624
27720
|
*
|
|
27625
27721
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
27626
27722
|
*/
|