zoom-api-js 0.4.3 → 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 +13 -0
- package/dist/index.d.cts +580 -388
- package/dist/index.d.mts +580 -388
- package/dist/index.d.ts +580 -388
- 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
|
*/
|
|
@@ -5631,6 +5631,12 @@ type MeetingResponse = {
|
|
|
5631
5631
|
* @example 1
|
|
5632
5632
|
*/
|
|
5633
5633
|
who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
|
|
5634
|
+
/**
|
|
5635
|
+
* The summary template ID used to generate a meeting summary based on a predefined template. To get available summary templates, use the **Get user summary templates** API.
|
|
5636
|
+
*
|
|
5637
|
+
* @example 1e1356ad
|
|
5638
|
+
*/
|
|
5639
|
+
summary_template_id?: string;
|
|
5634
5640
|
/**
|
|
5635
5641
|
* Enable the device testing.
|
|
5636
5642
|
*
|
|
@@ -5652,6 +5658,12 @@ type MeetingResponse = {
|
|
|
5652
5658
|
* @default false
|
|
5653
5659
|
*/
|
|
5654
5660
|
disable_participant_video?: boolean;
|
|
5661
|
+
/**
|
|
5662
|
+
* Whether to include authenticated guest's email addresses in meetings' attendee reports.
|
|
5663
|
+
*
|
|
5664
|
+
* @example true
|
|
5665
|
+
*/
|
|
5666
|
+
email_in_attendee_report?: boolean;
|
|
5655
5667
|
};
|
|
5656
5668
|
/**
|
|
5657
5669
|
* Meeting start time in GMT or UTC. Start time will not be returned if the meeting is an **instant** meeting.
|
|
@@ -5758,9 +5770,9 @@ type MeetingVariables = {
|
|
|
5758
5770
|
* **Prerequisites**:
|
|
5759
5771
|
* * Host user must have a Zoom Meetings Basic license or higher.
|
|
5760
5772
|
*
|
|
5761
|
-
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
5773
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
5762
5774
|
*
|
|
5763
|
-
* **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`
|
|
5764
5776
|
*
|
|
5765
5777
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
5766
5778
|
*/
|
|
@@ -5812,9 +5824,9 @@ type MeetingDeleteVariables = {
|
|
|
5812
5824
|
* **Prerequisites**:
|
|
5813
5825
|
* * For recurring meetings, the `occurrence_id` is required to delete a specific occurrence. If not provided, the entire recurring series will be deleted.
|
|
5814
5826
|
*
|
|
5815
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
5827
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
5816
5828
|
*
|
|
5817
|
-
* **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`
|
|
5818
5830
|
*
|
|
5819
5831
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
5820
5832
|
*/
|
|
@@ -6669,6 +6681,12 @@ type MeetingUpdateRequestBody = {
|
|
|
6669
6681
|
* @example 1
|
|
6670
6682
|
*/
|
|
6671
6683
|
who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
|
|
6684
|
+
/**
|
|
6685
|
+
* The summary template ID used to generate a meeting summary based on a predefined template. To get available summary templates, use the **Get user summary templates** API.
|
|
6686
|
+
*
|
|
6687
|
+
* @example 1e1356ad
|
|
6688
|
+
*/
|
|
6689
|
+
summary_template_id?: string;
|
|
6672
6690
|
/**
|
|
6673
6691
|
* Enable the device testing.
|
|
6674
6692
|
*
|
|
@@ -6690,6 +6708,12 @@ type MeetingUpdateRequestBody = {
|
|
|
6690
6708
|
* @default false
|
|
6691
6709
|
*/
|
|
6692
6710
|
disable_participant_video?: boolean;
|
|
6711
|
+
/**
|
|
6712
|
+
* Whether to include authenticated guest's email addresses in meetings' attendee reports.
|
|
6713
|
+
*
|
|
6714
|
+
* @example true
|
|
6715
|
+
*/
|
|
6716
|
+
email_in_attendee_report?: boolean;
|
|
6693
6717
|
};
|
|
6694
6718
|
/**
|
|
6695
6719
|
* Meeting start time. When using a format like `yyyy-MM-dd'T'HH:mm:ss'Z'`, always use GMT time. When using a format like `yyyy-MM-dd'T'HH:mm:ss`, use local time and specify the time zone. Only used for scheduled meetings and recurring meetings with a fixed time.
|
|
@@ -6764,9 +6788,9 @@ type MeetingUpdateVariables = {
|
|
|
6764
6788
|
* * The `recurrence` object is required only when updating the entire series of a recurring meeting with `type=8`.
|
|
6765
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.
|
|
6766
6790
|
*
|
|
6767
|
-
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
6791
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
6768
6792
|
*
|
|
6769
|
-
* **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`
|
|
6770
6794
|
*
|
|
6771
6795
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
6772
6796
|
*/
|
|
@@ -7135,9 +7159,9 @@ type CreateBatchPollsVariables = {
|
|
|
7135
7159
|
* * Polling feature must be enabled in the host's account.
|
|
7136
7160
|
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
7137
7161
|
*
|
|
7138
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
7162
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
7139
7163
|
*
|
|
7140
|
-
* **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`
|
|
7141
7165
|
*
|
|
7142
7166
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7143
7167
|
*/
|
|
@@ -7233,9 +7257,9 @@ type AddBatchRegistrantsVariables = {
|
|
|
7233
7257
|
*
|
|
7234
7258
|
*
|
|
7235
7259
|
*
|
|
7236
|
-
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
7260
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
7237
7261
|
*
|
|
7238
|
-
* **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`
|
|
7239
7263
|
*
|
|
7240
7264
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
7241
7265
|
*/
|
|
@@ -7299,9 +7323,9 @@ type MeetingInvitationVariables = {
|
|
|
7299
7323
|
* **Prerequisites**:
|
|
7300
7324
|
* * Host user must have a Zoom Meetings Basic license or higher.
|
|
7301
7325
|
*
|
|
7302
|
-
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
7326
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
7303
7327
|
*
|
|
7304
|
-
* **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`
|
|
7305
7329
|
*
|
|
7306
7330
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7307
7331
|
*/
|
|
@@ -7393,9 +7417,9 @@ type MeetingInviteLinksCreateVariables = {
|
|
|
7393
7417
|
* **Prerequisites**:
|
|
7394
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.
|
|
7395
7419
|
*
|
|
7396
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
7420
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
7397
7421
|
*
|
|
7398
|
-
* **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`
|
|
7399
7423
|
*
|
|
7400
7424
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7401
7425
|
*/
|
|
@@ -7437,9 +7461,9 @@ type MeetingLiveStreamingJoinTokenVariables = {
|
|
|
7437
7461
|
* * A Pro or higher plan for the meeting host.
|
|
7438
7462
|
* * The **Allow livestreaming of meetings** user setting enabled in the Zoom web portal.
|
|
7439
7463
|
*
|
|
7440
|
-
* **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`
|
|
7441
7465
|
*
|
|
7442
|
-
* **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`
|
|
7443
7467
|
*
|
|
7444
7468
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7445
7469
|
*/
|
|
@@ -7481,9 +7505,9 @@ type MeetingLocalArchivingArchiveTokenVariables = {
|
|
|
7481
7505
|
* * A Pro or higher plan for the meeting host.
|
|
7482
7506
|
* * The **Archive meetings and webinars** account setting enabled in the Zoom web portal.
|
|
7483
7507
|
*
|
|
7484
|
-
* **Scopes:** `meeting_token:read:admin:local_archiving`
|
|
7508
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_token:read:admin:local_archiving`
|
|
7485
7509
|
*
|
|
7486
|
-
* **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`
|
|
7487
7511
|
*
|
|
7488
7512
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7489
7513
|
*/
|
|
@@ -7533,9 +7557,9 @@ type MeetingLocalRecordingJoinTokenVariables = {
|
|
|
7533
7557
|
* **Prerequisites:**
|
|
7534
7558
|
* * The **Local recording** user setting enabled in the Zoom web portal.
|
|
7535
7559
|
*
|
|
7536
|
-
* **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`
|
|
7537
7561
|
*
|
|
7538
|
-
* **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`
|
|
7539
7563
|
*
|
|
7540
7564
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7541
7565
|
*/
|
|
@@ -7591,9 +7615,9 @@ type GetMeetingLiveStreamDetailsVariables = {
|
|
|
7591
7615
|
*
|
|
7592
7616
|
*
|
|
7593
7617
|
*
|
|
7594
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
7618
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
7595
7619
|
*
|
|
7596
|
-
* **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`
|
|
7597
7621
|
*
|
|
7598
7622
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7599
7623
|
*/
|
|
@@ -7650,9 +7674,9 @@ type MeetingLiveStreamUpdateVariables = {
|
|
|
7650
7674
|
* **Prerequisites:**
|
|
7651
7675
|
* * Meeting host must have a Pro license.
|
|
7652
7676
|
*
|
|
7653
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
7677
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
7654
7678
|
*
|
|
7655
|
-
* **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`
|
|
7656
7680
|
*
|
|
7657
7681
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7658
7682
|
*/
|
|
@@ -7729,9 +7753,9 @@ type MeetingLiveStreamStatusUpdateVariables = {
|
|
|
7729
7753
|
* **Prerequisites:**
|
|
7730
7754
|
* * Meeting host must have a Pro license.
|
|
7731
7755
|
*
|
|
7732
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
7756
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
7733
7757
|
*
|
|
7734
|
-
* **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`
|
|
7735
7759
|
*
|
|
7736
7760
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7737
7761
|
*/
|
|
@@ -7847,10 +7871,13 @@ type GetameetingsummaryResponse = {
|
|
|
7847
7871
|
* The summary overview.
|
|
7848
7872
|
*
|
|
7849
7873
|
* @example Meeting overview
|
|
7874
|
+
* @deprecated true
|
|
7850
7875
|
*/
|
|
7851
7876
|
summary_overview?: string;
|
|
7852
7877
|
/**
|
|
7853
7878
|
* The summary content details.
|
|
7879
|
+
*
|
|
7880
|
+
* @deprecated true
|
|
7854
7881
|
*/
|
|
7855
7882
|
summary_details?: {
|
|
7856
7883
|
/**
|
|
@@ -7868,8 +7895,15 @@ type GetameetingsummaryResponse = {
|
|
|
7868
7895
|
}[];
|
|
7869
7896
|
/**
|
|
7870
7897
|
* The next steps.
|
|
7898
|
+
*
|
|
7899
|
+
* @deprecated true
|
|
7871
7900
|
*/
|
|
7872
7901
|
next_steps?: string[];
|
|
7902
|
+
/**
|
|
7903
|
+
* The edited summary content.
|
|
7904
|
+
*
|
|
7905
|
+
* @deprecated true
|
|
7906
|
+
*/
|
|
7873
7907
|
edited_summary?: {
|
|
7874
7908
|
/**
|
|
7875
7909
|
* The user edited summary overview.
|
|
@@ -7888,6 +7922,64 @@ type GetameetingsummaryResponse = {
|
|
|
7888
7922
|
*/
|
|
7889
7923
|
next_steps?: string[];
|
|
7890
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;
|
|
7891
7983
|
};
|
|
7892
7984
|
type GetameetingsummaryVariables = {
|
|
7893
7985
|
pathParams: GetameetingsummaryPathParams;
|
|
@@ -7895,14 +7987,14 @@ type GetameetingsummaryVariables = {
|
|
|
7895
7987
|
/**
|
|
7896
7988
|
* Display information about a meeting summary.
|
|
7897
7989
|
*
|
|
7898
|
-
* **Prerequisites
|
|
7990
|
+
* **Prerequisites**
|
|
7899
7991
|
* * Host user type must have a Pro or higher plan.
|
|
7900
|
-
* * 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.
|
|
7901
7993
|
* * E2ee meetings do not have summary feature enabled.
|
|
7902
7994
|
*
|
|
7903
|
-
* **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`
|
|
7904
7996
|
*
|
|
7905
|
-
* **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`
|
|
7906
7998
|
*
|
|
7907
7999
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7908
8000
|
*/
|
|
@@ -7951,9 +8043,9 @@ type MeetingAppAddVariables = {
|
|
|
7951
8043
|
* * The meeting must not be a live meeting.
|
|
7952
8044
|
* * The **Zoom Apps Quick Launch Button** setting enabled in the Zoom web portal.
|
|
7953
8045
|
*
|
|
7954
|
-
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
8046
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
7955
8047
|
*
|
|
7956
|
-
* **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`
|
|
7957
8049
|
*
|
|
7958
8050
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7959
8051
|
*/
|
|
@@ -7980,9 +8072,9 @@ type MeetingAppDeleteVariables = {
|
|
|
7980
8072
|
* * The meeting must not be a live meeting.
|
|
7981
8073
|
* * The **Zoom Apps Quick Launch Button** setting enabled in the Zoom web portal.
|
|
7982
8074
|
*
|
|
7983
|
-
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
8075
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
7984
8076
|
*
|
|
7985
|
-
* **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`
|
|
7986
8078
|
*
|
|
7987
8079
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7988
8080
|
*/
|
|
@@ -8227,9 +8319,9 @@ type MeetingPollsVariables = {
|
|
|
8227
8319
|
* * Host user type must be **Pro** or higher plan.
|
|
8228
8320
|
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
8229
8321
|
*
|
|
8230
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
8322
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
8231
8323
|
*
|
|
8232
|
-
* **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`
|
|
8233
8325
|
*
|
|
8234
8326
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
8235
8327
|
*/
|
|
@@ -8629,9 +8721,9 @@ type MeetingPollCreateVariables = {
|
|
|
8629
8721
|
* * Polling feature must be enabled in the host's account.
|
|
8630
8722
|
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
8631
8723
|
*
|
|
8632
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
8724
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
8633
8725
|
*
|
|
8634
|
-
* **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`
|
|
8635
8727
|
*
|
|
8636
8728
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
8637
8729
|
*/
|
|
@@ -8857,9 +8949,9 @@ type MeetingPollGetVariables = {
|
|
|
8857
8949
|
* * Host must have Pro or higher plan.
|
|
8858
8950
|
* * Enable the **Meeting Polls/Quizzes** setting in the Zoom web portal.
|
|
8859
8951
|
*
|
|
8860
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
8952
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
8861
8953
|
*
|
|
8862
|
-
* **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`
|
|
8863
8955
|
*
|
|
8864
8956
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
8865
8957
|
*/
|
|
@@ -9070,9 +9162,9 @@ type MeetingPollUpdateVariables = {
|
|
|
9070
9162
|
* * The **Meeting Polls/Quizzes** setting enabled in the Zoom web portal.
|
|
9071
9163
|
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
9072
9164
|
*
|
|
9073
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
9165
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
9074
9166
|
*
|
|
9075
|
-
* **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`
|
|
9076
9168
|
*
|
|
9077
9169
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9078
9170
|
*/
|
|
@@ -9107,9 +9199,9 @@ type MeetingPollDeleteVariables = {
|
|
|
9107
9199
|
* * Polling feature should be enabled in the host's account.
|
|
9108
9200
|
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
9109
9201
|
*
|
|
9110
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
9202
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
9111
9203
|
*
|
|
9112
|
-
* **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`
|
|
9113
9205
|
*
|
|
9114
9206
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9115
9207
|
*/
|
|
@@ -9389,9 +9481,9 @@ type MeetingRegistrantsVariables = {
|
|
|
9389
9481
|
* * Host user type must be **Pro** or higher plan.
|
|
9390
9482
|
* * Registration must be enabled for the meeting.
|
|
9391
9483
|
*
|
|
9392
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
9484
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
9393
9485
|
*
|
|
9394
|
-
* **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`
|
|
9395
9487
|
*
|
|
9396
9488
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
9397
9489
|
*/
|
|
@@ -9666,9 +9758,9 @@ type MeetingRegistrantCreateVariables = {
|
|
|
9666
9758
|
* **Prerequisites:**
|
|
9667
9759
|
* * The host must be a **Licensed** user type.
|
|
9668
9760
|
*
|
|
9669
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
9761
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
9670
9762
|
*
|
|
9671
|
-
* **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`
|
|
9672
9764
|
*
|
|
9673
9765
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9674
9766
|
*/
|
|
@@ -9741,9 +9833,9 @@ type MeetingRegistrantsQuestionsGetVariables = {
|
|
|
9741
9833
|
* * Host user type must be **Pro** or higher plan.
|
|
9742
9834
|
* * Registration must be enabled for the meeting.
|
|
9743
9835
|
*
|
|
9744
|
-
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
9836
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
9745
9837
|
*
|
|
9746
|
-
* **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`
|
|
9747
9839
|
*
|
|
9748
9840
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9749
9841
|
*/
|
|
@@ -9817,9 +9909,9 @@ type MeetingRegistrantQuestionUpdateVariables = {
|
|
|
9817
9909
|
* * Host user type must be **Pro** or higher plan.
|
|
9818
9910
|
* * Registration must be enabled for the meeting.
|
|
9819
9911
|
*
|
|
9820
|
-
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
9912
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
9821
9913
|
*
|
|
9822
|
-
* **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`
|
|
9823
9915
|
*
|
|
9824
9916
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9825
9917
|
*/
|
|
@@ -9882,9 +9974,9 @@ type MeetingRegistrantStatusVariables = {
|
|
|
9882
9974
|
* * Host user type must be **Pro** or higher plan.
|
|
9883
9975
|
* * Registration must be enabled for the meeting.
|
|
9884
9976
|
*
|
|
9885
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
9977
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
9886
9978
|
*
|
|
9887
|
-
* **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`
|
|
9888
9980
|
*
|
|
9889
9981
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
9890
9982
|
*/
|
|
@@ -10088,9 +10180,9 @@ type MeetingRegistrantGetVariables = {
|
|
|
10088
10180
|
* **Prerequisites:**
|
|
10089
10181
|
* * The account must have a Meeting plan
|
|
10090
10182
|
*
|
|
10091
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
10183
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
10092
10184
|
*
|
|
10093
|
-
* **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`
|
|
10094
10186
|
*
|
|
10095
10187
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10096
10188
|
*/
|
|
@@ -10132,9 +10224,9 @@ type MeetingregistrantdeleteVariables = {
|
|
|
10132
10224
|
* * The `registration_type` must be 2 or 3 to require the `occurrence_id` field.
|
|
10133
10225
|
* * If the `registration_type` is 1, the `occurrence_id` is not needed, as registrants can attend any occurrence.
|
|
10134
10226
|
*
|
|
10135
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
10227
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
10136
10228
|
*
|
|
10137
|
-
* **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`
|
|
10138
10230
|
*
|
|
10139
10231
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10140
10232
|
*/
|
|
@@ -10196,9 +10288,9 @@ type GetSipDialingWithPasscodeVariables = {
|
|
|
10196
10288
|
* **Prerequisites**:
|
|
10197
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.
|
|
10198
10290
|
*
|
|
10199
|
-
* **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`
|
|
10200
10292
|
*
|
|
10201
|
-
* **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`
|
|
10202
10294
|
*
|
|
10203
10295
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
10204
10296
|
*/
|
|
@@ -10235,9 +10327,9 @@ type MeetingStatusVariables = {
|
|
|
10235
10327
|
* **Prerequisites**:
|
|
10236
10328
|
* * Host user must have a Zoom Meetings Basic license or higher.
|
|
10237
10329
|
*
|
|
10238
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
10330
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
10239
10331
|
*
|
|
10240
|
-
* **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`
|
|
10241
10333
|
*
|
|
10242
10334
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10243
10335
|
*/
|
|
@@ -10454,9 +10546,9 @@ type MeetingSurveyGetVariables = {
|
|
|
10454
10546
|
/**
|
|
10455
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.
|
|
10456
10548
|
*
|
|
10457
|
-
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
10549
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
10458
10550
|
*
|
|
10459
|
-
* **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`
|
|
10460
10552
|
*
|
|
10461
10553
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10462
10554
|
*/
|
|
@@ -10484,9 +10576,9 @@ type MeetingSurveyDeleteVariables = {
|
|
|
10484
10576
|
* * The [**Meeting Survey**](https://support.zoom.us/hc/en-us/articles/4404939095053-Enabling-meeting-surveys) feature enabled in the host's account.
|
|
10485
10577
|
* * The meeting must be a scheduled meeting. Instant meetings do not have survey features enabled.
|
|
10486
10578
|
*
|
|
10487
|
-
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
10579
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
10488
10580
|
*
|
|
10489
|
-
* **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`
|
|
10490
10582
|
*
|
|
10491
10583
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10492
10584
|
*/
|
|
@@ -10704,9 +10796,9 @@ type MeetingSurveyUpdateVariables = {
|
|
|
10704
10796
|
/**
|
|
10705
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.
|
|
10706
10798
|
*
|
|
10707
|
-
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
10799
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
10708
10800
|
*
|
|
10709
|
-
* **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`
|
|
10710
10802
|
*
|
|
10711
10803
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10712
10804
|
*/
|
|
@@ -10754,9 +10846,9 @@ type MeetingTokenVariables = {
|
|
|
10754
10846
|
* * The **Closed captioning** setting enabled in the Zoom web portal.
|
|
10755
10847
|
* * The **Allow use of caption API Token to integrate with third-party closed captioning services** setting enabled.
|
|
10756
10848
|
*
|
|
10757
|
-
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
10849
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
10758
10850
|
*
|
|
10759
|
-
* **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`
|
|
10760
10852
|
*
|
|
10761
10853
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10762
10854
|
*/
|
|
@@ -10879,9 +10971,9 @@ type PastMeetingDetailsVariables = {
|
|
|
10879
10971
|
* * The meeting must have ended before you can retrieve the data.
|
|
10880
10972
|
* * You cannot access a meeting that occurred more than one year ago.
|
|
10881
10973
|
*
|
|
10882
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
10974
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
10883
10975
|
*
|
|
10884
|
-
* **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`
|
|
10885
10977
|
*
|
|
10886
10978
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10887
10979
|
*/
|
|
@@ -10926,9 +11018,9 @@ type PastMeetingsVariables = {
|
|
|
10926
11018
|
* * The meeting must have already occurred at least once. This endpoint only returns instances of meetings that have ended.
|
|
10927
11019
|
* * You cannot retrieve instances for meetings that occurred more than 15 months ago.
|
|
10928
11020
|
*
|
|
10929
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
11021
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
10930
11022
|
*
|
|
10931
|
-
* **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`
|
|
10932
11024
|
*
|
|
10933
11025
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
10934
11026
|
*/
|
|
@@ -11081,9 +11173,9 @@ type PastMeetingParticipantsVariables = {
|
|
|
11081
11173
|
* **Note**: Please double encode your UUID when using this API if the UUID begins with a '/'or contains '//' in it.
|
|
11082
11174
|
*
|
|
11083
11175
|
*
|
|
11084
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
11176
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
11085
11177
|
*
|
|
11086
|
-
* **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`
|
|
11087
11179
|
*
|
|
11088
11180
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
11089
11181
|
*/
|
|
@@ -11173,9 +11265,9 @@ type ListPastMeetingPollsVariables = {
|
|
|
11173
11265
|
* * Host user type must be **Pro**.
|
|
11174
11266
|
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
11175
11267
|
*
|
|
11176
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
11268
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
11177
11269
|
*
|
|
11178
|
-
* **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`
|
|
11179
11271
|
*
|
|
11180
11272
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
11181
11273
|
*/
|
|
@@ -11252,9 +11344,9 @@ type ListPastMeetingQAVariables = {
|
|
|
11252
11344
|
* * The meeting must have ended before you can retrieve the data.
|
|
11253
11345
|
* * You cannot retrieve Q&A data for meetings that occurred more than 15 months ago.
|
|
11254
11346
|
*
|
|
11255
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
11347
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
11256
11348
|
*
|
|
11257
|
-
* **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`
|
|
11258
11350
|
*
|
|
11259
11351
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
11260
11352
|
*/
|
|
@@ -11309,9 +11401,9 @@ type ListMeetingTemplatesVariables = {
|
|
|
11309
11401
|
* **Prerequisites**:
|
|
11310
11402
|
* * Host user must have a Zoom Meetings Basic license or higher.
|
|
11311
11403
|
*
|
|
11312
|
-
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
11404
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
11313
11405
|
*
|
|
11314
|
-
* **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`
|
|
11315
11407
|
*
|
|
11316
11408
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
11317
11409
|
*/
|
|
@@ -11379,9 +11471,9 @@ type MeetingTemplateCreateVariables = {
|
|
|
11379
11471
|
* * Host user must have a Zoom Meetings Basic license or higher.
|
|
11380
11472
|
* * You can only create up to 40 meeting templates.
|
|
11381
11473
|
*
|
|
11382
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
11474
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
11383
11475
|
*
|
|
11384
|
-
* **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`
|
|
11385
11477
|
*
|
|
11386
11478
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
11387
11479
|
*/
|
|
@@ -11578,9 +11670,9 @@ type MeetingsVariables = {
|
|
|
11578
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).
|
|
11579
11671
|
* * When `type` is set to `upcoming`, `upcoming_meetings`, or `previous_meetings`, only a maximum of 6 months of meeting data will be returned.
|
|
11580
11672
|
*
|
|
11581
|
-
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
11673
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
11582
11674
|
*
|
|
11583
|
-
* **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`
|
|
11584
11676
|
*
|
|
11585
11677
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
11586
11678
|
*/
|
|
@@ -12529,6 +12621,12 @@ type MeetingCreateResponse = {
|
|
|
12529
12621
|
* @example 1
|
|
12530
12622
|
*/
|
|
12531
12623
|
who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
|
|
12624
|
+
/**
|
|
12625
|
+
* The summary template ID used to generate a meeting summary based on a predefined template. To get available summary templates, use the **Get user summary templates** API.
|
|
12626
|
+
*
|
|
12627
|
+
* @example 1e1356ad
|
|
12628
|
+
*/
|
|
12629
|
+
summary_template_id?: string;
|
|
12532
12630
|
/**
|
|
12533
12631
|
* Enable the device testing.
|
|
12534
12632
|
*
|
|
@@ -12550,6 +12648,12 @@ type MeetingCreateResponse = {
|
|
|
12550
12648
|
* @default false
|
|
12551
12649
|
*/
|
|
12552
12650
|
disable_participant_video?: boolean;
|
|
12651
|
+
/**
|
|
12652
|
+
* Whether to include authenticated guest's email addresses in meetings' attendee reports.
|
|
12653
|
+
*
|
|
12654
|
+
* @example true
|
|
12655
|
+
*/
|
|
12656
|
+
email_in_attendee_report?: boolean;
|
|
12553
12657
|
};
|
|
12554
12658
|
/**
|
|
12555
12659
|
* Meeting start date-time in UTC/GMT, such as `2020-03-31T12:02:00Z`.
|
|
@@ -12606,7 +12710,7 @@ type MeetingCreateResponse = {
|
|
|
12606
12710
|
visible?: boolean;
|
|
12607
12711
|
}[];
|
|
12608
12712
|
/**
|
|
12609
|
-
* The type
|
|
12713
|
+
* The meeting type.
|
|
12610
12714
|
* * `1` - An instant meeting.
|
|
12611
12715
|
* * `2` - A scheduled meeting.
|
|
12612
12716
|
* * `3` - A recurring meeting with no fixed time.
|
|
@@ -13396,6 +13500,12 @@ type MeetingCreateRequestBody = {
|
|
|
13396
13500
|
* @example 1
|
|
13397
13501
|
*/
|
|
13398
13502
|
who_can_ask_questions?: 1 | 2 | 3 | 4 | 5;
|
|
13503
|
+
/**
|
|
13504
|
+
* The summary template ID used to generate a meeting summary based on a predefined template. To get available summary templates, use the **Get user summary templates** API.
|
|
13505
|
+
*
|
|
13506
|
+
* @example 1e1356ad
|
|
13507
|
+
*/
|
|
13508
|
+
summary_template_id?: string;
|
|
13399
13509
|
/**
|
|
13400
13510
|
* Enable the device testing.
|
|
13401
13511
|
*
|
|
@@ -13417,6 +13527,12 @@ type MeetingCreateRequestBody = {
|
|
|
13417
13527
|
* @default false
|
|
13418
13528
|
*/
|
|
13419
13529
|
disable_participant_video?: boolean;
|
|
13530
|
+
/**
|
|
13531
|
+
* Whether to include authenticated guest's email addresses in meetings' attendee reports.
|
|
13532
|
+
*
|
|
13533
|
+
* @example true
|
|
13534
|
+
*/
|
|
13535
|
+
email_in_attendee_report?: boolean;
|
|
13420
13536
|
};
|
|
13421
13537
|
/**
|
|
13422
13538
|
* The meeting's start time. This field is only used for scheduled or recurring meetings with a fixed time. This supports local time and GMT formats.
|
|
@@ -13494,9 +13610,9 @@ type MeetingCreateVariables = {
|
|
|
13494
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.
|
|
13495
13611
|
* * **100 requests per day**. The rate limit is applied against the `userId` of the **meeting host** used to make the request.
|
|
13496
13612
|
*
|
|
13497
|
-
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
13613
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
13498
13614
|
*
|
|
13499
|
-
* **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`
|
|
13500
13616
|
*
|
|
13501
13617
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
13502
13618
|
*/
|
|
@@ -13603,9 +13719,9 @@ type ListUpcomingMeetingVariables = {
|
|
|
13603
13719
|
* **Prerequisites**:
|
|
13604
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.
|
|
13605
13721
|
*
|
|
13606
|
-
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
13722
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
13607
13723
|
*
|
|
13608
|
-
* **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`
|
|
13609
13725
|
*
|
|
13610
13726
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
13611
13727
|
*/
|
|
@@ -13693,9 +13809,9 @@ type UserPACsVariables = {
|
|
|
13693
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.
|
|
13694
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.
|
|
13695
13811
|
*
|
|
13696
|
-
* **Scopes:** `pac:read:admin`,`pac:read`
|
|
13812
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `pac:read:admin`,`pac:read`
|
|
13697
13813
|
*
|
|
13698
|
-
* **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`
|
|
13699
13815
|
*
|
|
13700
13816
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
13701
13817
|
*/
|
|
@@ -13812,9 +13928,9 @@ type ReportSignInSignOutActivitiesVariables = {
|
|
|
13812
13928
|
*
|
|
13813
13929
|
*
|
|
13814
13930
|
*
|
|
13815
|
-
* **Scopes:** `report:read:admin`
|
|
13931
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
13816
13932
|
*
|
|
13817
|
-
* **Granular Scopes:** `report:read:user_activities:admin`
|
|
13933
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:user_activities:admin`
|
|
13818
13934
|
*
|
|
13819
13935
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
13820
13936
|
*/
|
|
@@ -13883,9 +13999,9 @@ type GetBillingReportVariables = FetcherExtraProps;
|
|
|
13883
13999
|
*
|
|
13884
14000
|
*
|
|
13885
14001
|
*
|
|
13886
|
-
* **Scopes:** `report:read:admin`
|
|
14002
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
13887
14003
|
*
|
|
13888
|
-
* **Granular Scopes:** `report:read:billing:admin`
|
|
14004
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:billing:admin`
|
|
13889
14005
|
*
|
|
13890
14006
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
13891
14007
|
*/
|
|
@@ -13965,9 +14081,9 @@ type GetBillingInvoicesReportsVariables = {
|
|
|
13965
14081
|
*
|
|
13966
14082
|
*
|
|
13967
14083
|
*
|
|
13968
|
-
* **Scopes:** `report:read:admin`
|
|
14084
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
13969
14085
|
*
|
|
13970
|
-
* **Granular Scopes:** `report:read:billing_invoice:admin`
|
|
14086
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:billing_invoice:admin`
|
|
13971
14087
|
*
|
|
13972
14088
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
13973
14089
|
*/
|
|
@@ -14055,7 +14171,7 @@ type ReportCloudRecordingVariables = {
|
|
|
14055
14171
|
*
|
|
14056
14172
|
*
|
|
14057
14173
|
*
|
|
14058
|
-
* **Scopes:** `report:read:admin`
|
|
14174
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
14059
14175
|
*
|
|
14060
14176
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
14061
14177
|
*/
|
|
@@ -14074,7 +14190,7 @@ type ReportDailyQueryParams = {
|
|
|
14074
14190
|
*/
|
|
14075
14191
|
month?: number;
|
|
14076
14192
|
/**
|
|
14077
|
-
* The group ID. To get a group ID, use the [**List groups**](/
|
|
14193
|
+
* The group ID. To get a group ID, use the [**List groups**](/docs/api/users/#tag/groups/GET/groups) API.
|
|
14078
14194
|
*
|
|
14079
14195
|
* **Note:** The API response will only contain users who are members of the queried group ID.
|
|
14080
14196
|
*
|
|
@@ -14145,9 +14261,9 @@ type ReportDailyVariables = {
|
|
|
14145
14261
|
*
|
|
14146
14262
|
*
|
|
14147
14263
|
*
|
|
14148
|
-
* **Scopes:** `report:read:admin`
|
|
14264
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
14149
14265
|
*
|
|
14150
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `
|
|
14266
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
14151
14267
|
*/
|
|
14152
14268
|
declare const reportDaily: (variables: ReportDailyVariables, signal?: AbortSignal) => Promise<ReportDailyResponse>;
|
|
14153
14269
|
type GethistorymeetingandwebinarlistQueryParams = {
|
|
@@ -14572,9 +14688,9 @@ type GethistorymeetingandwebinarlistVariables = {
|
|
|
14572
14688
|
/**
|
|
14573
14689
|
* Retrieve a list of history meetings and webinars.
|
|
14574
14690
|
*
|
|
14575
|
-
* **Scopes:** `report:read:admin`
|
|
14691
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
14576
14692
|
*
|
|
14577
|
-
* **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`
|
|
14578
14694
|
*
|
|
14579
14695
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
14580
14696
|
*/
|
|
@@ -14709,9 +14825,9 @@ type ReportMeetingactivitylogsVariables = {
|
|
|
14709
14825
|
/**
|
|
14710
14826
|
* Retrieve a list of a meeting activity logs. Contact Zoom Support to enable the meeting audit trail log feature on your account.
|
|
14711
14827
|
*
|
|
14712
|
-
* **Scopes:** `report:read:admin`
|
|
14828
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
14713
14829
|
*
|
|
14714
|
-
* **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`
|
|
14715
14831
|
*
|
|
14716
14832
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
14717
14833
|
*/
|
|
@@ -14854,9 +14970,9 @@ type ReportMeetingDetailsVariables = {
|
|
|
14854
14970
|
*
|
|
14855
14971
|
*
|
|
14856
14972
|
*
|
|
14857
|
-
* **Scopes:** `report:read:admin`
|
|
14973
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
14858
14974
|
*
|
|
14859
|
-
* **Granular Scopes:** `report:read:meeting:admin`
|
|
14975
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:meeting:admin`
|
|
14860
14976
|
*
|
|
14861
14977
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
14862
14978
|
*/
|
|
@@ -15034,9 +15150,9 @@ type ReportMeetingParticipantsVariables = {
|
|
|
15034
15150
|
* **Prerequisites:**
|
|
15035
15151
|
* * A Pro or a higher plan.
|
|
15036
15152
|
*
|
|
15037
|
-
* **Scopes:** `report:read:admin`
|
|
15153
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
15038
15154
|
*
|
|
15039
|
-
* **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`
|
|
15040
15156
|
*
|
|
15041
15157
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
15042
15158
|
*/
|
|
@@ -15140,9 +15256,9 @@ type ReportMeetingPollsVariables = {
|
|
|
15140
15256
|
* **Prerequisites:**
|
|
15141
15257
|
* * A Pro or a higher plan.
|
|
15142
15258
|
*
|
|
15143
|
-
* **Scopes:** `report:read:admin`
|
|
15259
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
15144
15260
|
*
|
|
15145
|
-
* **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`
|
|
15146
15262
|
*
|
|
15147
15263
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
15148
15264
|
*/
|
|
@@ -15298,9 +15414,9 @@ type ReportMeetingQAVariables = {
|
|
|
15298
15414
|
*
|
|
15299
15415
|
* * Pro plan or higher.
|
|
15300
15416
|
*
|
|
15301
|
-
* **Scopes:** `report:read:admin`
|
|
15417
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
15302
15418
|
*
|
|
15303
|
-
* **Granular Scopes:** `report:read:meeting_qna:admin`
|
|
15419
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:meeting_qna:admin`
|
|
15304
15420
|
*
|
|
15305
15421
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
15306
15422
|
*/
|
|
@@ -15418,9 +15534,9 @@ type ReportMeetingSurveyVariables = {
|
|
|
15418
15534
|
*
|
|
15419
15535
|
* * Pro or a higher plan.
|
|
15420
15536
|
*
|
|
15421
|
-
* **Scopes:** `report:read:admin`
|
|
15537
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
15422
15538
|
*
|
|
15423
|
-
* **Granular Scopes:** `report:read:meeting_survey:admin`
|
|
15539
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:meeting_survey:admin`
|
|
15424
15540
|
*
|
|
15425
15541
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
15426
15542
|
*/
|
|
@@ -15541,9 +15657,9 @@ type ReportOperationLogsVariables = {
|
|
|
15541
15657
|
*
|
|
15542
15658
|
* * Pro or higher plan.
|
|
15543
15659
|
*
|
|
15544
|
-
* **Scopes:** `report:read:admin`
|
|
15660
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
15545
15661
|
*
|
|
15546
|
-
* **Granular Scopes:** `report:read:operation_logs:admin`
|
|
15662
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:operation_logs:admin`
|
|
15547
15663
|
*
|
|
15548
15664
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
15549
15665
|
*/
|
|
@@ -15774,9 +15890,9 @@ type ReportTelephoneVariables = {
|
|
|
15774
15890
|
*
|
|
15775
15891
|
* * Pro or higher plan.
|
|
15776
15892
|
*
|
|
15777
|
-
* **Scopes:** `report:read:admin`
|
|
15893
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
15778
15894
|
*
|
|
15779
|
-
* **Granular Scopes:** `report:read:telephone:admin`
|
|
15895
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:telephone:admin`
|
|
15780
15896
|
*
|
|
15781
15897
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
15782
15898
|
*/
|
|
@@ -15912,9 +16028,9 @@ type ReportUpcomingEventsVariables = {
|
|
|
15912
16028
|
* **Prerequisites:**
|
|
15913
16029
|
* * A Pro or higher plan
|
|
15914
16030
|
*
|
|
15915
|
-
* **Scopes:** `report:read:admin`
|
|
16031
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
15916
16032
|
*
|
|
15917
|
-
* **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`
|
|
15918
16034
|
*
|
|
15919
16035
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
15920
16036
|
*/
|
|
@@ -16143,9 +16259,9 @@ type ReportUsersVariables = {
|
|
|
16143
16259
|
*
|
|
16144
16260
|
* * Pro or higher plan.
|
|
16145
16261
|
*
|
|
16146
|
-
* **Scopes:** `report:read:admin`
|
|
16262
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
16147
16263
|
*
|
|
16148
|
-
* **Granular Scopes:** `report:read:list_users:admin`
|
|
16264
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_users:admin`
|
|
16149
16265
|
*
|
|
16150
16266
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
16151
16267
|
*/
|
|
@@ -16451,9 +16567,9 @@ type ReportMeetingsVariables = {
|
|
|
16451
16567
|
*
|
|
16452
16568
|
* * Pro or higher plan.
|
|
16453
16569
|
*
|
|
16454
|
-
* **Scopes:** `report:read:admin`
|
|
16570
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
16455
16571
|
*
|
|
16456
|
-
* **Granular Scopes:** `report:read:user:admin`
|
|
16572
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:user:admin`
|
|
16457
16573
|
*
|
|
16458
16574
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
16459
16575
|
*/
|
|
@@ -16597,9 +16713,9 @@ type ReportWebinarDetailsVariables = {
|
|
|
16597
16713
|
*
|
|
16598
16714
|
* * Pro or higher plan with Webinar add-on.
|
|
16599
16715
|
*
|
|
16600
|
-
* **Scopes:** `report:read:admin`
|
|
16716
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
16601
16717
|
*
|
|
16602
|
-
* **Granular Scopes:** `report:read:webinar:admin`
|
|
16718
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:webinar:admin`
|
|
16603
16719
|
*
|
|
16604
16720
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
16605
16721
|
*/
|
|
@@ -16771,9 +16887,9 @@ type ReportWebinarParticipantsVariables = {
|
|
|
16771
16887
|
* **Prerequisites:**
|
|
16772
16888
|
* * A Pro or a higher plan with Webinar add-on enabled.
|
|
16773
16889
|
*
|
|
16774
|
-
* **Scopes:** `report:read:admin`
|
|
16890
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
16775
16891
|
*
|
|
16776
|
-
* **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`
|
|
16777
16893
|
*
|
|
16778
16894
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
16779
16895
|
*/
|
|
@@ -16881,9 +16997,9 @@ type ReportWebinarPollsVariables = {
|
|
|
16881
16997
|
*
|
|
16882
16998
|
* * Pro or a higher plan with Webinar add-on enabled.
|
|
16883
16999
|
*
|
|
16884
|
-
* **Scopes:** `report:read:admin`
|
|
17000
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
16885
17001
|
*
|
|
16886
|
-
* **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`
|
|
16887
17003
|
*
|
|
16888
17004
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
16889
17005
|
*/
|
|
@@ -17041,9 +17157,9 @@ type ReportWebinarQAVariables = {
|
|
|
17041
17157
|
*
|
|
17042
17158
|
* * Pro or a higher plan with the Webinar add-on enabled.
|
|
17043
17159
|
*
|
|
17044
|
-
* **Scopes:** `report:read:admin`
|
|
17160
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
17045
17161
|
*
|
|
17046
|
-
* **Granular Scopes:** `report:read:webinar_qna:admin`
|
|
17162
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:webinar_qna:admin`
|
|
17047
17163
|
*
|
|
17048
17164
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
17049
17165
|
*/
|
|
@@ -17163,9 +17279,9 @@ type ReportWebinarSurveyVariables = {
|
|
|
17163
17279
|
*
|
|
17164
17280
|
* * Pro or a higher plan with Webinar add-on enabled.
|
|
17165
17281
|
*
|
|
17166
|
-
* **Scopes:** `report:read:admin`
|
|
17282
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
17167
17283
|
*
|
|
17168
|
-
* **Granular Scopes:** `report:read:webinar_survey:admin`
|
|
17284
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:webinar_survey:admin`
|
|
17169
17285
|
*
|
|
17170
17286
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
17171
17287
|
*/
|
|
@@ -17352,9 +17468,9 @@ type ListSipPhonesVariables = {
|
|
|
17352
17468
|
* * User must enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.
|
|
17353
17469
|
*
|
|
17354
17470
|
*
|
|
17355
|
-
* **Scopes:** `sip_phone:read:admin`
|
|
17471
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:read:admin`
|
|
17356
17472
|
*
|
|
17357
|
-
* **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`
|
|
17358
17474
|
*
|
|
17359
17475
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
17360
17476
|
*/
|
|
@@ -17600,9 +17716,9 @@ type CreateSIPPhoneVariables = {
|
|
|
17600
17716
|
* * The account owner or account admin must first enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.
|
|
17601
17717
|
*
|
|
17602
17718
|
*
|
|
17603
|
-
* **Scopes:** `sip_phone:write:admin`
|
|
17719
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin`
|
|
17604
17720
|
*
|
|
17605
|
-
* **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`
|
|
17606
17722
|
*
|
|
17607
17723
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
17608
17724
|
*/
|
|
@@ -17698,6 +17814,13 @@ type ListSIPPhonePhonesResponse = {
|
|
|
17698
17814
|
* @example 4000
|
|
17699
17815
|
*/
|
|
17700
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;
|
|
17701
17824
|
/**
|
|
17702
17825
|
* Defined a set of basic components of SIP network architecture, including proxy_server, register_server and transport_protocol.
|
|
17703
17826
|
*/
|
|
@@ -17785,9 +17908,9 @@ type ListSIPPhonePhonesVariables = {
|
|
|
17785
17908
|
* * User must enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.
|
|
17786
17909
|
*
|
|
17787
17910
|
*
|
|
17788
|
-
* **Scopes:** `sip_phone:read:admin`
|
|
17911
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:read:admin`
|
|
17789
17912
|
*
|
|
17790
|
-
* **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`
|
|
17791
17914
|
*
|
|
17792
17915
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
17793
17916
|
*/
|
|
@@ -17851,6 +17974,13 @@ type EnableSIPPhonePhonesResponse = {
|
|
|
17851
17974
|
* @example 4000
|
|
17852
17975
|
*/
|
|
17853
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;
|
|
17854
17984
|
/**
|
|
17855
17985
|
* Defined a set of basic components of SIP network architecture, including proxy_server, register_server and transport_protocol.
|
|
17856
17986
|
*/
|
|
@@ -17976,6 +18106,13 @@ type EnableSIPPhonePhonesRequestBody = {
|
|
|
17976
18106
|
* @example 4000
|
|
17977
18107
|
*/
|
|
17978
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;
|
|
17979
18116
|
/**
|
|
17980
18117
|
* Defined a set of basic components of SIP network architecture, including proxy_server, register_server and transport_protocol.
|
|
17981
18118
|
*/
|
|
@@ -18063,9 +18200,9 @@ type EnableSIPPhonePhonesVariables = {
|
|
|
18063
18200
|
* * The account owner or account admin must first enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.
|
|
18064
18201
|
*
|
|
18065
18202
|
*
|
|
18066
|
-
* **Scopes:** `sip_phone:write:admin`
|
|
18203
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin`
|
|
18067
18204
|
*
|
|
18068
|
-
* **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`
|
|
18069
18206
|
*
|
|
18070
18207
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18071
18208
|
*/
|
|
@@ -18089,9 +18226,9 @@ type DeleteSIPPhonePhonesVariables = {
|
|
|
18089
18226
|
* * Currently only supported on Cisco and Avaya PBX systems.
|
|
18090
18227
|
* * The user must enable **SIP Phone Integration** by contacting the [Zoom Sales](https://zoom.us/contactsales) team.
|
|
18091
18228
|
*
|
|
18092
|
-
* **Scopes:** `sip_phone:write:admin`
|
|
18229
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin`
|
|
18093
18230
|
*
|
|
18094
|
-
* **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`
|
|
18095
18232
|
*
|
|
18096
18233
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18097
18234
|
*/
|
|
@@ -18150,72 +18287,79 @@ type UpdateSIPPhonePhonesRequestBody = {
|
|
|
18150
18287
|
*/
|
|
18151
18288
|
voice_mail?: string;
|
|
18152
18289
|
/**
|
|
18153
|
-
*
|
|
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.
|
|
18154
18298
|
*/
|
|
18155
18299
|
server?: {
|
|
18156
18300
|
/**
|
|
18157
|
-
* 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.
|
|
18158
18302
|
*
|
|
18159
18303
|
* @example 192.0.2.2
|
|
18160
18304
|
*/
|
|
18161
18305
|
proxy_server?: string;
|
|
18162
18306
|
/**
|
|
18163
|
-
* 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.
|
|
18164
18308
|
*
|
|
18165
18309
|
* @example 192.0.2.2
|
|
18166
18310
|
*/
|
|
18167
18311
|
register_server?: string;
|
|
18168
18312
|
/**
|
|
18169
18313
|
* Protocols supported by the SIP provider.
|
|
18170
|
-
*
|
|
18314
|
+
* The value must be either `UDP`, `TCP`, `TLS`, `AUTO`.
|
|
18171
18315
|
*
|
|
18172
18316
|
* @example UDP
|
|
18173
18317
|
*/
|
|
18174
18318
|
transport_protocol?: 'UDP' | 'TCP' | 'TLS' | 'AUTO';
|
|
18175
18319
|
};
|
|
18176
18320
|
/**
|
|
18177
|
-
* 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.
|
|
18178
18322
|
*/
|
|
18179
18323
|
server_2?: {
|
|
18180
18324
|
/**
|
|
18181
|
-
* 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.
|
|
18182
18326
|
*
|
|
18183
18327
|
* @example 192.0.2.2
|
|
18184
18328
|
*/
|
|
18185
18329
|
proxy_server?: string;
|
|
18186
18330
|
/**
|
|
18187
|
-
* 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.
|
|
18188
18332
|
*
|
|
18189
18333
|
* @example 192.0.2.2
|
|
18190
18334
|
*/
|
|
18191
18335
|
register_server?: string;
|
|
18192
18336
|
/**
|
|
18193
18337
|
* Protocols supported by the SIP provider.
|
|
18194
|
-
*
|
|
18338
|
+
* The value must be either `UDP`, `TCP`, `TLS`, `AUTO`.
|
|
18195
18339
|
*
|
|
18196
18340
|
* @example UDP
|
|
18197
18341
|
*/
|
|
18198
18342
|
transport_protocol?: 'UDP' | 'TCP' | 'TLS' | 'AUTO';
|
|
18199
18343
|
};
|
|
18200
18344
|
/**
|
|
18201
|
-
* 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.
|
|
18202
18346
|
*/
|
|
18203
18347
|
server_3?: {
|
|
18204
18348
|
/**
|
|
18205
|
-
* 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.
|
|
18206
18350
|
*
|
|
18207
18351
|
* @example 192.0.2.2
|
|
18208
18352
|
*/
|
|
18209
18353
|
proxy_server?: string;
|
|
18210
18354
|
/**
|
|
18211
|
-
* 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.
|
|
18212
18356
|
*
|
|
18213
18357
|
* @example 192.0.2.2
|
|
18214
18358
|
*/
|
|
18215
18359
|
register_server?: string;
|
|
18216
18360
|
/**
|
|
18217
18361
|
* Protocols supported by the SIP provider.
|
|
18218
|
-
*
|
|
18362
|
+
* The value must be either `UDP`, `TCP`, `TLS`, `AUTO`.
|
|
18219
18363
|
*
|
|
18220
18364
|
* @example UDP
|
|
18221
18365
|
*/
|
|
@@ -18237,9 +18381,9 @@ type UpdateSIPPhonePhonesVariables = {
|
|
|
18237
18381
|
* * The account owner or account admin must first enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.
|
|
18238
18382
|
*
|
|
18239
18383
|
*
|
|
18240
|
-
* **Scopes:** `sip_phone:write:admin`
|
|
18384
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin`
|
|
18241
18385
|
*
|
|
18242
|
-
* **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`
|
|
18243
18387
|
*
|
|
18244
18388
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18245
18389
|
*/
|
|
@@ -18263,9 +18407,9 @@ type DeleteSIPPhoneVariables = {
|
|
|
18263
18407
|
* * Currently only supported on Cisco and Avaya PBX systems.
|
|
18264
18408
|
* * The user must enable **SIP Phone Integration** by contacting the [Zoom Sales](https://zoom.us/contactsales) team.
|
|
18265
18409
|
*
|
|
18266
|
-
* **Scopes:** `sip_phone:write:admin`
|
|
18410
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin`
|
|
18267
18411
|
*
|
|
18268
|
-
* **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`
|
|
18269
18413
|
*
|
|
18270
18414
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18271
18415
|
*/
|
|
@@ -18388,9 +18532,9 @@ type UpdateSIPPhoneVariables = {
|
|
|
18388
18532
|
/**
|
|
18389
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.
|
|
18390
18534
|
*
|
|
18391
|
-
* **Scopes:** `sip_phone:write:admin`
|
|
18535
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin`
|
|
18392
18536
|
*
|
|
18393
|
-
* **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`
|
|
18394
18538
|
*
|
|
18395
18539
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18396
18540
|
*/
|
|
@@ -18470,9 +18614,9 @@ type TspVariables = FetcherExtraProps;
|
|
|
18470
18614
|
*
|
|
18471
18615
|
* * A Pro or a higher plan.
|
|
18472
18616
|
*
|
|
18473
|
-
* **Scopes:** `tsp:read:admin`
|
|
18617
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:admin`
|
|
18474
18618
|
*
|
|
18475
|
-
* **Granular Scopes:** `tsp:read:tsp:admin`
|
|
18619
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:tsp:admin`
|
|
18476
18620
|
*
|
|
18477
18621
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18478
18622
|
*/
|
|
@@ -18534,9 +18678,9 @@ type TspUpdateVariables = {
|
|
|
18534
18678
|
*
|
|
18535
18679
|
*
|
|
18536
18680
|
*
|
|
18537
|
-
* **Scopes:** `tsp:write:admin`
|
|
18681
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`
|
|
18538
18682
|
*
|
|
18539
|
-
* **Granular Scopes:** `tsp:update:tsp:admin`
|
|
18683
|
+
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:update:tsp:admin`
|
|
18540
18684
|
*
|
|
18541
18685
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18542
18686
|
*/
|
|
@@ -18623,9 +18767,9 @@ type UserTSPsVariables = {
|
|
|
18623
18767
|
/**
|
|
18624
18768
|
* List all of a user's TSP accounts. A user can have a maximum of two TSP accounts.
|
|
18625
18769
|
*
|
|
18626
|
-
* **Scopes:** `tsp:read:admin`,`tsp:read`
|
|
18770
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:admin`,`tsp:read`
|
|
18627
18771
|
*
|
|
18628
|
-
* **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`
|
|
18629
18773
|
*
|
|
18630
18774
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
18631
18775
|
*/
|
|
@@ -18775,9 +18919,9 @@ type UserTSPCreateVariables = {
|
|
|
18775
18919
|
*
|
|
18776
18920
|
*
|
|
18777
18921
|
*
|
|
18778
|
-
* **Scopes:** `tsp:write:admin`,`tsp:write`
|
|
18922
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`,`tsp:write`
|
|
18779
18923
|
*
|
|
18780
|
-
* **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`
|
|
18781
18925
|
*
|
|
18782
18926
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18783
18927
|
*/
|
|
@@ -18808,9 +18952,9 @@ type TspUrlUpdateVariables = {
|
|
|
18808
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.
|
|
18809
18953
|
*
|
|
18810
18954
|
*
|
|
18811
|
-
* **Scopes:** `tsp:write:admin`,`tsp:write`
|
|
18955
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`,`tsp:write`
|
|
18812
18956
|
*
|
|
18813
|
-
* **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`
|
|
18814
18958
|
*
|
|
18815
18959
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18816
18960
|
*/
|
|
@@ -18904,9 +19048,9 @@ type UserTSPVariables = {
|
|
|
18904
19048
|
*
|
|
18905
19049
|
*
|
|
18906
19050
|
*
|
|
18907
|
-
* **Scopes:** `tsp:read:admin`,`tsp:read`
|
|
19051
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:admin`,`tsp:read`
|
|
18908
19052
|
*
|
|
18909
|
-
* **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`
|
|
18910
19054
|
*
|
|
18911
19055
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18912
19056
|
*/
|
|
@@ -18933,9 +19077,9 @@ type UserTSPDeleteVariables = {
|
|
|
18933
19077
|
*
|
|
18934
19078
|
*
|
|
18935
19079
|
*
|
|
18936
|
-
* **Scopes:** `tsp:write:admin`,`tsp:write`
|
|
19080
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`,`tsp:write`
|
|
18937
19081
|
*
|
|
18938
|
-
* **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`
|
|
18939
19083
|
*
|
|
18940
19084
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
18941
19085
|
*/
|
|
@@ -19023,9 +19167,9 @@ type UserTSPUpdateVariables = {
|
|
|
19023
19167
|
*
|
|
19024
19168
|
*
|
|
19025
19169
|
*
|
|
19026
|
-
* **Scopes:** `tsp:write:admin`,`tsp:write`
|
|
19170
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`,`tsp:write`
|
|
19027
19171
|
*
|
|
19028
|
-
* **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`
|
|
19029
19173
|
*
|
|
19030
19174
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
19031
19175
|
*/
|
|
@@ -19079,9 +19223,9 @@ type TrackingfieldListVariables = FetcherExtraProps;
|
|
|
19079
19223
|
* **Prerequisites:**
|
|
19080
19224
|
* * A Business, Education, API or higher plan.
|
|
19081
19225
|
*
|
|
19082
|
-
* **Scopes:** `tracking_fields:read:admin`
|
|
19226
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:read:admin`
|
|
19083
19227
|
*
|
|
19084
|
-
* **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`
|
|
19085
19229
|
*
|
|
19086
19230
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
19087
19231
|
*/
|
|
@@ -19150,9 +19294,9 @@ type TrackingfieldCreateVariables = {
|
|
|
19150
19294
|
* **Prerequisites:**
|
|
19151
19295
|
* * A Business, Education, API or higher plan.
|
|
19152
19296
|
*
|
|
19153
|
-
* **Scopes:** `tracking_fields:write:admin`
|
|
19297
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:write:admin`
|
|
19154
19298
|
*
|
|
19155
|
-
* **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`
|
|
19156
19300
|
*
|
|
19157
19301
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
19158
19302
|
*/
|
|
@@ -19205,9 +19349,9 @@ type TrackingfieldGetVariables = {
|
|
|
19205
19349
|
* **Prerequisites:**
|
|
19206
19350
|
* * A Business, Education, API or higher plan.
|
|
19207
19351
|
*
|
|
19208
|
-
* **Scopes:** `tracking_fields:read:admin`
|
|
19352
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:read:admin`
|
|
19209
19353
|
*
|
|
19210
|
-
* **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`
|
|
19211
19355
|
*
|
|
19212
19356
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
19213
19357
|
*/
|
|
@@ -19230,9 +19374,9 @@ type TrackingfieldDeleteVariables = {
|
|
|
19230
19374
|
* **Prerequisites:**
|
|
19231
19375
|
* * A Business, Education, API or higher plan.
|
|
19232
19376
|
*
|
|
19233
|
-
* **Scopes:** `tracking_fields:write:admin`
|
|
19377
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:write:admin`
|
|
19234
19378
|
*
|
|
19235
|
-
* **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`
|
|
19236
19380
|
*
|
|
19237
19381
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
19238
19382
|
*/
|
|
@@ -19280,9 +19424,9 @@ type TrackingfieldUpdateVariables = {
|
|
|
19280
19424
|
* **Prerequisites:**
|
|
19281
19425
|
* * A Business, Education, API or higher plan.
|
|
19282
19426
|
*
|
|
19283
|
-
* **Scopes:** `tracking_fields:write:admin`
|
|
19427
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:write:admin`
|
|
19284
19428
|
*
|
|
19285
|
-
* **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`
|
|
19286
19430
|
*
|
|
19287
19431
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
19288
19432
|
*/
|
|
@@ -19321,9 +19465,9 @@ type DeleteWebinarChatMessageByIdVariables = {
|
|
|
19321
19465
|
* **Prerequisites:**
|
|
19322
19466
|
* * Have Zoom enable the DLP for the in-meeting chat feature to use this API.
|
|
19323
19467
|
*
|
|
19324
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
19468
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
19325
19469
|
*
|
|
19326
|
-
* **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`
|
|
19327
19471
|
*
|
|
19328
19472
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
19329
19473
|
*/
|
|
@@ -19577,9 +19721,9 @@ type WebinarAbsenteesVariables = {
|
|
|
19577
19721
|
*
|
|
19578
19722
|
*
|
|
19579
19723
|
*
|
|
19580
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
19724
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
19581
19725
|
*
|
|
19582
|
-
* **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`
|
|
19583
19727
|
*
|
|
19584
19728
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
19585
19729
|
*/
|
|
@@ -19623,9 +19767,9 @@ type PastWebinarsVariables = {
|
|
|
19623
19767
|
*
|
|
19624
19768
|
*
|
|
19625
19769
|
*
|
|
19626
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
19770
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
19627
19771
|
*
|
|
19628
|
-
* **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`
|
|
19629
19773
|
*
|
|
19630
19774
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
19631
19775
|
*/
|
|
@@ -19771,9 +19915,9 @@ type ListWebinarParticipantsVariables = {
|
|
|
19771
19915
|
* **Prerequisites:**
|
|
19772
19916
|
* * A Pro or higher plan with a webinar add-on.
|
|
19773
19917
|
*
|
|
19774
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
19918
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
19775
19919
|
*
|
|
19776
|
-
* **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`
|
|
19777
19921
|
*
|
|
19778
19922
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
19779
19923
|
*/
|
|
@@ -19864,9 +20008,9 @@ type ListPastWebinarPollResultsVariables = {
|
|
|
19864
20008
|
*
|
|
19865
20009
|
*
|
|
19866
20010
|
*
|
|
19867
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
20011
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
19868
20012
|
*
|
|
19869
|
-
* **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`
|
|
19870
20014
|
*
|
|
19871
20015
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
19872
20016
|
*/
|
|
@@ -19946,9 +20090,9 @@ type ListPastWebinarQAVariables = {
|
|
|
19946
20090
|
*
|
|
19947
20091
|
*
|
|
19948
20092
|
*
|
|
19949
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
20093
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
19950
20094
|
*
|
|
19951
|
-
* **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`
|
|
19952
20096
|
*
|
|
19953
20097
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
19954
20098
|
*/
|
|
@@ -19999,9 +20143,9 @@ type ListWebinarTemplatesVariables = {
|
|
|
19999
20143
|
/**
|
|
20000
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).
|
|
20001
20145
|
*
|
|
20002
|
-
* **Scopes:** `webinar:read`,`webinar:read:admin`
|
|
20146
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read`,`webinar:read:admin`
|
|
20003
20147
|
*
|
|
20004
|
-
* **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`
|
|
20005
20149
|
*/
|
|
20006
20150
|
declare const listWebinarTemplates: (variables: ListWebinarTemplatesVariables, signal?: AbortSignal) => Promise<ListWebinarTemplatesResponse>;
|
|
20007
20151
|
type WebinarTemplateCreatePathParams = {
|
|
@@ -20065,9 +20209,9 @@ type WebinarTemplateCreateVariables = {
|
|
|
20065
20209
|
*
|
|
20066
20210
|
*
|
|
20067
20211
|
*
|
|
20068
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
20212
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
20069
20213
|
*
|
|
20070
|
-
* **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`
|
|
20071
20215
|
*
|
|
20072
20216
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
20073
20217
|
*/
|
|
@@ -20239,9 +20383,9 @@ type WebinarsVariables = {
|
|
|
20239
20383
|
* **Prerequisites**
|
|
20240
20384
|
* * A Pro or higher plan with the webinar add-on.
|
|
20241
20385
|
*
|
|
20242
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
20386
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
20243
20387
|
*
|
|
20244
|
-
* **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`
|
|
20245
20389
|
*
|
|
20246
20390
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
20247
20391
|
*/
|
|
@@ -20966,6 +21110,12 @@ type WebinarCreateResponse = {
|
|
|
20966
21110
|
* @default false
|
|
20967
21111
|
*/
|
|
20968
21112
|
allow_host_control_participant_mute_state?: boolean;
|
|
21113
|
+
/**
|
|
21114
|
+
* Whether to include guest's email addresses in attendee reports for webinars.
|
|
21115
|
+
*
|
|
21116
|
+
* @example true
|
|
21117
|
+
*/
|
|
21118
|
+
email_in_attendee_report?: boolean;
|
|
20969
21119
|
};
|
|
20970
21120
|
/**
|
|
20971
21121
|
* Webinar start time in GMT/UTC.
|
|
@@ -21038,6 +21188,12 @@ type WebinarCreateResponse = {
|
|
|
21038
21188
|
* @example f09340e1-cdc3-4eae-9a74-98f9777ed908
|
|
21039
21189
|
*/
|
|
21040
21190
|
record_file_id?: string;
|
|
21191
|
+
/**
|
|
21192
|
+
* Whether to transition a simulive webinar to live. The host must be present at the time of transition.
|
|
21193
|
+
*
|
|
21194
|
+
* @example false
|
|
21195
|
+
*/
|
|
21196
|
+
transition_to_live?: boolean;
|
|
21041
21197
|
/**
|
|
21042
21198
|
* The platform through which the meeting was created.
|
|
21043
21199
|
* * `other` - Created through another platform.
|
|
@@ -21663,6 +21819,12 @@ type WebinarCreateRequestBody = {
|
|
|
21663
21819
|
* @default false
|
|
21664
21820
|
*/
|
|
21665
21821
|
allow_host_control_participant_mute_state?: boolean;
|
|
21822
|
+
/**
|
|
21823
|
+
* Whether to include guest's email addresses in webinars' attendee reports.
|
|
21824
|
+
*
|
|
21825
|
+
* @example true
|
|
21826
|
+
*/
|
|
21827
|
+
email_in_attendee_report?: boolean;
|
|
21666
21828
|
};
|
|
21667
21829
|
/**
|
|
21668
21830
|
* Webinar start time. We support two formats for `start_time` - local time and GMT.
|
|
@@ -21737,6 +21899,12 @@ type WebinarCreateRequestBody = {
|
|
|
21737
21899
|
* @example f09340e1-cdc3-4eae-9a74-98f9777ed908
|
|
21738
21900
|
*/
|
|
21739
21901
|
record_file_id?: string;
|
|
21902
|
+
/**
|
|
21903
|
+
* Whether to transition a simulive webinar to live. The host must be present at the time of transition.
|
|
21904
|
+
*
|
|
21905
|
+
* @example false
|
|
21906
|
+
*/
|
|
21907
|
+
transition_to_live?: boolean;
|
|
21740
21908
|
};
|
|
21741
21909
|
type WebinarCreateVariables = {
|
|
21742
21910
|
body?: WebinarCreateRequestBody;
|
|
@@ -21753,9 +21921,9 @@ type WebinarCreateVariables = {
|
|
|
21753
21921
|
* **Prerequisites:**
|
|
21754
21922
|
* * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on.
|
|
21755
21923
|
*
|
|
21756
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
21924
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
21757
21925
|
*
|
|
21758
|
-
* **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`
|
|
21759
21927
|
*
|
|
21760
21928
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
21761
21929
|
*/
|
|
@@ -22483,6 +22651,12 @@ type WebinarResponse = {
|
|
|
22483
22651
|
* @default false
|
|
22484
22652
|
*/
|
|
22485
22653
|
allow_host_control_participant_mute_state?: boolean;
|
|
22654
|
+
/**
|
|
22655
|
+
* Whether to include guest's email addresses in webinars' attendee reports.
|
|
22656
|
+
*
|
|
22657
|
+
* @example true
|
|
22658
|
+
*/
|
|
22659
|
+
email_in_attendee_report?: boolean;
|
|
22486
22660
|
};
|
|
22487
22661
|
/**
|
|
22488
22662
|
* Webinar start time in GMT/UTC.
|
|
@@ -22555,6 +22729,12 @@ type WebinarResponse = {
|
|
|
22555
22729
|
* @example f09340e1-cdc3-4eae-9a74-98f9777ed908
|
|
22556
22730
|
*/
|
|
22557
22731
|
record_file_id?: string;
|
|
22732
|
+
/**
|
|
22733
|
+
* Whether to transition a simulive webinar to live. The host must be present at the time of transition.
|
|
22734
|
+
*
|
|
22735
|
+
* @example false
|
|
22736
|
+
*/
|
|
22737
|
+
transition_to_live?: boolean;
|
|
22558
22738
|
/**
|
|
22559
22739
|
* The platform used when creating the meeting.
|
|
22560
22740
|
* * `other` - Created through another platform.
|
|
@@ -22577,9 +22757,9 @@ type WebinarVariables = {
|
|
|
22577
22757
|
* **Prerequisites:**
|
|
22578
22758
|
* * Pro or higher plan with a Webinar add-on.
|
|
22579
22759
|
*
|
|
22580
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
22760
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
22581
22761
|
*
|
|
22582
|
-
* **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`
|
|
22583
22763
|
*
|
|
22584
22764
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
22585
22765
|
*/
|
|
@@ -22624,9 +22804,9 @@ type WebinarDeleteVariables = {
|
|
|
22624
22804
|
*
|
|
22625
22805
|
* * Pro or higher plan with the webinar add-on.
|
|
22626
22806
|
*
|
|
22627
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
22807
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
22628
22808
|
*
|
|
22629
|
-
* **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`
|
|
22630
22810
|
*
|
|
22631
22811
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
22632
22812
|
*/
|
|
@@ -23277,6 +23457,12 @@ type WebinarUpdateRequestBody = {
|
|
|
23277
23457
|
* @default false
|
|
23278
23458
|
*/
|
|
23279
23459
|
allow_host_control_participant_mute_state?: boolean;
|
|
23460
|
+
/**
|
|
23461
|
+
* Whether to include guest's email addresses in webinars' attendee reports.
|
|
23462
|
+
*
|
|
23463
|
+
* @example true
|
|
23464
|
+
*/
|
|
23465
|
+
email_in_attendee_report?: boolean;
|
|
23280
23466
|
};
|
|
23281
23467
|
/**
|
|
23282
23468
|
* Webinar start time, in the format `yyyy-MM-dd'T'HH:mm:ss'Z'`. Should be in GMT time. In the format `yyyy-MM-dd'T'HH:mm:ss`. This should be in local time and the timezone should be specified. Only used for scheduled webinars and recurring webinars with a fixed time.
|
|
@@ -23338,6 +23524,12 @@ type WebinarUpdateRequestBody = {
|
|
|
23338
23524
|
* @example f09340e1-cdc3-4eae-9a74-98f9777ed908
|
|
23339
23525
|
*/
|
|
23340
23526
|
record_file_id?: string;
|
|
23527
|
+
/**
|
|
23528
|
+
* Whether to transition a simulive webinar to live. The host must be present at the time of transition.
|
|
23529
|
+
*
|
|
23530
|
+
* @example false
|
|
23531
|
+
*/
|
|
23532
|
+
transition_to_live?: boolean;
|
|
23341
23533
|
};
|
|
23342
23534
|
type WebinarUpdateVariables = {
|
|
23343
23535
|
body?: WebinarUpdateRequestBody;
|
|
@@ -23352,9 +23544,9 @@ type WebinarUpdateVariables = {
|
|
|
23352
23544
|
* **Prerequisites**
|
|
23353
23545
|
* * A Pro or higher plan with a webinar add-on.
|
|
23354
23546
|
*
|
|
23355
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
23547
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
23356
23548
|
*
|
|
23357
|
-
* **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`
|
|
23358
23550
|
*
|
|
23359
23551
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
23360
23552
|
*/
|
|
@@ -23437,9 +23629,9 @@ type AddBatchWebinarRegistrantsVariables = {
|
|
|
23437
23629
|
*
|
|
23438
23630
|
*
|
|
23439
23631
|
*
|
|
23440
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
23632
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
23441
23633
|
*
|
|
23442
|
-
* **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`
|
|
23443
23635
|
*
|
|
23444
23636
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
23445
23637
|
*/
|
|
@@ -23537,9 +23729,9 @@ type GetWebinarBrandingVariables = {
|
|
|
23537
23729
|
/**
|
|
23538
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.
|
|
23539
23731
|
*
|
|
23540
|
-
* **Scopes:** `webinar:read`,`webinar:read:admin`
|
|
23732
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read`,`webinar:read:admin`
|
|
23541
23733
|
*
|
|
23542
|
-
* **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`
|
|
23543
23735
|
*
|
|
23544
23736
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
23545
23737
|
*/
|
|
@@ -23645,9 +23837,9 @@ type CreateWebinarBrandingNameTagVariables = {
|
|
|
23645
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:**
|
|
23646
23838
|
* * The **Webinar Session Branding** setting enabled.
|
|
23647
23839
|
*
|
|
23648
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
23840
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
23649
23841
|
*
|
|
23650
|
-
* **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`
|
|
23651
23843
|
*
|
|
23652
23844
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
23653
23845
|
*/
|
|
@@ -23680,9 +23872,9 @@ type DeleteWebinarBrandingNameTagVariables = {
|
|
|
23680
23872
|
* **Prerequisites:**
|
|
23681
23873
|
* * The **Webinar Session Branding** setting enabled.
|
|
23682
23874
|
*
|
|
23683
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
23875
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
23684
23876
|
*
|
|
23685
|
-
* **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`
|
|
23686
23878
|
*
|
|
23687
23879
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
23688
23880
|
*/
|
|
@@ -23756,9 +23948,9 @@ type UpdateWebinarBrandingNameTagVariables = {
|
|
|
23756
23948
|
* Update a webinar's [session branding](https://support.zoom.us/hc/en-us/articles/4836268732045-Using-Webinar-Session-Branding) name tag. **Prerequisites:**
|
|
23757
23949
|
* * The **Webinar Session Branding** setting enabled.
|
|
23758
23950
|
*
|
|
23759
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
23951
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
23760
23952
|
*
|
|
23761
|
-
* **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`
|
|
23762
23954
|
*
|
|
23763
23955
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
23764
23956
|
*/
|
|
@@ -23842,9 +24034,9 @@ type UploadWebinarBrandingVBVariables = {
|
|
|
23842
24034
|
* **Prerequisites:**
|
|
23843
24035
|
* * The **Webinar Session Branding** setting enabled.
|
|
23844
24036
|
*
|
|
23845
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
24037
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
23846
24038
|
*
|
|
23847
|
-
* **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`
|
|
23848
24040
|
*
|
|
23849
24041
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
23850
24042
|
*/
|
|
@@ -23877,9 +24069,9 @@ type DeleteWebinarBrandingVBVariables = {
|
|
|
23877
24069
|
* **Prerequisites:**
|
|
23878
24070
|
* * The **Webinar Session Branding** setting enabled.
|
|
23879
24071
|
*
|
|
23880
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
24072
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
23881
24073
|
*
|
|
23882
|
-
* **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`
|
|
23883
24075
|
*
|
|
23884
24076
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
23885
24077
|
*/
|
|
@@ -23918,9 +24110,9 @@ type SetWebinarBrandingVBVariables = {
|
|
|
23918
24110
|
* **Prerequisites:**
|
|
23919
24111
|
* * The **Webinar Session Branding** setting enabled.
|
|
23920
24112
|
*
|
|
23921
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
24113
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
23922
24114
|
*
|
|
23923
|
-
* **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`
|
|
23924
24116
|
*
|
|
23925
24117
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
23926
24118
|
*/
|
|
@@ -23984,9 +24176,9 @@ type UploadWebinarBrandingWallpaperVariables = {
|
|
|
23984
24176
|
* **Prerequisites:**
|
|
23985
24177
|
* * The **Webinar Session Branding** setting enabled.
|
|
23986
24178
|
*
|
|
23987
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
24179
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
23988
24180
|
*
|
|
23989
|
-
* **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`
|
|
23990
24182
|
*
|
|
23991
24183
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
23992
24184
|
*/
|
|
@@ -24010,9 +24202,9 @@ type DeleteWebinarBrandingWallpaperVariables = {
|
|
|
24010
24202
|
* **Prerequisites:**
|
|
24011
24203
|
* * The **Webinar Session Branding** setting enabled.
|
|
24012
24204
|
*
|
|
24013
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
24205
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
24014
24206
|
*
|
|
24015
|
-
* **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`
|
|
24016
24208
|
*
|
|
24017
24209
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24018
24210
|
*/
|
|
@@ -24103,9 +24295,9 @@ type WebinarInviteLinksCreateVariables = {
|
|
|
24103
24295
|
*
|
|
24104
24296
|
* * Business, Education or API Plan with the Webinar add-on.
|
|
24105
24297
|
*
|
|
24106
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
24298
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
24107
24299
|
*
|
|
24108
|
-
* **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`
|
|
24109
24301
|
*
|
|
24110
24302
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24111
24303
|
*/
|
|
@@ -24145,9 +24337,9 @@ type WebinarLiveStreamingJoinTokenVariables = {
|
|
|
24145
24337
|
* * A Pro or higher plan with a Webinar add-on.
|
|
24146
24338
|
* * The **Allow livestreaming of webinars** user setting enabled in the Zoom web portal.
|
|
24147
24339
|
*
|
|
24148
|
-
* **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`
|
|
24149
24341
|
*
|
|
24150
|
-
* **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`
|
|
24151
24343
|
*
|
|
24152
24344
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24153
24345
|
*/
|
|
@@ -24187,9 +24379,9 @@ type WebinarLocalArchivingArchiveTokenVariables = {
|
|
|
24187
24379
|
* * A Pro or higher plan with a Webinar Add-on.
|
|
24188
24380
|
* * The **Archive meetings and webinars** account setting enabled in the Zoom web portal.
|
|
24189
24381
|
*
|
|
24190
|
-
* **Scopes:** `webinar_token:read:admin:local_archiving`
|
|
24382
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar_token:read:admin:local_archiving`
|
|
24191
24383
|
*
|
|
24192
|
-
* **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`
|
|
24193
24385
|
*
|
|
24194
24386
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24195
24387
|
*/
|
|
@@ -24229,9 +24421,9 @@ type WebinarLocalRecordingJoinTokenVariables = {
|
|
|
24229
24421
|
* * A Pro or higher plan with a Webinar add-on.
|
|
24230
24422
|
* * The **Local recording** user setting enabled in the Zoom web portal.
|
|
24231
24423
|
*
|
|
24232
|
-
* **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`
|
|
24233
24425
|
*
|
|
24234
|
-
* **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`
|
|
24235
24427
|
*
|
|
24236
24428
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24237
24429
|
*/
|
|
@@ -24289,9 +24481,9 @@ type GetWebinarLiveStreamDetailsVariables = {
|
|
|
24289
24481
|
*
|
|
24290
24482
|
*
|
|
24291
24483
|
*
|
|
24292
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
24484
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
24293
24485
|
*
|
|
24294
|
-
* **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`
|
|
24295
24487
|
*
|
|
24296
24488
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24297
24489
|
*/
|
|
@@ -24353,9 +24545,9 @@ type WebinarLiveStreamUpdateVariables = {
|
|
|
24353
24545
|
*
|
|
24354
24546
|
*
|
|
24355
24547
|
*
|
|
24356
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
24548
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
24357
24549
|
*
|
|
24358
|
-
* **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`
|
|
24359
24551
|
*
|
|
24360
24552
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24361
24553
|
*/
|
|
@@ -24418,9 +24610,9 @@ type WebinarLiveStreamStatusUpdateVariables = {
|
|
|
24418
24610
|
*
|
|
24419
24611
|
*
|
|
24420
24612
|
*
|
|
24421
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
24613
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
24422
24614
|
*
|
|
24423
|
-
* **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`
|
|
24424
24616
|
*
|
|
24425
24617
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24426
24618
|
*/
|
|
@@ -24519,9 +24711,9 @@ type WebinarPanelistsVariables = {
|
|
|
24519
24711
|
* * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar).
|
|
24520
24712
|
*
|
|
24521
24713
|
*
|
|
24522
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
24714
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
24523
24715
|
*
|
|
24524
|
-
* **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`
|
|
24525
24717
|
*
|
|
24526
24718
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
24527
24719
|
*/
|
|
@@ -24618,9 +24810,9 @@ type WebinarPanelistCreateVariables = {
|
|
|
24618
24810
|
* * Pro or a higher plan with the [Webinar Add-on](https://zoom.us/webinar).
|
|
24619
24811
|
*
|
|
24620
24812
|
*
|
|
24621
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
24813
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
24622
24814
|
*
|
|
24623
|
-
* **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`
|
|
24624
24816
|
*
|
|
24625
24817
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
24626
24818
|
*/
|
|
@@ -24646,9 +24838,9 @@ type WebinarPanelistsDeleteVariables = {
|
|
|
24646
24838
|
* * Pro or a higher plan with the [webinar add-on](https://zoom.us/webinar).
|
|
24647
24839
|
*
|
|
24648
24840
|
*
|
|
24649
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
24841
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
24650
24842
|
*
|
|
24651
|
-
* **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`
|
|
24652
24844
|
*
|
|
24653
24845
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24654
24846
|
*/
|
|
@@ -24682,9 +24874,9 @@ type WebinarPanelistDeleteVariables = {
|
|
|
24682
24874
|
* * Pro or a higher plan with the [webinar add-on](https://zoom.us/webinar).
|
|
24683
24875
|
*
|
|
24684
24876
|
*
|
|
24685
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
24877
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
24686
24878
|
*
|
|
24687
|
-
* **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`
|
|
24688
24880
|
*
|
|
24689
24881
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24690
24882
|
*/
|
|
@@ -24923,9 +25115,9 @@ type WebinarPollsVariables = {
|
|
|
24923
25115
|
*
|
|
24924
25116
|
*
|
|
24925
25117
|
*
|
|
24926
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
25118
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
24927
25119
|
*
|
|
24928
|
-
* **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`
|
|
24929
25121
|
*
|
|
24930
25122
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
24931
25123
|
*/
|
|
@@ -25318,9 +25510,9 @@ type WebinarPollCreateVariables = {
|
|
|
25318
25510
|
*
|
|
25319
25511
|
*
|
|
25320
25512
|
*
|
|
25321
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
25513
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
25322
25514
|
*
|
|
25323
|
-
* **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`
|
|
25324
25516
|
*
|
|
25325
25517
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
25326
25518
|
*/
|
|
@@ -25543,9 +25735,9 @@ type WebinarPollGetVariables = {
|
|
|
25543
25735
|
*
|
|
25544
25736
|
*
|
|
25545
25737
|
*
|
|
25546
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
25738
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
25547
25739
|
*
|
|
25548
|
-
* **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`
|
|
25549
25741
|
*
|
|
25550
25742
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
25551
25743
|
*/
|
|
@@ -25752,9 +25944,9 @@ type WebinarPollUpdateVariables = {
|
|
|
25752
25944
|
*
|
|
25753
25945
|
*
|
|
25754
25946
|
*
|
|
25755
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
25947
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
25756
25948
|
*
|
|
25757
|
-
* **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`
|
|
25758
25950
|
*
|
|
25759
25951
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
25760
25952
|
*/
|
|
@@ -25784,9 +25976,9 @@ type WebinarPollDeleteVariables = {
|
|
|
25784
25976
|
*
|
|
25785
25977
|
*
|
|
25786
25978
|
*
|
|
25787
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
25979
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
25788
25980
|
*
|
|
25789
|
-
* **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`
|
|
25790
25982
|
*
|
|
25791
25983
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
25792
25984
|
*/
|
|
@@ -26065,9 +26257,9 @@ type WebinarRegistrantsVariables = {
|
|
|
26065
26257
|
*
|
|
26066
26258
|
*
|
|
26067
26259
|
*
|
|
26068
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
26260
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
26069
26261
|
*
|
|
26070
|
-
* **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`
|
|
26071
26263
|
*
|
|
26072
26264
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
26073
26265
|
*/
|
|
@@ -26329,9 +26521,9 @@ type WebinarRegistrantCreateVariables = {
|
|
|
26329
26521
|
* **Prerequisites:**
|
|
26330
26522
|
* * A Pro or higher plan with the Webinar add-on.
|
|
26331
26523
|
*
|
|
26332
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
26524
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
26333
26525
|
*
|
|
26334
|
-
* **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`
|
|
26335
26527
|
*
|
|
26336
26528
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
26337
26529
|
*/
|
|
@@ -26405,9 +26597,9 @@ type WebinarRegistrantsQuestionsGetVariables = {
|
|
|
26405
26597
|
* * Pro or higher plan with the webinar add-on.
|
|
26406
26598
|
*
|
|
26407
26599
|
*
|
|
26408
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
26600
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
26409
26601
|
*
|
|
26410
|
-
* **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`
|
|
26411
26603
|
*
|
|
26412
26604
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
26413
26605
|
*/
|
|
@@ -26482,9 +26674,9 @@ type WebinarRegistrantQuestionUpdateVariables = {
|
|
|
26482
26674
|
* * Registration option for Webinar should be set as required to use this API.
|
|
26483
26675
|
*
|
|
26484
26676
|
*
|
|
26485
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
26677
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
26486
26678
|
*
|
|
26487
|
-
* **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`
|
|
26488
26680
|
*
|
|
26489
26681
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
26490
26682
|
*/
|
|
@@ -26546,9 +26738,9 @@ type WebinarRegistrantStatusVariables = {
|
|
|
26546
26738
|
/**
|
|
26547
26739
|
* Update webinar registrants' registration status. You can approve or deny a registrant, or revoke a registrant's approval.
|
|
26548
26740
|
*
|
|
26549
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
26741
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
26550
26742
|
*
|
|
26551
|
-
* **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`
|
|
26552
26744
|
*
|
|
26553
26745
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
26554
26746
|
*/
|
|
@@ -26771,9 +26963,9 @@ type WebinarRegistrantGetVariables = {
|
|
|
26771
26963
|
*
|
|
26772
26964
|
* * The account must have a webinar plan.
|
|
26773
26965
|
*
|
|
26774
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
26966
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
26775
26967
|
*
|
|
26776
|
-
* **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`
|
|
26777
26969
|
*
|
|
26778
26970
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
26779
26971
|
*/
|
|
@@ -26811,9 +27003,9 @@ type DeleteWebinarRegistrantVariables = {
|
|
|
26811
27003
|
*
|
|
26812
27004
|
*
|
|
26813
27005
|
*
|
|
26814
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
27006
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
26815
27007
|
*
|
|
26816
|
-
* **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`
|
|
26817
27009
|
*
|
|
26818
27010
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
26819
27011
|
*/
|
|
@@ -26872,9 +27064,9 @@ type GetWebinarSipDialingWithPasscodeVariables = {
|
|
|
26872
27064
|
/**
|
|
26873
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.
|
|
26874
27066
|
*
|
|
26875
|
-
* **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`
|
|
26876
27068
|
*
|
|
26877
|
-
* **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`
|
|
26878
27070
|
*
|
|
26879
27071
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
26880
27072
|
*/
|
|
@@ -26907,9 +27099,9 @@ type WebinarStatusVariables = {
|
|
|
26907
27099
|
*
|
|
26908
27100
|
* * The account must hold a valid [Webinar plan](https://zoom.us/webinar).
|
|
26909
27101
|
*
|
|
26910
|
-
* **Scopes:** `webinar:write:admin`,`webinar:write`
|
|
27102
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
26911
27103
|
*
|
|
26912
|
-
* **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`
|
|
26913
27105
|
*
|
|
26914
27106
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
26915
27107
|
*/
|
|
@@ -27141,9 +27333,9 @@ type WebinarSurveyGetVariables = {
|
|
|
27141
27333
|
* * A Pro or higher plan with the Webinar add-on.
|
|
27142
27334
|
* * The [**Webinar Survey**](https://support.zoom.us/hc/en-us/articles/360061293191-Enabling-webinar-survey) feature enabled in the host's account.
|
|
27143
27335
|
*
|
|
27144
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
27336
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
27145
27337
|
*
|
|
27146
|
-
* **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`
|
|
27147
27339
|
*
|
|
27148
27340
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
27149
27341
|
*/
|
|
@@ -27168,9 +27360,9 @@ type WebinarSurveyDeleteVariables = {
|
|
|
27168
27360
|
* * A Pro or higher plan with the Webinar Add-on.
|
|
27169
27361
|
* * The [**Webinar Survey**](https://support.zoom.us/hc/en-us/articles/360061293191-Enabling-webinar-survey) feature enabled in the host's account.
|
|
27170
27362
|
*
|
|
27171
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
27363
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
27172
27364
|
*
|
|
27173
|
-
* **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`
|
|
27174
27366
|
*
|
|
27175
27367
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
27176
27368
|
*/
|
|
@@ -27399,9 +27591,9 @@ type WebinarSurveyUpdateVariables = {
|
|
|
27399
27591
|
/**
|
|
27400
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.
|
|
27401
27593
|
*
|
|
27402
|
-
* **Scopes:** `webinar:write`,`webinar:write:admin`
|
|
27594
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
27403
27595
|
*
|
|
27404
|
-
* **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`
|
|
27405
27597
|
*
|
|
27406
27598
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
27407
27599
|
*/
|
|
@@ -27449,9 +27641,9 @@ type WebinarTokenVariables = {
|
|
|
27449
27641
|
* *
|
|
27450
27642
|
* * The **Allow use of caption API Token to integrate with 3rd-party Closed Captioning services** setting enabled.
|
|
27451
27643
|
*
|
|
27452
|
-
* **Scopes:** `webinar:read`,`webinar:read:admin`
|
|
27644
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read`,`webinar:read:admin`
|
|
27453
27645
|
*
|
|
27454
|
-
* **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`
|
|
27455
27647
|
*
|
|
27456
27648
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
27457
27649
|
*/
|
|
@@ -27522,9 +27714,9 @@ type GetTrackingSourcesVariables = {
|
|
|
27522
27714
|
* * Registration must be required for the Webinar.
|
|
27523
27715
|
*
|
|
27524
27716
|
*
|
|
27525
|
-
* **Scopes:** `webinar:read:admin`,`webinar:read`
|
|
27717
|
+
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
27526
27718
|
*
|
|
27527
|
-
* **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`
|
|
27528
27720
|
*
|
|
27529
27721
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
27530
27722
|
*/
|