zoom-api-js 1.3.2 → 3.0.2
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/LICENSE +15 -0
- package/README.md +15 -3
- package/dist/{components-ofy4w3vb.js → components-lqucvmze.d.ts} +1934 -3691
- package/dist/components-lqucvmze.d.ts.map +1 -0
- package/dist/{components-hg878s5j.cjs → components-mhg1g1oz.d.ts} +1934 -3880
- package/dist/components-mhg1g1oz.d.ts.map +1 -0
- package/dist/components.cjs +5735 -190
- package/dist/components.d.cts +2 -0
- package/dist/components.d.cts.map +1 -0
- package/dist/components.d.mts +1 -4310
- package/dist/components.d.mts.map +1 -1
- package/dist/components.mjs +5550 -1
- package/dist/effect.cjs +131 -24
- package/dist/effect.d.cts +493 -0
- package/dist/effect.d.cts.map +1 -0
- package/dist/effect.d.mts +75 -5
- package/dist/effect.d.mts.map +1 -1
- package/dist/effect.mjs +125 -4
- package/dist/index.cjs +259 -26
- package/dist/index.d.cts +243 -0
- package/dist/index.d.cts.map +1 -0
- package/dist/index.d.mts +243 -0
- package/dist/index.d.mts.map +1 -0
- package/dist/index.d.ts +7268 -3386
- package/dist/index.d.ts.map +1 -1
- package/dist/index.mjs +35 -29
- package/dist/{schemas-k0vlcve8.cjs → schemas-l0isvuz8.cjs} +3390 -271
- package/dist/{schemas-ku36knzu.js → schemas-mag10jlc.js} +3169 -272
- package/dist/schemas.cjs +223 -1
- package/dist/schemas.d.cts +10541 -0
- package/dist/schemas.d.cts.map +1 -0
- package/dist/schemas.d.mts +1353 -261
- package/dist/schemas.d.mts.map +1 -1
- package/dist/schemas.mjs +1 -1
- package/dist/types.cjs +43 -4
- package/dist/types.d.cts +35118 -0
- package/dist/types.d.cts.map +1 -0
- package/dist/types.d.mts +5529 -2143
- package/dist/types.d.mts.map +1 -1
- package/dist/types.mjs +39 -5
- package/package.json +57 -29
package/dist/components.d.mts
CHANGED
|
@@ -1,4311 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
type RequestInit = {
|
|
4
|
-
body?: string | FormData | URLSearchParams | undefined;
|
|
5
|
-
headers?: Record<string, string> | undefined;
|
|
6
|
-
method?: string | undefined;
|
|
7
|
-
signal?: any | undefined;
|
|
8
|
-
};
|
|
9
|
-
type Response = {
|
|
10
|
-
ok: boolean;
|
|
11
|
-
status: number;
|
|
12
|
-
url: string;
|
|
13
|
-
json(): Promise<any>;
|
|
14
|
-
text(): Promise<string>;
|
|
15
|
-
headers?: {
|
|
16
|
-
get(name: string): string | null;
|
|
17
|
-
} | undefined;
|
|
18
|
-
};
|
|
19
|
-
type FetchImpl = (url: string, init?: RequestInit | undefined) => Promise<Response>;
|
|
20
|
-
|
|
21
|
-
type FetcherConfig = {
|
|
22
|
-
token?: string | null;
|
|
23
|
-
fetchImpl?: FetchImpl;
|
|
24
|
-
headers?: Record<string, any>;
|
|
25
|
-
};
|
|
26
|
-
type FetcherOptions<TBody, THeaders, TQueryParams, TPathParams> = {
|
|
27
|
-
url: string;
|
|
28
|
-
method: string;
|
|
29
|
-
body?: TBody | undefined;
|
|
30
|
-
headers?: THeaders | undefined;
|
|
31
|
-
queryParams?: TQueryParams | undefined;
|
|
32
|
-
pathParams?: TPathParams | undefined;
|
|
33
|
-
signal?: AbortSignal | undefined;
|
|
34
|
-
} & FetcherConfig;
|
|
35
|
-
declare function client<TData, TError, TBody, THeaders, TQueryParams, TPathParams>({ url, method, body, headers, pathParams, queryParams, signal, token, fetchImpl, }: FetcherOptions<TBody, THeaders, TQueryParams, TPathParams>): Promise<TData>;
|
|
36
|
-
|
|
37
|
-
/**
|
|
38
|
-
* Generated by Kubb (https://kubb.dev/).
|
|
39
|
-
* Do not edit manually.
|
|
40
|
-
*/
|
|
41
|
-
|
|
42
|
-
/**
|
|
43
|
-
* @summary List archived files
|
|
44
|
-
* @description Get an account's archived meeting or webinar files.
|
|
45
|
-
* Zoom's [archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-indicators) lets account administrators set up an automated mechanism to record, collect, and archive meeting data to a third-party platform of their choice to satisfy FINRA or other compliance requirements.
|
|
46
|
-
* **Prerequisites:**
|
|
47
|
-
* * 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).
|
|
48
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin`
|
|
49
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `archiving:read:list_archived_files:admin`,`archiving:read:list_archived_files:master`
|
|
50
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
51
|
-
* @link /archive_files
|
|
52
|
-
*/
|
|
53
|
-
declare function listArchivedFiles({ queryParams, config, }?: {
|
|
54
|
-
queryParams?: {
|
|
55
|
-
page_size?: number;
|
|
56
|
-
next_page_token?: string;
|
|
57
|
-
from?: string;
|
|
58
|
-
to?: string;
|
|
59
|
-
query_date_type?: "meeting_start_time" | "archive_complete_time";
|
|
60
|
-
group_id?: string;
|
|
61
|
-
group_ids?: string;
|
|
62
|
-
};
|
|
63
|
-
config?: Partial<FetcherConfig> & {
|
|
64
|
-
client?: typeof client;
|
|
65
|
-
};
|
|
66
|
-
}): Promise<unknown>;
|
|
67
|
-
/**
|
|
68
|
-
* @summary List archived file download audit logs
|
|
69
|
-
* @description Get an account's archived meeting or webinar file download audit logs. The response groups audit records by meeting or webinar instance, archive file, and source IP address.
|
|
70
|
-
* Zoom's [archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-indicators) lets account administrators set up an automated mechanism to record, collect, and archive meeting data to a third-party platform of their choice to satisfy FINRA or other compliance requirements.
|
|
71
|
-
* **Prerequisites:**
|
|
72
|
-
* * 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).
|
|
73
|
-
* * A paid account.
|
|
74
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
75
|
-
* @link /archive_files/download_audit
|
|
76
|
-
*/
|
|
77
|
-
declare function listArchiveFileDownloadAudit({ queryParams, config, }?: {
|
|
78
|
-
queryParams?: {
|
|
79
|
-
page_size?: number;
|
|
80
|
-
next_page_token?: string;
|
|
81
|
-
from?: string;
|
|
82
|
-
to?: string;
|
|
83
|
-
};
|
|
84
|
-
config?: Partial<FetcherConfig> & {
|
|
85
|
-
client?: typeof client;
|
|
86
|
-
};
|
|
87
|
-
}): Promise<unknown>;
|
|
88
|
-
/**
|
|
89
|
-
* @summary Get archived file statistics
|
|
90
|
-
* @description Get statistics about an account's archived meeting or webinar files.
|
|
91
|
-
* Zoom's [archiving solution](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-indicators) lets account administrators set up an automated mechanism to record, collect, and archive meeting data to a third-party platform of their choice to satisfy FINRA and other compliance requirements.
|
|
92
|
-
* **Prerequisites:**
|
|
93
|
-
* * 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).
|
|
94
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin`
|
|
95
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `archiving:read:archived_file_statistics:admin`
|
|
96
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
97
|
-
* @link /archive_files/statistics
|
|
98
|
-
*/
|
|
99
|
-
declare function getArchivedFileStatistics({ queryParams, config, }?: {
|
|
100
|
-
queryParams?: {
|
|
101
|
-
from?: string;
|
|
102
|
-
to?: string;
|
|
103
|
-
};
|
|
104
|
-
config?: Partial<FetcherConfig> & {
|
|
105
|
-
client?: typeof client;
|
|
106
|
-
};
|
|
107
|
-
}): Promise<unknown>;
|
|
108
|
-
/**
|
|
109
|
-
* @summary Update an archived file's auto-delete status
|
|
110
|
-
* @description Update an archived file's auto-delete status.
|
|
111
|
-
* **Prerequisites:**
|
|
112
|
-
* * [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.
|
|
113
|
-
* * Open the disabling auto-delete feature in OP. Contact [Zoom Support](https://support.zoom.us/hc/en-us/articles/201362003) to open.
|
|
114
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write`,`recording:write:admin`
|
|
115
|
-
* **[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`
|
|
116
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
117
|
-
* @link /archive_files/{fileId}
|
|
118
|
-
*/
|
|
119
|
-
declare function updateArchivedFile({ pathParams, body, config, }?: {
|
|
120
|
-
pathParams: {
|
|
121
|
-
fileId: string;
|
|
122
|
-
};
|
|
123
|
-
body?: UpdateArchivedFileBody;
|
|
124
|
-
config?: Partial<FetcherConfig> & {
|
|
125
|
-
client?: typeof client;
|
|
126
|
-
};
|
|
127
|
-
}): Promise<unknown>;
|
|
128
|
-
/**
|
|
129
|
-
* @summary Get a meeting's archive token for local archiving
|
|
130
|
-
* @description Get a meeting's archive token to allow local archiving. The archive token allows a meeting SDK app or bot to get archive permission to access the meeting's raw audio and video media stream in real-time.
|
|
131
|
-
* **Prerequisites:**
|
|
132
|
-
* * A Pro or higher plan for the meeting host.
|
|
133
|
-
* * The **Archive meetings and webinars** account setting enabled in the Zoom web portal.
|
|
134
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_token:read:admin:local_archiving`
|
|
135
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:local_archiving_token:admin`
|
|
136
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
137
|
-
* @link /meetings/{meetingId}/jointoken/local_archiving
|
|
138
|
-
*/
|
|
139
|
-
declare function meetingLocalArchivingArchiveToken({ pathParams, config, }?: {
|
|
140
|
-
pathParams: {
|
|
141
|
-
meetingId: bigint;
|
|
142
|
-
};
|
|
143
|
-
config?: Partial<FetcherConfig> & {
|
|
144
|
-
client?: typeof client;
|
|
145
|
-
};
|
|
146
|
-
}): Promise<unknown>;
|
|
147
|
-
/**
|
|
148
|
-
* @summary Get a meeting's archived files
|
|
149
|
-
* @description Return a specific meeting instance's [archived files](https://support.zoom.us/hc/en-us/articles/360050431572-Archiving-indicators).
|
|
150
|
-
* See [Archived JSON schemas](/docs/api/references/archived-json-schema/) for in-meeting chat message and subgroup archiving activity JSON schemas.
|
|
151
|
-
* **Prerequisites:**
|
|
152
|
-
* * 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).
|
|
153
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read`
|
|
154
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `archiving:read:archived_files:admin`,`archiving:read:archived_files`
|
|
155
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
156
|
-
* @link /past_meetings/{meetingUUID}/archive_files
|
|
157
|
-
*/
|
|
158
|
-
declare function getArchivedFiles({ pathParams, config, }?: {
|
|
159
|
-
pathParams: {
|
|
160
|
-
meetingUUID: string;
|
|
161
|
-
};
|
|
162
|
-
config?: Partial<FetcherConfig> & {
|
|
163
|
-
client?: typeof client;
|
|
164
|
-
};
|
|
165
|
-
}): Promise<unknown>;
|
|
166
|
-
/**
|
|
167
|
-
* @summary Delete a meeting's archived files
|
|
168
|
-
* @description Delete all of a meeting's archived files.
|
|
169
|
-
* **Prerequisites:**
|
|
170
|
-
* * 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).
|
|
171
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`
|
|
172
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `archiving:delete:archived_files:admin`
|
|
173
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
174
|
-
* @link /past_meetings/{meetingUUID}/archive_files
|
|
175
|
-
*/
|
|
176
|
-
declare function deleteArchivedFiles({ pathParams, config, }?: {
|
|
177
|
-
pathParams: {
|
|
178
|
-
meetingUUID: string;
|
|
179
|
-
};
|
|
180
|
-
config?: Partial<FetcherConfig> & {
|
|
181
|
-
client?: typeof client;
|
|
182
|
-
};
|
|
183
|
-
}): Promise<unknown>;
|
|
184
|
-
/**
|
|
185
|
-
* @summary Get meeting recordings
|
|
186
|
-
* @description 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:
|
|
187
|
-
* `curl -H 'Authorization: Bearer <ACCESS_TOKEN>' https://{{base-domain}}/rec/archive/download/xyz`
|
|
188
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read`,`phone_recording:read:admin`
|
|
189
|
-
* **[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`
|
|
190
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
191
|
-
* @link /meetings/{meetingId}/recordings
|
|
192
|
-
*/
|
|
193
|
-
declare function recordingGet({ pathParams, queryParams, config, }?: {
|
|
194
|
-
pathParams: {
|
|
195
|
-
meetingId: string;
|
|
196
|
-
};
|
|
197
|
-
queryParams?: {
|
|
198
|
-
include_fields?: string;
|
|
199
|
-
ttl?: number;
|
|
200
|
-
};
|
|
201
|
-
config?: Partial<FetcherConfig> & {
|
|
202
|
-
client?: typeof client;
|
|
203
|
-
};
|
|
204
|
-
}): Promise<unknown>;
|
|
205
|
-
/**
|
|
206
|
-
* @summary Delete meeting or webinar recordings
|
|
207
|
-
* @description Delete all of a meeting's or webinar's recording files.
|
|
208
|
-
* **Prerequisites**
|
|
209
|
-
* * Enable Cloud Recording on the user's account. Learn more about [enabling cloud recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063923) and [managing cloud recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065362).
|
|
210
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write`
|
|
211
|
-
* **[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`
|
|
212
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
213
|
-
* @link /meetings/{meetingId}/recordings
|
|
214
|
-
*/
|
|
215
|
-
declare function recordingDelete({ pathParams, queryParams, config, }?: {
|
|
216
|
-
pathParams: {
|
|
217
|
-
meetingId: string;
|
|
218
|
-
};
|
|
219
|
-
queryParams?: {
|
|
220
|
-
action?: "trash" | "delete";
|
|
221
|
-
};
|
|
222
|
-
config?: Partial<FetcherConfig> & {
|
|
223
|
-
client?: typeof client;
|
|
224
|
-
};
|
|
225
|
-
}): Promise<unknown>;
|
|
226
|
-
/**
|
|
227
|
-
* @summary Get a meeting or webinar recording's analytics details
|
|
228
|
-
* @description 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.
|
|
229
|
-
* **[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`
|
|
230
|
-
* @link /meetings/{meetingId}/recordings/analytics_details
|
|
231
|
-
*/
|
|
232
|
-
declare function analyticsDetails({ pathParams, queryParams, config, }?: {
|
|
233
|
-
pathParams: {
|
|
234
|
-
meetingId: string;
|
|
235
|
-
};
|
|
236
|
-
queryParams?: {
|
|
237
|
-
page_size?: number;
|
|
238
|
-
next_page_token?: string;
|
|
239
|
-
from?: string;
|
|
240
|
-
to?: string;
|
|
241
|
-
type?: "by_view" | "by_download";
|
|
242
|
-
};
|
|
243
|
-
config?: Partial<FetcherConfig> & {
|
|
244
|
-
client?: typeof client;
|
|
245
|
-
};
|
|
246
|
-
}): Promise<unknown>;
|
|
247
|
-
/**
|
|
248
|
-
* @summary Get a meeting or webinar recording's analytics summary
|
|
249
|
-
* @description 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.
|
|
250
|
-
* **[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`
|
|
251
|
-
* @link /meetings/{meetingId}/recordings/analytics_summary
|
|
252
|
-
*/
|
|
253
|
-
declare function analyticsSummary({ pathParams, queryParams, config, }?: {
|
|
254
|
-
pathParams: {
|
|
255
|
-
meetingId: string;
|
|
256
|
-
};
|
|
257
|
-
queryParams?: {
|
|
258
|
-
from?: string;
|
|
259
|
-
to?: string;
|
|
260
|
-
};
|
|
261
|
-
config?: Partial<FetcherConfig> & {
|
|
262
|
-
client?: typeof client;
|
|
263
|
-
};
|
|
264
|
-
}): Promise<unknown>;
|
|
265
|
-
/**
|
|
266
|
-
* @summary List recording registrants
|
|
267
|
-
* @description Get a list of registrants of a past meeting's [on-demand cloud recordings](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-recordings). Users must [register](/api-reference/zoom-api/methods#operation/meetingRecordingRegistrantCreate) to view the recordings.
|
|
268
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin`,`recording:read`
|
|
269
|
-
* **[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`
|
|
270
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
271
|
-
* @link /meetings/{meetingId}/recordings/registrants
|
|
272
|
-
*/
|
|
273
|
-
declare function meetingRecordingRegistrants({ pathParams, queryParams, config, }?: {
|
|
274
|
-
pathParams: {
|
|
275
|
-
meetingId: bigint;
|
|
276
|
-
};
|
|
277
|
-
queryParams?: {
|
|
278
|
-
status?: "pending" | "approved" | "denied";
|
|
279
|
-
page_size?: number;
|
|
280
|
-
page_number?: number;
|
|
281
|
-
next_page_token?: string;
|
|
282
|
-
};
|
|
283
|
-
config?: Partial<FetcherConfig> & {
|
|
284
|
-
client?: typeof client;
|
|
285
|
-
};
|
|
286
|
-
}): Promise<unknown>;
|
|
287
|
-
/**
|
|
288
|
-
* @summary Create a recording registrant
|
|
289
|
-
* @description Register a user to gain access to **On-demand cloud recordings** of a previous meeting.
|
|
290
|
-
* Cloud recordings of past Zoom meetings can be made [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings). Users should be [registered](/api-reference/zoom-api/methods#operation/meetingRecordingRegistrantCreate) to view these recordings.
|
|
291
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write`
|
|
292
|
-
* **[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`
|
|
293
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
294
|
-
* @link /meetings/{meetingId}/recordings/registrants
|
|
295
|
-
*/
|
|
296
|
-
declare function meetingRecordingRegistrantCreate({ pathParams, body, config, }?: {
|
|
297
|
-
pathParams: {
|
|
298
|
-
meetingId: bigint;
|
|
299
|
-
};
|
|
300
|
-
body?: MeetingRecordingRegistrantCreateBody;
|
|
301
|
-
config?: Partial<FetcherConfig> & {
|
|
302
|
-
client?: typeof client;
|
|
303
|
-
};
|
|
304
|
-
}): Promise<unknown>;
|
|
305
|
-
/**
|
|
306
|
-
* @summary Get registration questions
|
|
307
|
-
* @description Retrieve a list of questions that are displayed for users to complete when registering to view the recording of a specific meeting.
|
|
308
|
-
* For [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording.
|
|
309
|
-
* Learn more about [enabling cloud recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063923) and [managing cloud recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065362).
|
|
310
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin`,`recording:read`
|
|
311
|
-
* **[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`
|
|
312
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
313
|
-
* @link /meetings/{meetingId}/recordings/registrants/questions
|
|
314
|
-
*/
|
|
315
|
-
declare function recordingRegistrantsQuestionsGet({ pathParams, config, }?: {
|
|
316
|
-
pathParams: {
|
|
317
|
-
meetingId: string;
|
|
318
|
-
};
|
|
319
|
-
config?: Partial<FetcherConfig> & {
|
|
320
|
-
client?: typeof client;
|
|
321
|
-
};
|
|
322
|
-
}): Promise<unknown>;
|
|
323
|
-
/**
|
|
324
|
-
* @summary Update registration questions
|
|
325
|
-
* @description Update registration questions for users to answer while registering to view a recording.
|
|
326
|
-
* For [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) meeting recordings, you can include fields with questions that will be shown to registrants when they register to view the recording.
|
|
327
|
-
* Learn more about [enabling cloud recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063923) and [managing cloud recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065362).
|
|
328
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write`
|
|
329
|
-
* **[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`
|
|
330
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
331
|
-
* @link /meetings/{meetingId}/recordings/registrants/questions
|
|
332
|
-
*/
|
|
333
|
-
declare function recordingRegistrantQuestionUpdate({ pathParams, body, config, }?: {
|
|
334
|
-
pathParams: {
|
|
335
|
-
meetingId: string;
|
|
336
|
-
};
|
|
337
|
-
body?: RecordingRegistrantQuestionUpdateBody;
|
|
338
|
-
config?: Partial<FetcherConfig> & {
|
|
339
|
-
client?: typeof client;
|
|
340
|
-
};
|
|
341
|
-
}): Promise<unknown>;
|
|
342
|
-
/**
|
|
343
|
-
* @summary Update a registrant's status
|
|
344
|
-
* @description Update a registrant's status.
|
|
345
|
-
* A registrant can either be approved or denied from viewing the [on-demand](https://support.zoom.us/hc/en-us/articles/360000488283-On-demand-Recordings) recording.
|
|
346
|
-
* Learn more about [enabling cloud recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063923) and [managing cloud recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065362).
|
|
347
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write`
|
|
348
|
-
* **[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`
|
|
349
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
350
|
-
* @link /meetings/{meetingId}/recordings/registrants/status
|
|
351
|
-
*/
|
|
352
|
-
declare function meetingRecordingRegistrantStatus({ pathParams, body, config, }?: {
|
|
353
|
-
pathParams: {
|
|
354
|
-
meetingId: bigint;
|
|
355
|
-
};
|
|
356
|
-
body?: MeetingRecordingRegistrantStatusBody;
|
|
357
|
-
config?: Partial<FetcherConfig> & {
|
|
358
|
-
client?: typeof client;
|
|
359
|
-
};
|
|
360
|
-
}): Promise<unknown>;
|
|
361
|
-
/**
|
|
362
|
-
* @summary Get meeting recording settings
|
|
363
|
-
* @description Retrieve settings applied to a meeting's [cloud recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording).
|
|
364
|
-
* Response includes recording content access information, which requires the current user to have the `View the recording content` permission to access it.
|
|
365
|
-
* Learn more about [enabling cloud recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063923) and [managing cloud recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065362).
|
|
366
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin`,`recording:read`
|
|
367
|
-
* **[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`
|
|
368
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
369
|
-
* @link /meetings/{meetingId}/recordings/settings
|
|
370
|
-
*/
|
|
371
|
-
declare function recordingSettingUpdate({ pathParams, config, }?: {
|
|
372
|
-
pathParams: {
|
|
373
|
-
meetingId: string;
|
|
374
|
-
};
|
|
375
|
-
config?: Partial<FetcherConfig> & {
|
|
376
|
-
client?: typeof client;
|
|
377
|
-
};
|
|
378
|
-
}): Promise<unknown>;
|
|
379
|
-
/**
|
|
380
|
-
* @summary Update meeting recording settings
|
|
381
|
-
* @description Update settings applied to a meeting's [cloud recording](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording).
|
|
382
|
-
* 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.
|
|
383
|
-
* Learn more about [enabling cloud recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063923) and [managing cloud recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065362).
|
|
384
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write`
|
|
385
|
-
* **[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`
|
|
386
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
387
|
-
* @link /meetings/{meetingId}/recordings/settings
|
|
388
|
-
*/
|
|
389
|
-
declare function recordingSettingsUpdate({ pathParams, body, config, }?: {
|
|
390
|
-
pathParams: {
|
|
391
|
-
meetingId: string;
|
|
392
|
-
};
|
|
393
|
-
body?: RecordingSettingsUpdateBody;
|
|
394
|
-
config?: Partial<FetcherConfig> & {
|
|
395
|
-
client?: typeof client;
|
|
396
|
-
};
|
|
397
|
-
}): Promise<unknown>;
|
|
398
|
-
/**
|
|
399
|
-
* @summary Delete a recording file for a meeting or webinar
|
|
400
|
-
* @description Delete a specific recording file from a meeting or webinar. Note: To use this API, you must enable the **The host can delete cloud recordings** setting. Find this setting in the **Recording** tab of the **Settings** interface in the [Zoom web portal](https://zoom.us/).
|
|
401
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write`
|
|
402
|
-
* **[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`
|
|
403
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
404
|
-
* @link /meetings/{meetingId}/recordings/{recordingId}
|
|
405
|
-
*/
|
|
406
|
-
declare function recordingDeleteOne({ pathParams, queryParams, config, }?: {
|
|
407
|
-
pathParams: {
|
|
408
|
-
meetingId: string;
|
|
409
|
-
recordingId: string;
|
|
410
|
-
};
|
|
411
|
-
queryParams?: {
|
|
412
|
-
action?: "trash" | "delete";
|
|
413
|
-
};
|
|
414
|
-
config?: Partial<FetcherConfig> & {
|
|
415
|
-
client?: typeof client;
|
|
416
|
-
};
|
|
417
|
-
}): Promise<unknown>;
|
|
418
|
-
/**
|
|
419
|
-
* @summary Recover a single recording
|
|
420
|
-
* @description Recover a single recording file from the meeting.
|
|
421
|
-
* Zoom lets users recover recordings from trash for up to 30 days from the deletion date.
|
|
422
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write`
|
|
423
|
-
* **[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`
|
|
424
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
425
|
-
* @link /meetings/{meetingId}/recordings/{recordingId}/status
|
|
426
|
-
*/
|
|
427
|
-
declare function recordingStatusUpdateOne({ pathParams, body, config, }?: {
|
|
428
|
-
pathParams: {
|
|
429
|
-
meetingId: string;
|
|
430
|
-
recordingId: string;
|
|
431
|
-
};
|
|
432
|
-
body?: RecordingStatusUpdateOneBody;
|
|
433
|
-
config?: Partial<FetcherConfig> & {
|
|
434
|
-
client?: typeof client;
|
|
435
|
-
};
|
|
436
|
-
}): Promise<unknown>;
|
|
437
|
-
/**
|
|
438
|
-
* @summary Recover meeting recordings
|
|
439
|
-
* @description Recover all deleted [cloud recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) of a specific meeting.
|
|
440
|
-
* Zoom lets users recover recordings from trash for up to 30 days from the deletion date.
|
|
441
|
-
* **Prerequisites**:
|
|
442
|
-
* * A Pro user with Cloud Recording enabled.
|
|
443
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write:admin`,`recording:write`
|
|
444
|
-
* **[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`
|
|
445
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
446
|
-
* @link /meetings/{meetingUUID}/recordings/status
|
|
447
|
-
*/
|
|
448
|
-
declare function recordingStatusUpdate({ pathParams, body, config, }?: {
|
|
449
|
-
pathParams: {
|
|
450
|
-
meetingUUID: string;
|
|
451
|
-
};
|
|
452
|
-
body?: RecordingStatusUpdateBody;
|
|
453
|
-
config?: Partial<FetcherConfig> & {
|
|
454
|
-
client?: typeof client;
|
|
455
|
-
};
|
|
456
|
-
}): Promise<unknown>;
|
|
457
|
-
/**
|
|
458
|
-
* @summary List all recordings
|
|
459
|
-
* @description Lists all [cloud recordings](https://support.zoom.us/hc/en-us/articles/203741855-Cloud-Recording) for a user.
|
|
460
|
-
* For user-level apps, pass the [`me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter. To access a user's passcode protected cloud recording, send the user's [OAuth access token](https://developers.zoom.us/docs/integrations/oauth/) as a bearer token in the authorization header.
|
|
461
|
-
* Example: `curl -H "Authorization: Bearer <ACCESS_TOKEN>" https://{{base-domain}}/rec/archive/download/xyz`
|
|
462
|
-
* **Prerequisites:**
|
|
463
|
-
* * Must have a Pro or a higher plan.
|
|
464
|
-
* * Must enable Cloud Recording on the user's account. Learn more about [enabling cloud recordings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063923) and [managing cloud recording settings](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065362).
|
|
465
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read:admin`,`recording:read`
|
|
466
|
-
* **[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`
|
|
467
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
468
|
-
* @link /users/{userId}/recordings
|
|
469
|
-
*/
|
|
470
|
-
declare function recordingsList({ pathParams, queryParams, config, }?: {
|
|
471
|
-
pathParams: {
|
|
472
|
-
userId: string;
|
|
473
|
-
};
|
|
474
|
-
queryParams?: {
|
|
475
|
-
page_size?: number;
|
|
476
|
-
next_page_token?: string;
|
|
477
|
-
mc?: string;
|
|
478
|
-
trash?: boolean;
|
|
479
|
-
from?: string;
|
|
480
|
-
to?: string;
|
|
481
|
-
trash_type?: string;
|
|
482
|
-
meeting_id?: number;
|
|
483
|
-
zra_status?: "all" | "added" | "not_added" | "processing";
|
|
484
|
-
recording_source_type?: "cloud_recording_only" | "my_notes_recording_only";
|
|
485
|
-
};
|
|
486
|
-
config?: Partial<FetcherConfig> & {
|
|
487
|
-
client?: typeof client;
|
|
488
|
-
};
|
|
489
|
-
}): Promise<unknown>;
|
|
490
|
-
/**
|
|
491
|
-
* @summary List devices
|
|
492
|
-
* @description This API lets you list devices.
|
|
493
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:admin`,`device:write:admin`
|
|
494
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
495
|
-
* @link /devices
|
|
496
|
-
*/
|
|
497
|
-
declare function listDevices({ queryParams, config, }?: {
|
|
498
|
-
queryParams?: {
|
|
499
|
-
search_text?: string;
|
|
500
|
-
platform_os?: "win" | "mac" | "ipad" | "iphone" | "android" | "linux";
|
|
501
|
-
is_enrolled_in_zdm?: boolean;
|
|
502
|
-
device_type?: -1 | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
|
|
503
|
-
device_vendor?: string;
|
|
504
|
-
device_model?: string;
|
|
505
|
-
device_status?: -1 | 0 | 1;
|
|
506
|
-
page_size?: number;
|
|
507
|
-
next_page_token?: string;
|
|
508
|
-
};
|
|
509
|
-
config?: Partial<FetcherConfig> & {
|
|
510
|
-
client?: typeof client;
|
|
511
|
-
};
|
|
512
|
-
}): Promise<unknown>;
|
|
513
|
-
/**
|
|
514
|
-
* @summary Add a new device
|
|
515
|
-
* @description Add a new device to Zoom account.
|
|
516
|
-
* **Scope:** `device:write:admin`
|
|
517
|
-
* **[Rate Limit Label](https://developers.zoom.us/docs/api/rest/rate-limits/):** `Medium`
|
|
518
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin`
|
|
519
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
520
|
-
* @link /devices
|
|
521
|
-
*/
|
|
522
|
-
declare function addDevice({ body, config, }?: {
|
|
523
|
-
body?: AddDeviceBody;
|
|
524
|
-
config?: Partial<FetcherConfig> & {
|
|
525
|
-
client?: typeof client;
|
|
526
|
-
};
|
|
527
|
-
}): Promise<unknown>;
|
|
528
|
-
/**
|
|
529
|
-
* @summary Get ZDM group info
|
|
530
|
-
* @description Get Zoom Device Manager (ZDM) group information for an account.
|
|
531
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:admin`
|
|
532
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:list_groups:admin`,`device:read:list_groups:master`
|
|
533
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
534
|
-
* @link /devices/groups
|
|
535
|
-
*/
|
|
536
|
-
declare function getzdmgroupinfo({ queryParams, config, }?: {
|
|
537
|
-
queryParams?: {
|
|
538
|
-
page_size?: number;
|
|
539
|
-
next_page_token?: string;
|
|
540
|
-
};
|
|
541
|
-
config?: Partial<FetcherConfig> & {
|
|
542
|
-
client?: typeof client;
|
|
543
|
-
};
|
|
544
|
-
}): Promise<unknown>;
|
|
545
|
-
/**
|
|
546
|
-
* @summary Assign a device to a user or commonarea
|
|
547
|
-
* @description Assign a device to a user or common area, or move a device to another user or common area, or remove a device.
|
|
548
|
-
* **Prerequisites:**
|
|
549
|
-
* * Device must be enrolled in Zoom Device Management (ZDM).
|
|
550
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin`
|
|
551
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:zpa_device:admin`,`device:write:zpa_device:master`
|
|
552
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
553
|
-
* @link /devices/zpa/assignment
|
|
554
|
-
*/
|
|
555
|
-
declare function assigndevicetoauserCommonarea({ body, config, }?: {
|
|
556
|
-
body?: AssigndevicetoauserCommonareaBody;
|
|
557
|
-
config?: Partial<FetcherConfig> & {
|
|
558
|
-
client?: typeof client;
|
|
559
|
-
};
|
|
560
|
-
}): Promise<unknown>;
|
|
561
|
-
/**
|
|
562
|
-
* @summary Get Zoom Phone Appliance settings by user ID
|
|
563
|
-
* @description Get a user's Zoom Phone Appliance (ZPA) device profile settings. For user-level apps, pass the `me` value instead of the `userId` parameter.
|
|
564
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:admin`
|
|
565
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:user_setting:admin`,`device:read:user_setting:master`
|
|
566
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
567
|
-
* @link /devices/zpa/settings
|
|
568
|
-
*/
|
|
569
|
-
declare function getZpaDeviceListProfileSettingOfaUser({ queryParams, config, }?: {
|
|
570
|
-
queryParams?: {
|
|
571
|
-
user_id?: string;
|
|
572
|
-
};
|
|
573
|
-
config?: Partial<FetcherConfig> & {
|
|
574
|
-
client?: typeof client;
|
|
575
|
-
};
|
|
576
|
-
}): Promise<unknown>;
|
|
577
|
-
/**
|
|
578
|
-
* @summary Upgrade ZPA firmware or app
|
|
579
|
-
* @description Upgrade ZPA firmware or app by Zoom Device Manager (ZDM) group ID.
|
|
580
|
-
* **Prerequisites:**
|
|
581
|
-
* * Account owner or admin permissions.
|
|
582
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin`
|
|
583
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:zpa_os_app:admin`,`device:write:zpa_os_app:master`
|
|
584
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
585
|
-
* @link /devices/zpa/upgrade
|
|
586
|
-
*/
|
|
587
|
-
declare function upgradeZpasApp({ body, config, }?: {
|
|
588
|
-
body?: UpgradeZpasAppBody;
|
|
589
|
-
config?: Partial<FetcherConfig> & {
|
|
590
|
-
client?: typeof client;
|
|
591
|
-
};
|
|
592
|
-
}): Promise<unknown>;
|
|
593
|
-
/**
|
|
594
|
-
* @summary Delete ZPA device by vendor and mac address
|
|
595
|
-
* @description Remove a ZPA device from the device manager, by vendor and mac address.
|
|
596
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin`
|
|
597
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:delete:zpa_device:admin`,`device:delete:zpa_device:master`
|
|
598
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
599
|
-
* @link /devices/zpa/vendors/{vendor}/mac_addresses/{macAddress}
|
|
600
|
-
*/
|
|
601
|
-
declare function deleteZpaDeviceByVendorAndMacAddress({ pathParams, config, }?: {
|
|
602
|
-
pathParams: {
|
|
603
|
-
vendor: string;
|
|
604
|
-
macAddress: string;
|
|
605
|
-
};
|
|
606
|
-
config?: Partial<FetcherConfig> & {
|
|
607
|
-
client?: typeof client;
|
|
608
|
-
};
|
|
609
|
-
}): Promise<unknown>;
|
|
610
|
-
/**
|
|
611
|
-
* @summary Get ZPA version info
|
|
612
|
-
* @description Get ZPA firmware and app version information that can be upgraded for devices.
|
|
613
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:admin`
|
|
614
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:list_zpa_versions:admin`,`device:read:list_zpa_versions:master`
|
|
615
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
616
|
-
* @link /devices/zpa/zdm_groups/{zdmGroupId}/versions
|
|
617
|
-
*/
|
|
618
|
-
declare function getZpaVersioninfo({ pathParams, config, }?: {
|
|
619
|
-
pathParams: {
|
|
620
|
-
zdmGroupId: string;
|
|
621
|
-
};
|
|
622
|
-
config?: Partial<FetcherConfig> & {
|
|
623
|
-
client?: typeof client;
|
|
624
|
-
};
|
|
625
|
-
}): Promise<unknown>;
|
|
626
|
-
/**
|
|
627
|
-
* @summary Get device detail
|
|
628
|
-
* @description Retrieve a device's details.
|
|
629
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:read:admin`,`device:write:admin`
|
|
630
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
631
|
-
* @link /devices/{deviceId}
|
|
632
|
-
*/
|
|
633
|
-
declare function getDevice({ pathParams, config, }?: {
|
|
634
|
-
pathParams: {
|
|
635
|
-
deviceId: string;
|
|
636
|
-
};
|
|
637
|
-
config?: Partial<FetcherConfig> & {
|
|
638
|
-
client?: typeof client;
|
|
639
|
-
};
|
|
640
|
-
}): Promise<unknown>;
|
|
641
|
-
/**
|
|
642
|
-
* @summary Delete device
|
|
643
|
-
* @description Delete a device from a Zoom account.
|
|
644
|
-
* **Prerequisites:**
|
|
645
|
-
* * Device must be enrolled in ZMD (Zoom Device Management)
|
|
646
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin`
|
|
647
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
648
|
-
* @link /devices/{deviceId}
|
|
649
|
-
*/
|
|
650
|
-
declare function deleteDevice({ pathParams, config, }?: {
|
|
651
|
-
pathParams: {
|
|
652
|
-
deviceId: string;
|
|
653
|
-
};
|
|
654
|
-
config?: Partial<FetcherConfig> & {
|
|
655
|
-
client?: typeof client;
|
|
656
|
-
};
|
|
657
|
-
}): Promise<unknown>;
|
|
658
|
-
/**
|
|
659
|
-
* @summary Change device
|
|
660
|
-
* @description Change device name.
|
|
661
|
-
* **Prerequisites:**
|
|
662
|
-
* * Device must be enrolled in ZMD (Zoom Device Management)
|
|
663
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin`
|
|
664
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
665
|
-
* @link /devices/{deviceId}
|
|
666
|
-
*/
|
|
667
|
-
declare function updateDevice({ pathParams, body, config, }?: {
|
|
668
|
-
pathParams: {
|
|
669
|
-
deviceId: string;
|
|
670
|
-
};
|
|
671
|
-
body?: UpdateDeviceBody;
|
|
672
|
-
config?: Partial<FetcherConfig> & {
|
|
673
|
-
client?: typeof client;
|
|
674
|
-
};
|
|
675
|
-
}): Promise<unknown>;
|
|
676
|
-
/**
|
|
677
|
-
* @summary Assign a device to a group
|
|
678
|
-
* @description Assign a device to a new group.
|
|
679
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin`
|
|
680
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:group:admin`,`device:write:group:master`
|
|
681
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
682
|
-
* @link /devices/{deviceId}/assign_group
|
|
683
|
-
*/
|
|
684
|
-
declare function assginGroup({ pathParams, queryParams, config, }?: {
|
|
685
|
-
pathParams: {
|
|
686
|
-
deviceId: string;
|
|
687
|
-
};
|
|
688
|
-
queryParams?: {
|
|
689
|
-
group_id?: string;
|
|
690
|
-
};
|
|
691
|
-
config?: Partial<FetcherConfig> & {
|
|
692
|
-
client?: typeof client;
|
|
693
|
-
};
|
|
694
|
-
}): Promise<unknown>;
|
|
695
|
-
/**
|
|
696
|
-
* @summary Change device association
|
|
697
|
-
* @description Change a device's association from one Zoom Room to another. **Prerequisites** Device must be enrolled in ZDM (Zoom Device Management). \n\n**Note** Currently, only Poly TC10’s may make Zoom Room assignments.
|
|
698
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:write:admin`
|
|
699
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `device:update:zdm_device_assignment:admin`
|
|
700
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
701
|
-
* @link /devices/{deviceId}/assignment
|
|
702
|
-
*/
|
|
703
|
-
declare function changeDeviceAssociation({ pathParams, body, config, }?: {
|
|
704
|
-
pathParams: {
|
|
705
|
-
deviceId: string;
|
|
706
|
-
};
|
|
707
|
-
body?: ChangeDeviceAssociationBody;
|
|
708
|
-
config?: Partial<FetcherConfig> & {
|
|
709
|
-
client?: typeof client;
|
|
710
|
-
};
|
|
711
|
-
}): Promise<unknown>;
|
|
712
|
-
/**
|
|
713
|
-
* @summary List H.323/SIP devices
|
|
714
|
-
* @description A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to list all H.323/SIP Devices on a Zoom account.
|
|
715
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323:read:admin`
|
|
716
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323_device:read:list_devices:admin`
|
|
717
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
718
|
-
* @link /h323/devices
|
|
719
|
-
*/
|
|
720
|
-
declare function deviceList({ queryParams, config, }?: {
|
|
721
|
-
queryParams?: {
|
|
722
|
-
page_size?: number;
|
|
723
|
-
page_number?: number;
|
|
724
|
-
next_page_token?: string;
|
|
725
|
-
};
|
|
726
|
-
config?: Partial<FetcherConfig> & {
|
|
727
|
-
client?: typeof client;
|
|
728
|
-
};
|
|
729
|
-
}): Promise<unknown>;
|
|
730
|
-
/**
|
|
731
|
-
* @summary Create a H.323/SIP device
|
|
732
|
-
* @description A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to add a H.323/SIP device to your Zoom account
|
|
733
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323:write:admin`
|
|
734
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323_device:write:device:admin`
|
|
735
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
736
|
-
* @link /h323/devices
|
|
737
|
-
*/
|
|
738
|
-
declare function deviceCreate({ body, config, }?: {
|
|
739
|
-
body?: DeviceCreateBody;
|
|
740
|
-
config?: Partial<FetcherConfig> & {
|
|
741
|
-
client?: typeof client;
|
|
742
|
-
};
|
|
743
|
-
}): Promise<unknown>;
|
|
744
|
-
/**
|
|
745
|
-
* @summary Delete a H.323/SIP device
|
|
746
|
-
* @description A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to delete a H.323/SIP device from your Zoom account.
|
|
747
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323:write:admin`
|
|
748
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323_device:delete:device:admin`
|
|
749
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
750
|
-
* @link /h323/devices/{deviceId}
|
|
751
|
-
*/
|
|
752
|
-
declare function deviceDelete({ pathParams, config, }?: {
|
|
753
|
-
pathParams: {
|
|
754
|
-
deviceId: string;
|
|
755
|
-
};
|
|
756
|
-
config?: Partial<FetcherConfig> & {
|
|
757
|
-
client?: typeof client;
|
|
758
|
-
};
|
|
759
|
-
}): Promise<unknown>;
|
|
760
|
-
/**
|
|
761
|
-
* @summary Update a H.323/SIP device
|
|
762
|
-
* @description Edit information for a H.323/SIP device from your Zoom account.
|
|
763
|
-
* A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting.
|
|
764
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323:write:admin`
|
|
765
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `h323_device:update:device:admin`
|
|
766
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
767
|
-
* @link /h323/devices/{deviceId}
|
|
768
|
-
*/
|
|
769
|
-
declare function deviceUpdate({ pathParams, body, config, }?: {
|
|
770
|
-
pathParams: {
|
|
771
|
-
deviceId: string;
|
|
772
|
-
};
|
|
773
|
-
body?: DeviceUpdateBody;
|
|
774
|
-
config?: Partial<FetcherConfig> & {
|
|
775
|
-
client?: typeof client;
|
|
776
|
-
};
|
|
777
|
-
}): Promise<unknown>;
|
|
778
|
-
/**
|
|
779
|
-
* @summary Add a meeting app
|
|
780
|
-
* @description Add an auto-open app in a meeting. This endpoint lets a developer auto-open an app in a specific meeting. This is only for configuring an app to automatically open before a given session. This can't open the app while a meeting or webinar is in session.
|
|
781
|
-
* **Prerequisites**:
|
|
782
|
-
* * The meeting must not be a live meeting.
|
|
783
|
-
* * The **Zoom Apps Quick Launch Button** setting enabled in the Zoom web portal.
|
|
784
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
785
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:open_app`,`meeting:write:open_app:admin`
|
|
786
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
787
|
-
* @link /meetings/{meetingId}/open_apps
|
|
788
|
-
*/
|
|
789
|
-
declare function meetingAppAdd({ pathParams, body, config, }?: {
|
|
790
|
-
pathParams: {
|
|
791
|
-
meetingId: bigint;
|
|
792
|
-
};
|
|
793
|
-
body?: MeetingAppAddBody;
|
|
794
|
-
config?: Partial<FetcherConfig> & {
|
|
795
|
-
client?: typeof client;
|
|
796
|
-
};
|
|
797
|
-
}): Promise<unknown>;
|
|
798
|
-
/**
|
|
799
|
-
* @summary Delete a meeting app
|
|
800
|
-
* @description Delete a meeting auto-open app.
|
|
801
|
-
* **Prerequisites**:
|
|
802
|
-
* * The meeting must not be a live meeting.
|
|
803
|
-
* * The **Zoom Apps Quick Launch Button** setting enabled in the Zoom web portal.
|
|
804
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
805
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:open_app`,`meeting:delete:open_app:admin`
|
|
806
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
807
|
-
* @link /meetings/{meetingId}/open_apps
|
|
808
|
-
*/
|
|
809
|
-
declare function meetingAppDelete({ pathParams, config, }?: {
|
|
810
|
-
pathParams: {
|
|
811
|
-
meetingId: bigint;
|
|
812
|
-
};
|
|
813
|
-
config?: Partial<FetcherConfig> & {
|
|
814
|
-
client?: typeof client;
|
|
815
|
-
};
|
|
816
|
-
}): Promise<unknown>;
|
|
817
|
-
/**
|
|
818
|
-
* @summary Delete a live meeting message
|
|
819
|
-
* @description Delete a message in a live meeting, based on ID.
|
|
820
|
-
* **Prerequisites:**
|
|
821
|
-
* * Have Zoom enable the DLP for the in-meeting chat feature to use this API.
|
|
822
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
823
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:live_meeting_chat_message`,`meeting:delete:live_meeting_chat_message:admin`
|
|
824
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
825
|
-
* @link /live_meetings/{meetingId}/chat/messages/{messageId}
|
|
826
|
-
*/
|
|
827
|
-
declare function deleteMeetingChatMessageById({ pathParams, queryParams, config, }?: {
|
|
828
|
-
pathParams: {
|
|
829
|
-
meetingId: bigint;
|
|
830
|
-
messageId: string;
|
|
831
|
-
};
|
|
832
|
-
queryParams?: {
|
|
833
|
-
file_ids?: string;
|
|
834
|
-
};
|
|
835
|
-
config?: Partial<FetcherConfig> & {
|
|
836
|
-
client?: typeof client;
|
|
837
|
-
};
|
|
838
|
-
}): Promise<unknown>;
|
|
839
|
-
/**
|
|
840
|
-
* @summary Update a live meeting message
|
|
841
|
-
* @description 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.
|
|
842
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
843
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:live_meeting_chat_message`,`meeting:update:live_meeting_chat_message:admin`
|
|
844
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
845
|
-
* @link /live_meetings/{meetingId}/chat/messages/{messageId}
|
|
846
|
-
*/
|
|
847
|
-
declare function updateMeetingChatMessageById({ pathParams, body, config, }?: {
|
|
848
|
-
pathParams: {
|
|
849
|
-
meetingId: bigint;
|
|
850
|
-
messageId: string;
|
|
851
|
-
};
|
|
852
|
-
body?: UpdateMeetingChatMessageByIdBody;
|
|
853
|
-
config?: Partial<FetcherConfig> & {
|
|
854
|
-
client?: typeof client;
|
|
855
|
-
};
|
|
856
|
-
}): Promise<unknown>;
|
|
857
|
-
/**
|
|
858
|
-
* @summary In-meeting controls
|
|
859
|
-
* @description [In-meeting](https://support.zoom.us/hc/en-us/articles/360021921032-In-Meeting-Controls) controls include starting, stopping, pausing, and resuming a recording; inviting participants; updating the waiting room with a custom message; and starting, stopping, or disabling Zoom AI.
|
|
860
|
-
* **Note:** This API's recording control only works for cloud recordings, **not** for local recordings.
|
|
861
|
-
* **Prerequisites:**
|
|
862
|
-
* * The user calling this API must be the host or an alternative meeting host.
|
|
863
|
-
* * The meeting must be a live meeting, except when inviting participants to the meeting through [call out (phone)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062038)/[call out (room system)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065721).
|
|
864
|
-
* * The [Cloud recording](https://support.zoom.us/hc/en-us/articles/360060231472-Enabling-cloud-recording) control must be enabled.
|
|
865
|
-
* * The [Zoom AI](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057623) control must be enabled.
|
|
866
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`,`meeting:master`
|
|
867
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:in_meeting_controls`,`meeting:update:in_meeting_controls:admin`
|
|
868
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
869
|
-
* @link /live_meetings/{meetingId}/events
|
|
870
|
-
*/
|
|
871
|
-
declare function inMeetingControl({ pathParams, body, config, }?: {
|
|
872
|
-
pathParams: {
|
|
873
|
-
meetingId: string;
|
|
874
|
-
};
|
|
875
|
-
body?: InMeetingControlBody;
|
|
876
|
-
config?: Partial<FetcherConfig> & {
|
|
877
|
-
client?: typeof client;
|
|
878
|
-
};
|
|
879
|
-
}): Promise<unknown>;
|
|
880
|
-
/**
|
|
881
|
-
* @summary Get a meeting's join token for local recording
|
|
882
|
-
* @description Get a meeting's join token to allow for local recording. The join token lets a recording bot implemented using Zoom Meeting SDK to connect to a Zoom meeting. The recording bot can then automatically start locally recording. This supports both regular and raw local recording types.
|
|
883
|
-
* **Prerequisites:**
|
|
884
|
-
* * The **Local recording** user setting enabled in the Zoom web portal.
|
|
885
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_token:read:admin:local_recording`,`meeting_token:read:local_recording`
|
|
886
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:local_recording_token`,`meeting:read:local_recording_token:admin`
|
|
887
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
888
|
-
* @link /meetings/{meetingId}/jointoken/local_recording
|
|
889
|
-
*/
|
|
890
|
-
declare function meetingLocalRecordingJoinToken({ pathParams, queryParams, config, }?: {
|
|
891
|
-
pathParams: {
|
|
892
|
-
meetingId: bigint;
|
|
893
|
-
};
|
|
894
|
-
queryParams?: {
|
|
895
|
-
bypass_waiting_room?: boolean;
|
|
896
|
-
};
|
|
897
|
-
config?: Partial<FetcherConfig> & {
|
|
898
|
-
client?: typeof client;
|
|
899
|
-
};
|
|
900
|
-
}): Promise<unknown>;
|
|
901
|
-
/**
|
|
902
|
-
* @summary Get meeting's token
|
|
903
|
-
* @description Get a meeting's [closed caption token (caption URL)](https://support.zoom.us/hc/en-us/articles/115002212983-Using-a-third-party-closed-captioning-service). This token lets you use a third-party service to stream text to their closed captioning software to the Zoom meeting.
|
|
904
|
-
* **Prerequisites:**
|
|
905
|
-
* * The **Closed captioning** setting enabled in the Zoom web portal.
|
|
906
|
-
* * The **Allow use of caption API Token to integrate with third-party closed captioning services** setting enabled.
|
|
907
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
908
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:token`,`meeting:read:token:admin`
|
|
909
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
910
|
-
* @link /meetings/{meetingId}/token
|
|
911
|
-
*/
|
|
912
|
-
declare function meetingToken({ pathParams, queryParams, config, }?: {
|
|
913
|
-
pathParams: {
|
|
914
|
-
meetingId: bigint;
|
|
915
|
-
};
|
|
916
|
-
queryParams?: {
|
|
917
|
-
type?: "closed_caption_token";
|
|
918
|
-
};
|
|
919
|
-
config?: Partial<FetcherConfig> & {
|
|
920
|
-
client?: typeof client;
|
|
921
|
-
};
|
|
922
|
-
}): Promise<unknown>;
|
|
923
|
-
/**
|
|
924
|
-
* @summary Perform batch registration
|
|
925
|
-
* @description Register up to 30 registrants at once for a meeting that requires [registration](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).
|
|
926
|
-
* **Prerequisites:**
|
|
927
|
-
* * The meeting host must be a Licensed user.
|
|
928
|
-
* * The meeting must require registration and should be of type `2`, i.e., they should be scheduled meetings. Instant meetings and Recurring meetings are not supported by this API.
|
|
929
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
930
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:batch_registrants`,`meeting:write:batch_registrants:admin`
|
|
931
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
932
|
-
* @link /meetings/{meetingId}/batch_registrants
|
|
933
|
-
*/
|
|
934
|
-
declare function addBatchRegistrants({ pathParams, body, config, }?: {
|
|
935
|
-
pathParams: {
|
|
936
|
-
meetingId: string;
|
|
937
|
-
};
|
|
938
|
-
body?: AddBatchRegistrantsBody;
|
|
939
|
-
config?: Partial<FetcherConfig> & {
|
|
940
|
-
client?: typeof client;
|
|
941
|
-
};
|
|
942
|
-
}): Promise<unknown>;
|
|
943
|
-
/**
|
|
944
|
-
* @summary Get meeting invitation
|
|
945
|
-
* @description Retrieve the meeting invitation note for a specific meeting.
|
|
946
|
-
* **Prerequisites**:
|
|
947
|
-
* * Host user must have a Zoom Meetings Basic license or higher.
|
|
948
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
949
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:invitation`,`meeting:read:invitation:admin`
|
|
950
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
951
|
-
* @link /meetings/{meetingId}/invitation
|
|
952
|
-
*/
|
|
953
|
-
declare function meetingInvitation({ pathParams, config, }?: {
|
|
954
|
-
pathParams: {
|
|
955
|
-
meetingId: bigint;
|
|
956
|
-
};
|
|
957
|
-
config?: Partial<FetcherConfig> & {
|
|
958
|
-
client?: typeof client;
|
|
959
|
-
};
|
|
960
|
-
}): Promise<unknown>;
|
|
961
|
-
/**
|
|
962
|
-
* @summary Create a meeting's invite links
|
|
963
|
-
* @description Create a batch of invitation links for a meeting.
|
|
964
|
-
* **Prerequisites**:
|
|
965
|
-
* * 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.
|
|
966
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
967
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:invite_links`,`meeting:write:invite_links:admin`
|
|
968
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
969
|
-
* @link /meetings/{meetingId}/invite_links
|
|
970
|
-
*/
|
|
971
|
-
declare function meetingInviteLinksCreate({ pathParams, body, config, }?: {
|
|
972
|
-
pathParams: {
|
|
973
|
-
meetingId: bigint;
|
|
974
|
-
};
|
|
975
|
-
body?: MeetingInviteLinksCreateBody;
|
|
976
|
-
config?: Partial<FetcherConfig> & {
|
|
977
|
-
client?: typeof client;
|
|
978
|
-
};
|
|
979
|
-
}): Promise<unknown>;
|
|
980
|
-
/**
|
|
981
|
-
* @summary List meeting registrants
|
|
982
|
-
* @description List users that have registered for a meeting. A host or a user with admin permission can require [registration for a Zoom meeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).
|
|
983
|
-
* **Prerequisites**:
|
|
984
|
-
* * Host user type must be **Pro** or higher plan.
|
|
985
|
-
* * Registration must be enabled for the meeting.
|
|
986
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
987
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_registrants`,`meeting:read:list_registrants:admin`
|
|
988
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
989
|
-
* @link /meetings/{meetingId}/registrants
|
|
990
|
-
*/
|
|
991
|
-
declare function meetingRegistrants({ pathParams, queryParams, config, }?: {
|
|
992
|
-
pathParams: {
|
|
993
|
-
meetingId: bigint;
|
|
994
|
-
};
|
|
995
|
-
queryParams?: {
|
|
996
|
-
occurrence_id?: string;
|
|
997
|
-
status?: "pending" | "approved" | "denied";
|
|
998
|
-
page_size?: number;
|
|
999
|
-
page_number?: number;
|
|
1000
|
-
next_page_token?: string;
|
|
1001
|
-
};
|
|
1002
|
-
config?: Partial<FetcherConfig> & {
|
|
1003
|
-
client?: typeof client;
|
|
1004
|
-
};
|
|
1005
|
-
}): Promise<unknown>;
|
|
1006
|
-
/**
|
|
1007
|
-
* @summary Add a meeting registrant
|
|
1008
|
-
* @description Create and submit a user's registration to a meeting. See [Customizing webinar registration](https://support.zoom.us/hc/en-us/articles/202835649-Customizing-webinar-registration) for details on how to set the requirements for these fields. Note that there is a maximum limit of 4,999 registrants per meeting and users will see an error if the meeting's capacity is reached.
|
|
1009
|
-
* **Prerequisites:**
|
|
1010
|
-
* * The host must be a **Licensed** user type.
|
|
1011
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
1012
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:registrant`,`meeting:write:registrant:admin`
|
|
1013
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1014
|
-
* @link /meetings/{meetingId}/registrants
|
|
1015
|
-
*/
|
|
1016
|
-
declare function meetingRegistrantCreate({ pathParams, body, queryParams, config, }?: {
|
|
1017
|
-
pathParams: {
|
|
1018
|
-
meetingId: bigint;
|
|
1019
|
-
};
|
|
1020
|
-
body?: MeetingRegistrantCreateBody;
|
|
1021
|
-
queryParams?: {
|
|
1022
|
-
occurrence_ids?: string;
|
|
1023
|
-
};
|
|
1024
|
-
config?: Partial<FetcherConfig> & {
|
|
1025
|
-
client?: typeof client;
|
|
1026
|
-
};
|
|
1027
|
-
}): Promise<unknown>;
|
|
1028
|
-
/**
|
|
1029
|
-
* @summary List registration questions
|
|
1030
|
-
* @description List registration questions that will be displayed to users while [registering for a meeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).
|
|
1031
|
-
* **Prerequisites**:
|
|
1032
|
-
* * Host user type must be **Pro** or higher plan.
|
|
1033
|
-
* * Registration must be enabled for the meeting.
|
|
1034
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
1035
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_registration_questions`,`meeting:read:list_registration_questions:admin`
|
|
1036
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1037
|
-
* @link /meetings/{meetingId}/registrants/questions
|
|
1038
|
-
*/
|
|
1039
|
-
declare function meetingRegistrantsQuestionsGet({ pathParams, config, }?: {
|
|
1040
|
-
pathParams: {
|
|
1041
|
-
meetingId: bigint;
|
|
1042
|
-
};
|
|
1043
|
-
config?: Partial<FetcherConfig> & {
|
|
1044
|
-
client?: typeof client;
|
|
1045
|
-
};
|
|
1046
|
-
}): Promise<unknown>;
|
|
1047
|
-
/**
|
|
1048
|
-
* @summary Update registration questions
|
|
1049
|
-
* @description Update registration questions that will be displayed to users while [registering for a meeting](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).
|
|
1050
|
-
* **Prerequisites**:
|
|
1051
|
-
* * Host user type must be **Pro** or higher plan.
|
|
1052
|
-
* * Registration must be enabled for the meeting.
|
|
1053
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
1054
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:registration_question`,`meeting:update:registration_question:admin`
|
|
1055
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1056
|
-
* @link /meetings/{meetingId}/registrants/questions
|
|
1057
|
-
*/
|
|
1058
|
-
declare function meetingRegistrantQuestionUpdate({ pathParams, body, config, }?: {
|
|
1059
|
-
pathParams: {
|
|
1060
|
-
meetingId: bigint;
|
|
1061
|
-
};
|
|
1062
|
-
body?: MeetingRegistrantQuestionUpdateBody;
|
|
1063
|
-
config?: Partial<FetcherConfig> & {
|
|
1064
|
-
client?: typeof client;
|
|
1065
|
-
};
|
|
1066
|
-
}): Promise<unknown>;
|
|
1067
|
-
/**
|
|
1068
|
-
* @summary Update registrant's status
|
|
1069
|
-
* @description Update a meeting registrant's status by either approving, cancelling or denying a registrant from joining the meeting.
|
|
1070
|
-
* **Prerequisites**:
|
|
1071
|
-
* * Host user type must be **Pro** or higher plan.
|
|
1072
|
-
* * Registration must be enabled for the meeting.
|
|
1073
|
-
* This API has an additional rate limit of requests per registrant, per 24-hour period. [See the Rate Limits page](/docs/api/rate-limits/) for more information.
|
|
1074
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
1075
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:registrant_status`,`meeting:update:registrant_status:admin`
|
|
1076
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
1077
|
-
* @link /meetings/{meetingId}/registrants/status
|
|
1078
|
-
*/
|
|
1079
|
-
declare function meetingRegistrantStatus({ pathParams, body, queryParams, config, }?: {
|
|
1080
|
-
pathParams: {
|
|
1081
|
-
meetingId: bigint;
|
|
1082
|
-
};
|
|
1083
|
-
body?: MeetingRegistrantStatusBody;
|
|
1084
|
-
queryParams?: {
|
|
1085
|
-
occurrence_id?: string;
|
|
1086
|
-
};
|
|
1087
|
-
config?: Partial<FetcherConfig> & {
|
|
1088
|
-
client?: typeof client;
|
|
1089
|
-
};
|
|
1090
|
-
}): Promise<unknown>;
|
|
1091
|
-
/**
|
|
1092
|
-
* @summary Get a meeting registrant
|
|
1093
|
-
* @description Retrieve details on a specific user who has registered for the meeting. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).
|
|
1094
|
-
* **Prerequisites:**
|
|
1095
|
-
* * The account must have a Meeting plan
|
|
1096
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
1097
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:registrant`,`meeting:read:registrant:admin`
|
|
1098
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1099
|
-
* @link /meetings/{meetingId}/registrants/{registrantId}
|
|
1100
|
-
*/
|
|
1101
|
-
declare function meetingRegistrantGet({ pathParams, config, }?: {
|
|
1102
|
-
pathParams: {
|
|
1103
|
-
meetingId: bigint;
|
|
1104
|
-
registrantId: string;
|
|
1105
|
-
};
|
|
1106
|
-
config?: Partial<FetcherConfig> & {
|
|
1107
|
-
client?: typeof client;
|
|
1108
|
-
};
|
|
1109
|
-
}): Promise<unknown>;
|
|
1110
|
-
/**
|
|
1111
|
-
* @summary Delete a meeting registrant
|
|
1112
|
-
* @description Delete a meeting registrant.
|
|
1113
|
-
* **Prerequisites**:
|
|
1114
|
-
* * Host user type must be Pro or higher plan.
|
|
1115
|
-
* * Registration must be enabled for the meeting.
|
|
1116
|
-
* * For recurring meetings:
|
|
1117
|
-
* * The `registration_type` must be 2 or 3 to require the `occurrence_id` field.
|
|
1118
|
-
* * If the `registration_type` is 1, the `occurrence_id` is not needed, as registrants can attend any occurrence.
|
|
1119
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
1120
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:registrant`,`meeting:delete:registrant:admin`
|
|
1121
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1122
|
-
* @link /meetings/{meetingId}/registrants/{registrantId}
|
|
1123
|
-
*/
|
|
1124
|
-
declare function meetingregistrantdelete({ pathParams, queryParams, config, }?: {
|
|
1125
|
-
pathParams: {
|
|
1126
|
-
meetingId: number;
|
|
1127
|
-
registrantId: string;
|
|
1128
|
-
};
|
|
1129
|
-
queryParams?: {
|
|
1130
|
-
occurrence_id?: string;
|
|
1131
|
-
};
|
|
1132
|
-
config?: Partial<FetcherConfig> & {
|
|
1133
|
-
client?: typeof client;
|
|
1134
|
-
};
|
|
1135
|
-
}): Promise<unknown>;
|
|
1136
|
-
/**
|
|
1137
|
-
* @summary Get a meeting's join token for live streaming
|
|
1138
|
-
* @description Get a meeting's join token to allow live streaming. The join token allows a recording bot implemented using Zoom meeting SDK to connect to a Zoom meeting "hosted by the issuer of the token", and can call the streaming method automatically. It supports both regular live streaming, and raw streaming.
|
|
1139
|
-
* **Prerequisites:**
|
|
1140
|
-
* * A Pro or higher plan for the meeting host.
|
|
1141
|
-
* * The **Allow livestreaming of meetings** user setting enabled in the Zoom web portal.
|
|
1142
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_token:read:admin:live_streaming`,`meeting_token:read:live_streaming`
|
|
1143
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:live_streaming_token`,`meeting:read:live_streaming_token:admin`
|
|
1144
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1145
|
-
* @link /meetings/{meetingId}/jointoken/live_streaming
|
|
1146
|
-
*/
|
|
1147
|
-
declare function meetingLiveStreamingJoinToken({ pathParams, config, }?: {
|
|
1148
|
-
pathParams: {
|
|
1149
|
-
meetingId: bigint;
|
|
1150
|
-
};
|
|
1151
|
-
config?: Partial<FetcherConfig> & {
|
|
1152
|
-
client?: typeof client;
|
|
1153
|
-
};
|
|
1154
|
-
}): Promise<unknown>;
|
|
1155
|
-
/**
|
|
1156
|
-
* @summary Get livestream details
|
|
1157
|
-
* @description Zoom allows users to [livestream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Get a meeting's livestream configuration details such as Stream URL, Stream Key and Page URL.
|
|
1158
|
-
* **Prerequisites:**
|
|
1159
|
-
* * Meeting host must be a licensed user with a Pro or higher plan.
|
|
1160
|
-
* * Live streaming details must have been [configured](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service#h_01589a6f-a40a-4e18-a448-cb746e52ebc5) for the meeting.
|
|
1161
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
1162
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:livestream`,`meeting:read:livestream:admin`
|
|
1163
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1164
|
-
* @link /meetings/{meetingId}/livestream
|
|
1165
|
-
*/
|
|
1166
|
-
declare function getMeetingLiveStreamDetails({ pathParams, config, }?: {
|
|
1167
|
-
pathParams: {
|
|
1168
|
-
meetingId: string;
|
|
1169
|
-
};
|
|
1170
|
-
config?: Partial<FetcherConfig> & {
|
|
1171
|
-
client?: typeof client;
|
|
1172
|
-
};
|
|
1173
|
-
}): Promise<unknown>;
|
|
1174
|
-
/**
|
|
1175
|
-
* @summary Update a livestream
|
|
1176
|
-
* @description Update a meeting's livestream information. Zoom allows users to [livestream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform.
|
|
1177
|
-
* **Prerequisites:**
|
|
1178
|
-
* * Meeting host must have a Pro license.
|
|
1179
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
1180
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:livestream`,`meeting:update:livestream:admin`
|
|
1181
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1182
|
-
* @link /meetings/{meetingId}/livestream
|
|
1183
|
-
*/
|
|
1184
|
-
declare function meetingLiveStreamUpdate({ pathParams, body, config, }?: {
|
|
1185
|
-
pathParams: {
|
|
1186
|
-
meetingId: bigint;
|
|
1187
|
-
};
|
|
1188
|
-
body?: MeetingLiveStreamUpdateBody;
|
|
1189
|
-
config?: Partial<FetcherConfig> & {
|
|
1190
|
-
client?: typeof client;
|
|
1191
|
-
};
|
|
1192
|
-
}): Promise<unknown>;
|
|
1193
|
-
/**
|
|
1194
|
-
* @summary Update livestream status
|
|
1195
|
-
* @description Zoom allows users to [livestream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Update the status of a meeting's livestream.
|
|
1196
|
-
* **Prerequisites:**
|
|
1197
|
-
* * Meeting host must have a Pro license.
|
|
1198
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
1199
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:livestream_status`,`meeting:update:livestream_status:admin`
|
|
1200
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1201
|
-
* @link /meetings/{meetingId}/livestream/status
|
|
1202
|
-
*/
|
|
1203
|
-
declare function meetingLiveStreamStatusUpdate({ pathParams, body, config, }?: {
|
|
1204
|
-
pathParams: {
|
|
1205
|
-
meetingId: bigint;
|
|
1206
|
-
};
|
|
1207
|
-
body?: MeetingLiveStreamStatusUpdateBody;
|
|
1208
|
-
config?: Partial<FetcherConfig> & {
|
|
1209
|
-
client?: typeof client;
|
|
1210
|
-
};
|
|
1211
|
-
}): Promise<unknown>;
|
|
1212
|
-
/**
|
|
1213
|
-
* @summary Get a meeting transcript
|
|
1214
|
-
* @description Return a meeting's [transcript](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0076632) information. Use the `download_url` property listed in the response to download the transcript content.
|
|
1215
|
-
* To download the trancript, send the user's [OAuth access token](/docs/integrations/oauth/) as a Bearer token in the Authorization header.
|
|
1216
|
-
* `curl -H 'Authorization: Bearer <ACCESS_TOKEN>' https://{{base-domain}}//rec/meeting/transcript/download/xyz`
|
|
1217
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:read`,`recording:write`,`recording:read:admin`,`recording:write:admin`
|
|
1218
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:read:meeting_transcript`,`cloud_recording:read:meeting_transcript:admin`
|
|
1219
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
1220
|
-
* @link /meetings/{meetingId}/transcript
|
|
1221
|
-
*/
|
|
1222
|
-
declare function getMeetingTranscript({ pathParams, config, }?: {
|
|
1223
|
-
pathParams: {
|
|
1224
|
-
meetingId: string;
|
|
1225
|
-
};
|
|
1226
|
-
config?: Partial<FetcherConfig> & {
|
|
1227
|
-
client?: typeof client;
|
|
1228
|
-
};
|
|
1229
|
-
}): Promise<unknown>;
|
|
1230
|
-
/**
|
|
1231
|
-
* @summary Delete a meeting or webinar transcript
|
|
1232
|
-
* @description Delete a transcript for a meeting or webinar.
|
|
1233
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `recording:write`,`recording:write:admin`
|
|
1234
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `cloud_recording:delete:meeting_transcript`,`cloud_recording:delete:meeting_transcript:admin`
|
|
1235
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
1236
|
-
* @link /meetings/{meetingId}/transcript
|
|
1237
|
-
*/
|
|
1238
|
-
declare function deleteMeetingTranscript({ pathParams, config, }?: {
|
|
1239
|
-
pathParams: {
|
|
1240
|
-
meetingId: string;
|
|
1241
|
-
};
|
|
1242
|
-
config?: Partial<FetcherConfig> & {
|
|
1243
|
-
client?: typeof client;
|
|
1244
|
-
};
|
|
1245
|
-
}): Promise<unknown>;
|
|
1246
|
-
/**
|
|
1247
|
-
* @summary Update participant Real-Time Media Streams (RTMS) app status
|
|
1248
|
-
* @description Update the Real-Time Media Streams (RTMS) status for a specific participant in an ongoing meeting. Zoom lets individuals control their own RTMS during a meeting.
|
|
1249
|
-
* **Prerequisites:**
|
|
1250
|
-
* * The meeting must be in progress.
|
|
1251
|
-
* * Contact [Developer Support](https://developers.zoom.us/support/) to enable RTMS features.
|
|
1252
|
-
* * The **Allow apps to access meeting content** setting enabled in the Zoom web portal.
|
|
1253
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
1254
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:participant_rtms_app_status`,`meeting:update:participant_rtms_app_status:admin`
|
|
1255
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
1256
|
-
* @link /live_meetings/{meetingId}/rtms_app/status
|
|
1257
|
-
*/
|
|
1258
|
-
declare function meetingRTMSStatusUpdate({ pathParams, body, config, }?: {
|
|
1259
|
-
pathParams: {
|
|
1260
|
-
meetingId: bigint;
|
|
1261
|
-
};
|
|
1262
|
-
body?: MeetingRTMSStatusUpdateBody;
|
|
1263
|
-
config?: Partial<FetcherConfig> & {
|
|
1264
|
-
client?: typeof client;
|
|
1265
|
-
};
|
|
1266
|
-
}): Promise<unknown>;
|
|
1267
|
-
/**
|
|
1268
|
-
* @summary Get a meeting
|
|
1269
|
-
* @description Retrieve the given meeting's details.
|
|
1270
|
-
* **Prerequisites**
|
|
1271
|
-
* * Host user must have a Zoom Meetings Basic license or higher.
|
|
1272
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
1273
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:meeting`,`meeting:read:meeting:admin`
|
|
1274
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1275
|
-
* @link /meetings/{meetingId}
|
|
1276
|
-
*/
|
|
1277
|
-
declare function meeting({ pathParams, queryParams, config, }?: {
|
|
1278
|
-
pathParams: {
|
|
1279
|
-
meetingId: bigint;
|
|
1280
|
-
};
|
|
1281
|
-
queryParams?: {
|
|
1282
|
-
occurrence_id?: string;
|
|
1283
|
-
show_previous_occurrences?: boolean;
|
|
1284
|
-
};
|
|
1285
|
-
config?: Partial<FetcherConfig> & {
|
|
1286
|
-
client?: typeof client;
|
|
1287
|
-
};
|
|
1288
|
-
}): Promise<unknown>;
|
|
1289
|
-
/**
|
|
1290
|
-
* @summary Delete a meeting
|
|
1291
|
-
* @description Delete a meeting.
|
|
1292
|
-
* **Prerequisites**:
|
|
1293
|
-
* * For recurring meetings, the `occurrence_id` is required to delete a specific occurrence. If not provided, the entire recurring series will be deleted.
|
|
1294
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
1295
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:meeting`,`meeting:delete:meeting:admin`
|
|
1296
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1297
|
-
* @link /meetings/{meetingId}
|
|
1298
|
-
*/
|
|
1299
|
-
declare function meetingDelete({ pathParams, queryParams, config, }?: {
|
|
1300
|
-
pathParams: {
|
|
1301
|
-
meetingId: bigint;
|
|
1302
|
-
};
|
|
1303
|
-
queryParams?: {
|
|
1304
|
-
occurrence_id?: string;
|
|
1305
|
-
schedule_for_reminder?: boolean;
|
|
1306
|
-
cancel_meeting_reminder?: boolean;
|
|
1307
|
-
};
|
|
1308
|
-
config?: Partial<FetcherConfig> & {
|
|
1309
|
-
client?: typeof client;
|
|
1310
|
-
};
|
|
1311
|
-
}): Promise<unknown>;
|
|
1312
|
-
/**
|
|
1313
|
-
* @summary Update a meeting
|
|
1314
|
-
* @description Updates meeting details.
|
|
1315
|
-
* **Prerequisites**
|
|
1316
|
-
* * The `start_time` value must be a future date. If the value is omitted or a date is in the past, the API ignores this value and does not update any recurring meetings.
|
|
1317
|
-
* * The `recurrence` object is required only when updating the entire series of a recurring meeting with `type=8`.
|
|
1318
|
-
* * 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.
|
|
1319
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
1320
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:meeting:admin`,`meeting:update:meeting`
|
|
1321
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1322
|
-
* @link /meetings/{meetingId}
|
|
1323
|
-
*/
|
|
1324
|
-
declare function meetingUpdate({ pathParams, body, queryParams, config, }?: {
|
|
1325
|
-
pathParams: {
|
|
1326
|
-
meetingId: bigint;
|
|
1327
|
-
};
|
|
1328
|
-
body?: MeetingUpdateBody;
|
|
1329
|
-
queryParams?: {
|
|
1330
|
-
occurrence_id?: string;
|
|
1331
|
-
};
|
|
1332
|
-
config?: Partial<FetcherConfig> & {
|
|
1333
|
-
client?: typeof client;
|
|
1334
|
-
};
|
|
1335
|
-
}): Promise<unknown>;
|
|
1336
|
-
/**
|
|
1337
|
-
* @summary Get a meeting SIP URI with passcode
|
|
1338
|
-
* @description Get a meeting's SIP URI. The URI consists of the meeting ID, and may include the 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.
|
|
1339
|
-
* **Prerequisites**:
|
|
1340
|
-
* * 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.
|
|
1341
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:sip_dialing`,`meeting:write:admin:sip_dialing`
|
|
1342
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:sip_dialing`,`meeting:write:sip_dialing:admin`
|
|
1343
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
1344
|
-
* @link /meetings/{meetingId}/sip_dialing
|
|
1345
|
-
*/
|
|
1346
|
-
declare function getSipDialingWithPasscode({ pathParams, body, config, }?: {
|
|
1347
|
-
pathParams: {
|
|
1348
|
-
meetingId: bigint;
|
|
1349
|
-
};
|
|
1350
|
-
body?: GetSipDialingWithPasscodeBody;
|
|
1351
|
-
config?: Partial<FetcherConfig> & {
|
|
1352
|
-
client?: typeof client;
|
|
1353
|
-
};
|
|
1354
|
-
}): Promise<unknown>;
|
|
1355
|
-
/**
|
|
1356
|
-
* @summary Update meeting status
|
|
1357
|
-
* @description Update the status of a meeting.
|
|
1358
|
-
* **Prerequisites**:
|
|
1359
|
-
* * Host user must have a Zoom Meetings Basic license or higher.
|
|
1360
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
1361
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:status`,`meeting:update:status:admin`
|
|
1362
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1363
|
-
* @link /meetings/{meetingId}/status
|
|
1364
|
-
*/
|
|
1365
|
-
declare function meetingStatus({ pathParams, body, config, }?: {
|
|
1366
|
-
pathParams: {
|
|
1367
|
-
meetingId: bigint;
|
|
1368
|
-
};
|
|
1369
|
-
body?: MeetingStatusBody;
|
|
1370
|
-
config?: Partial<FetcherConfig> & {
|
|
1371
|
-
client?: typeof client;
|
|
1372
|
-
};
|
|
1373
|
-
}): Promise<unknown>;
|
|
1374
|
-
/**
|
|
1375
|
-
* @summary Get past meeting details
|
|
1376
|
-
* @description Get information about a past meeting.
|
|
1377
|
-
* **Prerequisites**
|
|
1378
|
-
* * The meeting must have ended before you can retrieve the data.
|
|
1379
|
-
* * You cannot access a meeting that occurred more than one year ago.
|
|
1380
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
1381
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:past_meeting`,`meeting:read:past_meeting:admin`
|
|
1382
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1383
|
-
* @link /past_meetings/{meetingId}
|
|
1384
|
-
*/
|
|
1385
|
-
declare function pastMeetingDetails({ pathParams, config, }?: {
|
|
1386
|
-
pathParams: {
|
|
1387
|
-
meetingId: string;
|
|
1388
|
-
};
|
|
1389
|
-
config?: Partial<FetcherConfig> & {
|
|
1390
|
-
client?: typeof client;
|
|
1391
|
-
};
|
|
1392
|
-
}): Promise<unknown>;
|
|
1393
|
-
/**
|
|
1394
|
-
* @summary List past meeting instances
|
|
1395
|
-
* @description Return a list of past meeting instances.
|
|
1396
|
-
* **Prerequisites**
|
|
1397
|
-
* * The meeting must have already occurred at least once. This endpoint only returns instances of meetings that have ended.
|
|
1398
|
-
* * You cannot retrieve instances for meetings that occurred more than 15 months ago.
|
|
1399
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
1400
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_past_instances`,`meeting:read:list_past_instances:admin`
|
|
1401
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
1402
|
-
* @link /past_meetings/{meetingId}/instances
|
|
1403
|
-
*/
|
|
1404
|
-
declare function pastMeetings({ pathParams, queryParams, config, }?: {
|
|
1405
|
-
pathParams: {
|
|
1406
|
-
meetingId: bigint;
|
|
1407
|
-
};
|
|
1408
|
-
queryParams?: {
|
|
1409
|
-
from?: string;
|
|
1410
|
-
to?: string;
|
|
1411
|
-
};
|
|
1412
|
-
config?: Partial<FetcherConfig> & {
|
|
1413
|
-
client?: typeof client;
|
|
1414
|
-
};
|
|
1415
|
-
}): Promise<unknown>;
|
|
1416
|
-
/**
|
|
1417
|
-
* @summary Get past meeting participants
|
|
1418
|
-
* @description Retrieve participant information for a past meeting.
|
|
1419
|
-
* **Prerequisites:**
|
|
1420
|
-
* * A paid account with a Pro plan or higher.
|
|
1421
|
-
* * If the meeting UUID starts with `/` or contains `//`, you must double-encode the UUID before sending the request.
|
|
1422
|
-
* * The meeting must be within the last 15 months. Participant data is not available for meetings older than 15 months.
|
|
1423
|
-
* * By default, this endpoint does not return participant data for meetings with only one participant. To include one-participant meetings, enable the account setting **Show one person meetings and webinars on Dashboard and Reports**.
|
|
1424
|
-
* * For meetings with hundreds of participants, attendance data may take time to be generated. If participant durations are returned as `0`, the request may have been made before processing completed. Wait briefly and retry.
|
|
1425
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
1426
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_past_participants`,`meeting:read:list_past_participants:admin`
|
|
1427
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
1428
|
-
* @link /past_meetings/{meetingId}/participants
|
|
1429
|
-
*/
|
|
1430
|
-
declare function pastMeetingParticipants({ pathParams, queryParams, config, }?: {
|
|
1431
|
-
pathParams: {
|
|
1432
|
-
meetingId: string;
|
|
1433
|
-
};
|
|
1434
|
-
queryParams?: {
|
|
1435
|
-
page_size?: number;
|
|
1436
|
-
next_page_token?: string;
|
|
1437
|
-
};
|
|
1438
|
-
config?: Partial<FetcherConfig> & {
|
|
1439
|
-
client?: typeof client;
|
|
1440
|
-
};
|
|
1441
|
-
}): Promise<unknown>;
|
|
1442
|
-
/**
|
|
1443
|
-
* @summary List past meetings' Q&A
|
|
1444
|
-
* @description List Q&A of a specific meeting.
|
|
1445
|
-
* The question & answer (Q&A) feature for Zoom Meetings lets attendees ask questions during a meeting and lets the other attendees answer those questions.
|
|
1446
|
-
* **Prerequisites**:
|
|
1447
|
-
* * Q&A must be enabled for the meeting.
|
|
1448
|
-
* * The meeting must have ended before you can retrieve the data.
|
|
1449
|
-
* * You cannot retrieve Q&A data for meetings that occurred more than 15 months ago.
|
|
1450
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
1451
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:past_qa`,`meeting:read:past_qa:admin`
|
|
1452
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
1453
|
-
* @link /past_meetings/{meetingId}/qa
|
|
1454
|
-
*/
|
|
1455
|
-
declare function listPastMeetingQA({ pathParams, config, }?: {
|
|
1456
|
-
pathParams: {
|
|
1457
|
-
meetingId: string;
|
|
1458
|
-
};
|
|
1459
|
-
config?: Partial<FetcherConfig> & {
|
|
1460
|
-
client?: typeof client;
|
|
1461
|
-
};
|
|
1462
|
-
}): Promise<unknown>;
|
|
1463
|
-
/**
|
|
1464
|
-
* @summary List meetings
|
|
1465
|
-
* @description List a meeting host user's scheduled meetings. For user-level apps, pass [the `me` value](/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.
|
|
1466
|
-
* **Prerequisites:**
|
|
1467
|
-
* * This API **only** supports scheduled meetings. This API does not return information about instant meetings.
|
|
1468
|
-
* * 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).
|
|
1469
|
-
* * When `type` is set to `upcoming`, `upcoming_meetings`, or `previous_meetings`, only a maximum of 6 months of meeting data will be returned.
|
|
1470
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
1471
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_meetings`,`meeting:read:list_meetings:admin`
|
|
1472
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
1473
|
-
* @link /users/{userId}/meetings
|
|
1474
|
-
*/
|
|
1475
|
-
declare function meetings({ pathParams, queryParams, config, }?: {
|
|
1476
|
-
pathParams: {
|
|
1477
|
-
userId: string;
|
|
1478
|
-
};
|
|
1479
|
-
queryParams?: {
|
|
1480
|
-
type?: "scheduled" | "live" | "upcoming" | "upcoming_meetings" | "previous_meetings";
|
|
1481
|
-
page_size?: number;
|
|
1482
|
-
next_page_token?: string;
|
|
1483
|
-
page_number?: number;
|
|
1484
|
-
from?: string;
|
|
1485
|
-
to?: string;
|
|
1486
|
-
timezone?: string;
|
|
1487
|
-
};
|
|
1488
|
-
config?: Partial<FetcherConfig> & {
|
|
1489
|
-
client?: typeof client;
|
|
1490
|
-
};
|
|
1491
|
-
}): Promise<unknown>;
|
|
1492
|
-
/**
|
|
1493
|
-
* @summary Create a meeting
|
|
1494
|
-
* @description [Creates a meeting](https://support.zoom.us/hc/en-us/articles/201362413-Scheduling-meetings) for a user. For user-level apps, pass [the `me` value](/docs/api/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.
|
|
1495
|
-
* **Prerequisites:**
|
|
1496
|
-
* * A meeting's `start_url` value is the URL a host or an alternative host can use to start a meeting. The `start_url` value's expiration time is **two hours** for all regular users.
|
|
1497
|
-
* * For `custCreate` meeting hosts - users created with the `custCreate` parameter via the [**Create users**](/docs/api/users/#tag/users/POST/users) API - the expiration time of the `start_url` parameter is **90 days** from the generation of the `start_url`.
|
|
1498
|
-
* * 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.
|
|
1499
|
-
* * **100 requests per day**. The rate limit is applied against the `userId` of the **meeting host** used to make the request.
|
|
1500
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
1501
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:meeting`,`meeting:write:meeting:admin`
|
|
1502
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1503
|
-
* @link /users/{userId}/meetings
|
|
1504
|
-
*/
|
|
1505
|
-
declare function meetingCreate({ pathParams, body, config, }?: {
|
|
1506
|
-
pathParams: {
|
|
1507
|
-
userId: string;
|
|
1508
|
-
};
|
|
1509
|
-
body?: MeetingCreateBody;
|
|
1510
|
-
config?: Partial<FetcherConfig> & {
|
|
1511
|
-
client?: typeof client;
|
|
1512
|
-
};
|
|
1513
|
-
}): Promise<unknown>;
|
|
1514
|
-
/**
|
|
1515
|
-
* @summary List upcoming meetings
|
|
1516
|
-
* @description List a Zoom user's upcoming meetings. For user-level apps, pass [the `me` value](/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.
|
|
1517
|
-
* **Notes**:
|
|
1518
|
-
* * This API includes the meetings that Zoom users schedule and the meetings they are invited to join.
|
|
1519
|
-
* * This API only includes upcoming meetings within the next 24 hours.
|
|
1520
|
-
* **Prerequisites**:
|
|
1521
|
-
* * 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.
|
|
1522
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
1523
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_upcoming_meetings`,`meeting:read:list_upcoming_meetings:admin`
|
|
1524
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
1525
|
-
* @link /users/{userId}/upcoming_meetings
|
|
1526
|
-
*/
|
|
1527
|
-
declare function listUpcomingMeeting({ pathParams, config, }?: {
|
|
1528
|
-
pathParams: {
|
|
1529
|
-
userId: string;
|
|
1530
|
-
};
|
|
1531
|
-
config?: Partial<FetcherConfig> & {
|
|
1532
|
-
client?: typeof client;
|
|
1533
|
-
};
|
|
1534
|
-
}): Promise<unknown>;
|
|
1535
|
-
/**
|
|
1536
|
-
* @summary List a user's PAC accounts
|
|
1537
|
-
* @description Retrieve a list of a user's [personal audio conference (PAC)](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference) accounts. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.
|
|
1538
|
-
* PAC allows Pro or higher account holders to host meetings through PSTN (phone dial-in) only.
|
|
1539
|
-
* **Prerequisites**
|
|
1540
|
-
* * 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.
|
|
1541
|
-
* * 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.
|
|
1542
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `pac:read:admin`,`pac:read`
|
|
1543
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `pac:read:list_pac_accounts`,`pac:read:list_pac_accounts:admin`
|
|
1544
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1545
|
-
* @link /users/{userId}/pac
|
|
1546
|
-
*/
|
|
1547
|
-
declare function userPACs({ pathParams, config, }?: {
|
|
1548
|
-
pathParams: {
|
|
1549
|
-
userId: string;
|
|
1550
|
-
};
|
|
1551
|
-
config?: Partial<FetcherConfig> & {
|
|
1552
|
-
client?: typeof client;
|
|
1553
|
-
};
|
|
1554
|
-
}): Promise<unknown>;
|
|
1555
|
-
/**
|
|
1556
|
-
* @summary Perform batch poll creation
|
|
1557
|
-
* @description Polls allow the meeting host to survey attendees. Create batch [polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting.
|
|
1558
|
-
* **Prerequisites**:
|
|
1559
|
-
* * Host user type must be **Pro** or higher plan.
|
|
1560
|
-
* * Polling feature must be enabled in the host's account.
|
|
1561
|
-
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
1562
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
1563
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:batch_polls`,`meeting:write:batch_polls:admin`
|
|
1564
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1565
|
-
* @link /meetings/{meetingId}/batch_polls
|
|
1566
|
-
*/
|
|
1567
|
-
declare function createBatchPolls({ pathParams, body, config, }?: {
|
|
1568
|
-
pathParams: {
|
|
1569
|
-
meetingId: string;
|
|
1570
|
-
};
|
|
1571
|
-
body?: CreateBatchPollsBody;
|
|
1572
|
-
config?: Partial<FetcherConfig> & {
|
|
1573
|
-
client?: typeof client;
|
|
1574
|
-
};
|
|
1575
|
-
}): Promise<unknown>;
|
|
1576
|
-
/**
|
|
1577
|
-
* @summary List meeting polls
|
|
1578
|
-
* @description Polls allow the meeting host to survey attendees. List all [polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) of a meeting.
|
|
1579
|
-
* **Prerequisites**:
|
|
1580
|
-
* * Host user type must be **Pro** or higher plan.
|
|
1581
|
-
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
1582
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
1583
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_polls`,`meeting:read:list_polls:admin`
|
|
1584
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1585
|
-
* @link /meetings/{meetingId}/polls
|
|
1586
|
-
*/
|
|
1587
|
-
declare function meetingPolls({ pathParams, queryParams, config, }?: {
|
|
1588
|
-
pathParams: {
|
|
1589
|
-
meetingId: bigint;
|
|
1590
|
-
};
|
|
1591
|
-
queryParams?: {
|
|
1592
|
-
anonymous?: boolean;
|
|
1593
|
-
};
|
|
1594
|
-
config?: Partial<FetcherConfig> & {
|
|
1595
|
-
client?: typeof client;
|
|
1596
|
-
};
|
|
1597
|
-
}): Promise<unknown>;
|
|
1598
|
-
/**
|
|
1599
|
-
* @summary Create a meeting poll
|
|
1600
|
-
* @description Polls allow the meeting host to survey attendees. Create a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting.
|
|
1601
|
-
* **Prerequisites**:
|
|
1602
|
-
* * Host user type must be **Pro** or higher plan.
|
|
1603
|
-
* * Polling feature must be enabled in the host's account.
|
|
1604
|
-
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
1605
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
1606
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:poll`,`meeting:write:poll:admin`
|
|
1607
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1608
|
-
* @link /meetings/{meetingId}/polls
|
|
1609
|
-
*/
|
|
1610
|
-
declare function meetingPollCreate({ pathParams, body, config, }?: {
|
|
1611
|
-
pathParams: {
|
|
1612
|
-
meetingId: bigint;
|
|
1613
|
-
};
|
|
1614
|
-
body?: MeetingPollCreateBody;
|
|
1615
|
-
config?: Partial<FetcherConfig> & {
|
|
1616
|
-
client?: typeof client;
|
|
1617
|
-
};
|
|
1618
|
-
}): Promise<unknown>;
|
|
1619
|
-
/**
|
|
1620
|
-
* @summary Get a meeting poll
|
|
1621
|
-
* @description Retrieves information about a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).
|
|
1622
|
-
* **Prerequisites**:
|
|
1623
|
-
* * Host must have Pro or higher plan.
|
|
1624
|
-
* * Enable the **Meeting Polls/Quizzes** setting in the Zoom web portal.
|
|
1625
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
1626
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:poll`,`meeting:read:poll:admin`
|
|
1627
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1628
|
-
* @link /meetings/{meetingId}/polls/{pollId}
|
|
1629
|
-
*/
|
|
1630
|
-
declare function meetingPollGet({ pathParams, config, }?: {
|
|
1631
|
-
pathParams: {
|
|
1632
|
-
meetingId: bigint;
|
|
1633
|
-
pollId: string;
|
|
1634
|
-
};
|
|
1635
|
-
config?: Partial<FetcherConfig> & {
|
|
1636
|
-
client?: typeof client;
|
|
1637
|
-
};
|
|
1638
|
-
}): Promise<unknown>;
|
|
1639
|
-
/**
|
|
1640
|
-
* @summary Update a meeting poll
|
|
1641
|
-
* @description Polls allow the meeting host to survey attendees. Update information of a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).
|
|
1642
|
-
* **Prerequisites**:
|
|
1643
|
-
* * Host user type must be **Pro** or higher plan.
|
|
1644
|
-
* * The **Meeting Polls/Quizzes** setting enabled in the Zoom web portal.
|
|
1645
|
-
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
1646
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
1647
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:poll`,`meeting:update:poll:admin`
|
|
1648
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1649
|
-
* @link /meetings/{meetingId}/polls/{pollId}
|
|
1650
|
-
*/
|
|
1651
|
-
declare function meetingPollUpdate({ pathParams, body, config, }?: {
|
|
1652
|
-
pathParams: {
|
|
1653
|
-
meetingId: bigint;
|
|
1654
|
-
pollId: string;
|
|
1655
|
-
};
|
|
1656
|
-
body?: MeetingPollUpdateBody;
|
|
1657
|
-
config?: Partial<FetcherConfig> & {
|
|
1658
|
-
client?: typeof client;
|
|
1659
|
-
};
|
|
1660
|
-
}): Promise<unknown>;
|
|
1661
|
-
/**
|
|
1662
|
-
* @summary Delete a meeting poll
|
|
1663
|
-
* @description Polls allow the meeting host to survey attendees. Delete a meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).
|
|
1664
|
-
* **Prerequisites**:
|
|
1665
|
-
* * Host user type must be **Pro**.
|
|
1666
|
-
* * Polling feature should be enabled in the host's account.
|
|
1667
|
-
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
1668
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
1669
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:poll`,`meeting:delete:poll:admin`
|
|
1670
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
1671
|
-
* @link /meetings/{meetingId}/polls/{pollId}
|
|
1672
|
-
*/
|
|
1673
|
-
declare function meetingPollDelete({ pathParams, config, }?: {
|
|
1674
|
-
pathParams: {
|
|
1675
|
-
meetingId: bigint;
|
|
1676
|
-
pollId: string;
|
|
1677
|
-
};
|
|
1678
|
-
config?: Partial<FetcherConfig> & {
|
|
1679
|
-
client?: typeof client;
|
|
1680
|
-
};
|
|
1681
|
-
}): Promise<unknown>;
|
|
1682
|
-
/**
|
|
1683
|
-
* @summary List past meeting's poll results
|
|
1684
|
-
* @description [Polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) allow the meeting host to survey attendees. List poll results of a meeting.
|
|
1685
|
-
* **Prerequisites**:
|
|
1686
|
-
* * Host user type must be **Pro**.
|
|
1687
|
-
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
1688
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:admin`,`meeting:read`
|
|
1689
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_poll_results`,`meeting:read:list_poll_results:admin`
|
|
1690
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
1691
|
-
* @link /past_meetings/{meetingId}/polls
|
|
1692
|
-
*/
|
|
1693
|
-
declare function listPastMeetingPolls({ pathParams, config, }?: {
|
|
1694
|
-
pathParams: {
|
|
1695
|
-
meetingId: string;
|
|
1696
|
-
};
|
|
1697
|
-
config?: Partial<FetcherConfig> & {
|
|
1698
|
-
client?: typeof client;
|
|
1699
|
-
};
|
|
1700
|
-
}): Promise<unknown>;
|
|
1701
|
-
/**
|
|
1702
|
-
* @summary Get sign In / sign out activity report
|
|
1703
|
-
* @description Retrieve a list of sign in / sign out activity logs [report](https://support.zoom.us/hc/en-us/articles/201363213-Getting-Started-with-Reports) of users under a Zoom account.
|
|
1704
|
-
* **Prerequisites**
|
|
1705
|
-
* * Pro or higher plan.
|
|
1706
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
1707
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:user_activities:admin`
|
|
1708
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
1709
|
-
* @link /report/activities
|
|
1710
|
-
*/
|
|
1711
|
-
declare function reportSignInSignOutActivities({ queryParams, config, }?: {
|
|
1712
|
-
queryParams?: {
|
|
1713
|
-
from?: string;
|
|
1714
|
-
to?: string;
|
|
1715
|
-
page_size?: number;
|
|
1716
|
-
next_page_token?: string;
|
|
1717
|
-
};
|
|
1718
|
-
config?: Partial<FetcherConfig> & {
|
|
1719
|
-
client?: typeof client;
|
|
1720
|
-
};
|
|
1721
|
-
}): Promise<unknown>;
|
|
1722
|
-
/**
|
|
1723
|
-
* @summary Get billing reports
|
|
1724
|
-
* @description Get department billing reports of a Zoom account.
|
|
1725
|
-
* **Prerequisites:**
|
|
1726
|
-
* * Pro or a higher account with Department Billing option enabled. Contact Zoom Support team for details.
|
|
1727
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
1728
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:billing:admin`
|
|
1729
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
1730
|
-
* @link /report/billing
|
|
1731
|
-
*/
|
|
1732
|
-
declare function getBillingReport({ config }?: {
|
|
1733
|
-
config?: Partial<FetcherConfig> & {
|
|
1734
|
-
client?: typeof client;
|
|
1735
|
-
};
|
|
1736
|
-
}): Promise<unknown>;
|
|
1737
|
-
/**
|
|
1738
|
-
* @summary Get billing invoice reports
|
|
1739
|
-
* @description Get department billing invoices reports for a specific billing period. Provide the `billing_id` of the billing period for which you would like to retrieve the invoices. Retrieve this ID from the **Get Billing Reports** API.
|
|
1740
|
-
* **Prerequisites:**
|
|
1741
|
-
* * Pro or a higher account with Department Billing option enabled. Contact the Zoom Support team to enable this feature.
|
|
1742
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
1743
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:billing_invoice:admin`
|
|
1744
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
1745
|
-
* @link /report/billing/invoices
|
|
1746
|
-
*/
|
|
1747
|
-
declare function getBillingInvoicesReports({ queryParams, config, }?: {
|
|
1748
|
-
queryParams?: {
|
|
1749
|
-
billing_id?: string;
|
|
1750
|
-
};
|
|
1751
|
-
config?: Partial<FetcherConfig> & {
|
|
1752
|
-
client?: typeof client;
|
|
1753
|
-
};
|
|
1754
|
-
}): Promise<unknown>;
|
|
1755
|
-
/**
|
|
1756
|
-
* @summary Get cloud recording usage report
|
|
1757
|
-
* @description Retrieve cloud recording usage report for a specified period. You can only get cloud recording reports that is one day earlier than the current date and for the most recent period of 6 months. The date gap between from and to dates should be smaller or equal to 30 days.
|
|
1758
|
-
* **Prerequisites**
|
|
1759
|
-
* * Pro or higher plan.
|
|
1760
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
1761
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
1762
|
-
* @link /report/cloud_recording
|
|
1763
|
-
*/
|
|
1764
|
-
declare function reportCloudRecording({ queryParams, config, }?: {
|
|
1765
|
-
queryParams?: {
|
|
1766
|
-
from?: string;
|
|
1767
|
-
to?: string;
|
|
1768
|
-
group_id?: string;
|
|
1769
|
-
};
|
|
1770
|
-
config?: Partial<FetcherConfig> & {
|
|
1771
|
-
client?: typeof client;
|
|
1772
|
-
};
|
|
1773
|
-
}): Promise<unknown>;
|
|
1774
|
-
/**
|
|
1775
|
-
* @summary Get daily usage report
|
|
1776
|
-
* @description Retrieve daily report to access the account-wide usage of Zoom services for each day in a given month. It lists the number of new users, meetings, participants, and meeting minutes.
|
|
1777
|
-
* **Prerequisites**
|
|
1778
|
-
* * Pro or higher plan.
|
|
1779
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
1780
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
1781
|
-
* @link /report/daily
|
|
1782
|
-
*/
|
|
1783
|
-
declare function reportDaily({ queryParams, config, }?: {
|
|
1784
|
-
queryParams?: {
|
|
1785
|
-
year?: number;
|
|
1786
|
-
month?: number;
|
|
1787
|
-
group_id?: string;
|
|
1788
|
-
};
|
|
1789
|
-
config?: Partial<FetcherConfig> & {
|
|
1790
|
-
client?: typeof client;
|
|
1791
|
-
};
|
|
1792
|
-
}): Promise<unknown>;
|
|
1793
|
-
/**
|
|
1794
|
-
* @summary Get disclaimer report
|
|
1795
|
-
* @description Retrieve a list of disclaimer records.
|
|
1796
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
1797
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:disclaimer:admin`
|
|
1798
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
1799
|
-
* @link /report/disclaimer
|
|
1800
|
-
*/
|
|
1801
|
-
declare function getdisclaimerreport({ queryParams, config, }?: {
|
|
1802
|
-
queryParams?: {
|
|
1803
|
-
from?: string;
|
|
1804
|
-
to?: string;
|
|
1805
|
-
search_value?: string;
|
|
1806
|
-
disclaimer_type?: "login" | "joinMeeting" | "recording" | "remoteControl" | "meetingConnector" | "archive" | "summary" | "query" | "AICompanion" | "caption" | "joinSDKMeeting" | "NDI" | "joinWebinar" | "internalMMRGuestJoin" | "liveStream" | "phoneACR" | "viewBOActivity" | "webinarBO" | "unmuteAudio" | "joinOnZoom" | "GDPR" | "chinaMeeting" | "zappJoin" | "softUpdateReminder" | "all";
|
|
1807
|
-
group_id?: string;
|
|
1808
|
-
page_size?: number;
|
|
1809
|
-
next_page_token?: string;
|
|
1810
|
-
};
|
|
1811
|
-
config?: Partial<FetcherConfig> & {
|
|
1812
|
-
client?: typeof client;
|
|
1813
|
-
};
|
|
1814
|
-
}): Promise<unknown>;
|
|
1815
|
-
/**
|
|
1816
|
-
* @summary Get history meeting and webinar list
|
|
1817
|
-
* @description Retrieve a list of history meetings and webinars.
|
|
1818
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
1819
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_history_meetings:admin`
|
|
1820
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
1821
|
-
* @link /report/history_meetings
|
|
1822
|
-
*/
|
|
1823
|
-
declare function gethistorymeetingandwebinarlist({ queryParams, config, }?: {
|
|
1824
|
-
queryParams?: {
|
|
1825
|
-
from?: string;
|
|
1826
|
-
to?: string;
|
|
1827
|
-
date_type?: "start_time" | "end_time";
|
|
1828
|
-
meeting_type?: "meeting" | "webinar" | "all";
|
|
1829
|
-
report_type?: "all" | "poll" | "survey" | "qa" | "resource" | "reaction";
|
|
1830
|
-
search_key?: string;
|
|
1831
|
-
page_size?: number;
|
|
1832
|
-
next_page_token?: string;
|
|
1833
|
-
group_id?: string;
|
|
1834
|
-
meeting_feature?: "screen_sharing" | "video_on" | "remote_control" | "closed_caption" | "language_interpretation" | "telephone_usage" | "in_meeting_chat" | "poll" | "join_by_room" | "waiting_room" | "live_transcription" | "reaction" | "zoom_apps" | "annotation" | "raise_hand" | "virtual_background" | "whiteboard" | "immersive_scene" | "avatar" | "switch_to_mobile" | "file_sharing" | "meeting_summary" | "meeting_questions" | "record_to_computer" | "record_to_cloud" | "live_translation" | "registration" | "smart_recording" | "multi_speaker" | "meeting_wallpaper" | "gen_ai_virtual_background" | "multi_share" | "document_collaboration" | "portrait_lighting" | "personalized_audio_isolation" | "color_themes";
|
|
1835
|
-
};
|
|
1836
|
-
config?: Partial<FetcherConfig> & {
|
|
1837
|
-
client?: typeof client;
|
|
1838
|
-
};
|
|
1839
|
-
}): Promise<unknown>;
|
|
1840
|
-
/**
|
|
1841
|
-
* @summary Get a meeting activities report
|
|
1842
|
-
* @description Retrieve a list of a meeting activity logs. Contact Zoom Support to enable the meeting audit trail log feature on your account.
|
|
1843
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
1844
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:meeting_activity_log:admin`
|
|
1845
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
1846
|
-
* @link /report/meeting_activities
|
|
1847
|
-
*/
|
|
1848
|
-
declare function reportMeetingactivitylogs({ queryParams, config, }?: {
|
|
1849
|
-
queryParams?: {
|
|
1850
|
-
from?: string;
|
|
1851
|
-
to?: string;
|
|
1852
|
-
page_size?: number;
|
|
1853
|
-
next_page_token?: string;
|
|
1854
|
-
meeting_number?: string;
|
|
1855
|
-
search_key?: string;
|
|
1856
|
-
activity_type?: "All Activities" | "Meeting Created" | "Meeting Started" | "User Join" | "User Left" | "Remote Control" | "In-Meeting Chat" | "Meeting Ended";
|
|
1857
|
-
};
|
|
1858
|
-
config?: Partial<FetcherConfig> & {
|
|
1859
|
-
client?: typeof client;
|
|
1860
|
-
};
|
|
1861
|
-
}): Promise<unknown>;
|
|
1862
|
-
/**
|
|
1863
|
-
* @summary Get meeting detail reports
|
|
1864
|
-
* @description Get a detailed report for a past meeting.
|
|
1865
|
-
* **Prerequisites**
|
|
1866
|
-
* * Pro or a higher plan.
|
|
1867
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
1868
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:meeting:admin`
|
|
1869
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
1870
|
-
* @link /report/meetings/{meetingId}
|
|
1871
|
-
*/
|
|
1872
|
-
declare function reportMeetingDetails({ pathParams, config, }?: {
|
|
1873
|
-
pathParams: {
|
|
1874
|
-
meetingId: string;
|
|
1875
|
-
};
|
|
1876
|
-
config?: Partial<FetcherConfig> & {
|
|
1877
|
-
client?: typeof client;
|
|
1878
|
-
};
|
|
1879
|
-
}): Promise<unknown>;
|
|
1880
|
-
/**
|
|
1881
|
-
* @summary Get meeting participant reports
|
|
1882
|
-
* @description Return a report of a past meeting with two or more participants, including the host. To return a report for past meeting with only **one** participant, use the [**List meeting participants**](/docs/api/accounts/#tag/dashboards/GET/metrics/meetings/{meetingId}/participants) API.
|
|
1883
|
-
* **Note:**
|
|
1884
|
-
* This API may return empty values for participants' `user_name`, `ip_address`, `location`, and `email` responses when the account calling this API:
|
|
1885
|
-
* * Is a [**legacy** HIPAA BAA account](/docs/api/references/legacy-business-associate-agreements/).
|
|
1886
|
-
* **Prerequisites:**
|
|
1887
|
-
* * A Pro or a higher plan.
|
|
1888
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
1889
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_meeting_participants:admin`
|
|
1890
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
1891
|
-
* @link /report/meetings/{meetingId}/participants
|
|
1892
|
-
*/
|
|
1893
|
-
declare function reportMeetingParticipants({ pathParams, queryParams, config, }?: {
|
|
1894
|
-
pathParams: {
|
|
1895
|
-
meetingId: string;
|
|
1896
|
-
};
|
|
1897
|
-
queryParams?: {
|
|
1898
|
-
page_size?: number;
|
|
1899
|
-
next_page_token?: string;
|
|
1900
|
-
include_fields?: "registrant_id";
|
|
1901
|
-
};
|
|
1902
|
-
config?: Partial<FetcherConfig> & {
|
|
1903
|
-
client?: typeof client;
|
|
1904
|
-
};
|
|
1905
|
-
}): Promise<unknown>;
|
|
1906
|
-
/**
|
|
1907
|
-
* @summary Get meeting poll reports
|
|
1908
|
-
* @description Use this API to get a report of [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) results for a past meeting.
|
|
1909
|
-
* **Prerequisites:**
|
|
1910
|
-
* * A Pro or a higher plan.
|
|
1911
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
1912
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_meeting_polls:admin`
|
|
1913
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
1914
|
-
* @link /report/meetings/{meetingId}/polls
|
|
1915
|
-
*/
|
|
1916
|
-
declare function reportMeetingPolls({ pathParams, config, }?: {
|
|
1917
|
-
pathParams: {
|
|
1918
|
-
meetingId: unknown;
|
|
1919
|
-
};
|
|
1920
|
-
config?: Partial<FetcherConfig> & {
|
|
1921
|
-
client?: typeof client;
|
|
1922
|
-
};
|
|
1923
|
-
}): Promise<unknown>;
|
|
1924
|
-
/**
|
|
1925
|
-
* @summary Get meeting Q&A report
|
|
1926
|
-
* @description Retrieve a report on questions asked and answered by participants from past meetings.
|
|
1927
|
-
* **Prerequisites:**
|
|
1928
|
-
* * Pro plan or higher.
|
|
1929
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
1930
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:meeting_qna:admin`
|
|
1931
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
1932
|
-
* @link /report/meetings/{meetingId}/qa
|
|
1933
|
-
*/
|
|
1934
|
-
declare function reportMeetingQA({ pathParams, config, }?: {
|
|
1935
|
-
pathParams: {
|
|
1936
|
-
meetingId: string;
|
|
1937
|
-
};
|
|
1938
|
-
config?: Partial<FetcherConfig> & {
|
|
1939
|
-
client?: typeof client;
|
|
1940
|
-
};
|
|
1941
|
-
}): Promise<unknown>;
|
|
1942
|
-
/**
|
|
1943
|
-
* @summary Get meeting survey report
|
|
1944
|
-
* @description Retrieve a report on past [meeting survey](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057559).
|
|
1945
|
-
* **Prerequisites:**
|
|
1946
|
-
* * Pro or a higher plan.
|
|
1947
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
1948
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:meeting_survey:admin`
|
|
1949
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
1950
|
-
* @link /report/meetings/{meetingId}/survey
|
|
1951
|
-
*/
|
|
1952
|
-
declare function reportMeetingSurvey({ pathParams, config, }?: {
|
|
1953
|
-
pathParams: {
|
|
1954
|
-
meetingId: string;
|
|
1955
|
-
};
|
|
1956
|
-
config?: Partial<FetcherConfig> & {
|
|
1957
|
-
client?: typeof client;
|
|
1958
|
-
};
|
|
1959
|
-
}): Promise<unknown>;
|
|
1960
|
-
/**
|
|
1961
|
-
* @summary Get operation logs report
|
|
1962
|
-
* @description The [Operations Logs](https://support.zoom.us/hc/en-us/articles/360032748331-Operation-Logs) report allows you to audit admin and user activity, such as adding a new user, changing account settings, and deleting recordings.
|
|
1963
|
-
* Use this API to retrieve operation logs report for a specified period of time.
|
|
1964
|
-
* **Prerequisites:**
|
|
1965
|
-
* * Pro or higher plan.
|
|
1966
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
1967
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:operation_logs:admin`
|
|
1968
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
1969
|
-
* @link /report/operationlogs
|
|
1970
|
-
*/
|
|
1971
|
-
declare function reportOperationLogs({ queryParams, config, }?: {
|
|
1972
|
-
queryParams?: {
|
|
1973
|
-
from?: string;
|
|
1974
|
-
to?: string;
|
|
1975
|
-
page_size?: number;
|
|
1976
|
-
next_page_token?: string;
|
|
1977
|
-
category_type?: "all" | "user" | "user_settings" | "account" | "billing" | "im" | "recording" | "phone_contacts" | "webinar" | "sub_account" | "role" | "zoom_rooms";
|
|
1978
|
-
};
|
|
1979
|
-
config?: Partial<FetcherConfig> & {
|
|
1980
|
-
client?: typeof client;
|
|
1981
|
-
};
|
|
1982
|
-
}): Promise<unknown>;
|
|
1983
|
-
/**
|
|
1984
|
-
* @summary Get remote support report
|
|
1985
|
-
* @description Retrieve a list of remote support records.
|
|
1986
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
1987
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:remote_support:admin`
|
|
1988
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
1989
|
-
* @link /report/remote_support
|
|
1990
|
-
*/
|
|
1991
|
-
declare function getremotesupportreport({ queryParams, config, }?: {
|
|
1992
|
-
queryParams?: {
|
|
1993
|
-
from?: string;
|
|
1994
|
-
to?: string;
|
|
1995
|
-
next_page_token?: string;
|
|
1996
|
-
page_size?: string;
|
|
1997
|
-
};
|
|
1998
|
-
config?: Partial<FetcherConfig> & {
|
|
1999
|
-
client?: typeof client;
|
|
2000
|
-
};
|
|
2001
|
-
}): Promise<unknown>;
|
|
2002
|
-
/**
|
|
2003
|
-
* @summary Get telephone reports
|
|
2004
|
-
* @description The [telephone report](https://support.zoom.us/hc/en-us/articles/206514816-Telephone-reports) allows you to view who dialed into meetings via phone (Audio Conferencing or SIP Connected Audio) and which number they dialed into and other details. Use this API to get telephone report for a specified period of time.
|
|
2005
|
-
* **Prerequisites:**
|
|
2006
|
-
* * Pro or higher plan.
|
|
2007
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
2008
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:telephone:admin`
|
|
2009
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
2010
|
-
* @link /report/telephone
|
|
2011
|
-
*/
|
|
2012
|
-
declare function reportTelephone({ queryParams, config, }?: {
|
|
2013
|
-
queryParams?: {
|
|
2014
|
-
type?: "1" | "2" | "3";
|
|
2015
|
-
query_date_type?: "start_time" | "end_time" | "meeting_start_time" | "meeting_end_time";
|
|
2016
|
-
from?: string;
|
|
2017
|
-
to?: string;
|
|
2018
|
-
page_size?: number;
|
|
2019
|
-
page_number?: number;
|
|
2020
|
-
next_page_token?: string;
|
|
2021
|
-
};
|
|
2022
|
-
config?: Partial<FetcherConfig> & {
|
|
2023
|
-
client?: typeof client;
|
|
2024
|
-
};
|
|
2025
|
-
}): Promise<unknown>;
|
|
2026
|
-
/**
|
|
2027
|
-
* @summary Get upcoming events report
|
|
2028
|
-
* @description Use this API to list upcoming meeting and/or webinar events within a specified period of time. The report's time range is limited to one month.
|
|
2029
|
-
* **Prerequisites:**
|
|
2030
|
-
* * A Pro or higher plan
|
|
2031
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
2032
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:upcoming_meetings_webinars:admin`
|
|
2033
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
2034
|
-
* @link /report/upcoming_events
|
|
2035
|
-
*/
|
|
2036
|
-
declare function reportUpcomingEvents({ queryParams, config, }?: {
|
|
2037
|
-
queryParams?: {
|
|
2038
|
-
from?: string;
|
|
2039
|
-
to?: string;
|
|
2040
|
-
page_size?: number;
|
|
2041
|
-
next_page_token?: string;
|
|
2042
|
-
type?: "meeting" | "webinar" | "all";
|
|
2043
|
-
group_id?: string;
|
|
2044
|
-
};
|
|
2045
|
-
config?: Partial<FetcherConfig> & {
|
|
2046
|
-
client?: typeof client;
|
|
2047
|
-
};
|
|
2048
|
-
}): Promise<unknown>;
|
|
2049
|
-
/**
|
|
2050
|
-
* @summary Get active or inactive host reports
|
|
2051
|
-
* @description Retrieve a host report for a specified period of time within the last six months.
|
|
2052
|
-
* The report time range is limited to a month.
|
|
2053
|
-
* You can specify the type of report and date range using the query parameters.
|
|
2054
|
-
* * The **Active Hosts** report displays a list of meetings, participants, and meeting minutes.
|
|
2055
|
-
* An **active host** is defined as any user who has hosted at least one meeting during the during the month specified in the `from` and `to` range.
|
|
2056
|
-
* * The **Inactive Hosts** report pulls a list of users who were not active during a specific period of time.
|
|
2057
|
-
* An **inactive host** is defined as any user who has not hosted any meetings during the specified period of time for the report. to be inactive.
|
|
2058
|
-
* **Prerequisites:**
|
|
2059
|
-
* * Pro or higher plan.
|
|
2060
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
2061
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_users:admin`
|
|
2062
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
2063
|
-
* @link /report/users
|
|
2064
|
-
*/
|
|
2065
|
-
declare function reportUsers({ queryParams, config, }?: {
|
|
2066
|
-
queryParams?: {
|
|
2067
|
-
type?: "active" | "inactive";
|
|
2068
|
-
from?: string;
|
|
2069
|
-
to?: string;
|
|
2070
|
-
page_size?: number;
|
|
2071
|
-
page_number?: number;
|
|
2072
|
-
next_page_token?: string;
|
|
2073
|
-
group_id?: string;
|
|
2074
|
-
};
|
|
2075
|
-
config?: Partial<FetcherConfig> & {
|
|
2076
|
-
client?: typeof client;
|
|
2077
|
-
};
|
|
2078
|
-
}): Promise<unknown>;
|
|
2079
|
-
/**
|
|
2080
|
-
* @summary Get meeting reports
|
|
2081
|
-
* @description Retrieve [report](https://support.zoom.us/hc/en-us/articles/216378603-Meeting-Reporting) on past meetings and webinars for a specified time period. The time range for the report is limited to a month and the month must fall within the past six months.
|
|
2082
|
-
* Meetings and webinars are returned only if they have two or more unique participants.
|
|
2083
|
-
* **Prerequisites:**
|
|
2084
|
-
* * Pro or higher plan.
|
|
2085
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
2086
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:user:admin`
|
|
2087
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
2088
|
-
* @link /report/users/{userId}/meetings
|
|
2089
|
-
*/
|
|
2090
|
-
declare function reportMeetings({ pathParams, queryParams, config, }?: {
|
|
2091
|
-
pathParams: {
|
|
2092
|
-
userId: string;
|
|
2093
|
-
};
|
|
2094
|
-
queryParams?: {
|
|
2095
|
-
from?: string;
|
|
2096
|
-
to?: string;
|
|
2097
|
-
page_size?: number;
|
|
2098
|
-
next_page_token?: string;
|
|
2099
|
-
type?: "past" | "pastOne" | "pastJoined";
|
|
2100
|
-
};
|
|
2101
|
-
config?: Partial<FetcherConfig> & {
|
|
2102
|
-
client?: typeof client;
|
|
2103
|
-
};
|
|
2104
|
-
}): Promise<unknown>;
|
|
2105
|
-
/**
|
|
2106
|
-
* @summary Get webinar detail reports
|
|
2107
|
-
* @description Retrieve a [report](https://support.zoom.us/hc/en-us/articles/201393719-Webinar-Reporting) containing past webinar details.
|
|
2108
|
-
* **Prerequisites:**
|
|
2109
|
-
* * Pro or higher plan with Webinar add-on.
|
|
2110
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
2111
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:webinar:admin`
|
|
2112
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
2113
|
-
* @link /report/webinars/{webinarId}
|
|
2114
|
-
*/
|
|
2115
|
-
declare function reportWebinarDetails({ pathParams, config, }?: {
|
|
2116
|
-
pathParams: {
|
|
2117
|
-
webinarId: string;
|
|
2118
|
-
};
|
|
2119
|
-
config?: Partial<FetcherConfig> & {
|
|
2120
|
-
client?: typeof client;
|
|
2121
|
-
};
|
|
2122
|
-
}): Promise<unknown>;
|
|
2123
|
-
/**
|
|
2124
|
-
* @summary Get webinar participant reports
|
|
2125
|
-
* @description Get a detailed report on each webinar attendee. You can get webinar participant reports for the last 6 months.
|
|
2126
|
-
* **Prerequisites:**
|
|
2127
|
-
* * A Pro or a higher plan with Webinar add-on enabled.
|
|
2128
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
2129
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_webinar_participants:admin`
|
|
2130
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
2131
|
-
* @link /report/webinars/{webinarId}/participants
|
|
2132
|
-
*/
|
|
2133
|
-
declare function reportWebinarParticipants({ pathParams, queryParams, config, }?: {
|
|
2134
|
-
pathParams: {
|
|
2135
|
-
webinarId: string;
|
|
2136
|
-
};
|
|
2137
|
-
queryParams?: {
|
|
2138
|
-
page_size?: number;
|
|
2139
|
-
next_page_token?: string;
|
|
2140
|
-
include_fields?: "registrant_id";
|
|
2141
|
-
};
|
|
2142
|
-
config?: Partial<FetcherConfig> & {
|
|
2143
|
-
client?: typeof client;
|
|
2144
|
-
};
|
|
2145
|
-
}): Promise<unknown>;
|
|
2146
|
-
/**
|
|
2147
|
-
* @summary Get webinar poll reports
|
|
2148
|
-
* @description Retrieve a report on past [webinar polls](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).
|
|
2149
|
-
* **Prerequisites:**
|
|
2150
|
-
* * Pro or a higher plan with Webinar add-on enabled.
|
|
2151
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
2152
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:list_webinar_polls:admin`
|
|
2153
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
|
|
2154
|
-
* @link /report/webinars/{webinarId}/polls
|
|
2155
|
-
*/
|
|
2156
|
-
declare function reportWebinarPolls({ pathParams, config, }?: {
|
|
2157
|
-
pathParams: {
|
|
2158
|
-
webinarId: string;
|
|
2159
|
-
};
|
|
2160
|
-
config?: Partial<FetcherConfig> & {
|
|
2161
|
-
client?: typeof client;
|
|
2162
|
-
};
|
|
2163
|
-
}): Promise<unknown>;
|
|
2164
|
-
/**
|
|
2165
|
-
* @summary Get webinar Q&A report
|
|
2166
|
-
* @description Retrieve a report on questions asked by participants and answered by panelists, co-hosts and hosts from past webinars.
|
|
2167
|
-
* **Prerequisites:**
|
|
2168
|
-
* * Pro or a higher plan with the Webinar add-on enabled.
|
|
2169
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
2170
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:webinar_qna:admin`
|
|
2171
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
2172
|
-
* @link /report/webinars/{webinarId}/qa
|
|
2173
|
-
*/
|
|
2174
|
-
declare function reportWebinarQA({ pathParams, config, }?: {
|
|
2175
|
-
pathParams: {
|
|
2176
|
-
webinarId: string;
|
|
2177
|
-
};
|
|
2178
|
-
config?: Partial<FetcherConfig> & {
|
|
2179
|
-
client?: typeof client;
|
|
2180
|
-
};
|
|
2181
|
-
}): Promise<unknown>;
|
|
2182
|
-
/**
|
|
2183
|
-
* @summary Get webinar survey report
|
|
2184
|
-
* @description Retrieve a report on past [webinar survey](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057559).
|
|
2185
|
-
* **Prerequisites:**
|
|
2186
|
-
* * Pro or a higher plan with Webinar add-on enabled.
|
|
2187
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:admin`
|
|
2188
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `report:read:webinar_survey:admin`
|
|
2189
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
2190
|
-
* @link /report/webinars/{webinarId}/survey
|
|
2191
|
-
*/
|
|
2192
|
-
declare function reportWebinarSurvey({ pathParams, config, }?: {
|
|
2193
|
-
pathParams: {
|
|
2194
|
-
webinarId: string;
|
|
2195
|
-
};
|
|
2196
|
-
config?: Partial<FetcherConfig> & {
|
|
2197
|
-
client?: typeof client;
|
|
2198
|
-
};
|
|
2199
|
-
}): Promise<unknown>;
|
|
2200
|
-
/**
|
|
2201
|
-
* @summary List SIP phones
|
|
2202
|
-
* @description List SIP phones on an account.
|
|
2203
|
-
* 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.
|
|
2204
|
-
* **Prerequisites**:
|
|
2205
|
-
* * Currently only supported on Cisco and Avaya PBX systems.
|
|
2206
|
-
* * User must enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.
|
|
2207
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:read:admin`
|
|
2208
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:read:list_sip_phones:admin`
|
|
2209
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
2210
|
-
* @link /sip_phones/phones
|
|
2211
|
-
*/
|
|
2212
|
-
declare function listSIPPhonePhones({ queryParams, config, }?: {
|
|
2213
|
-
queryParams?: {
|
|
2214
|
-
search_key?: string;
|
|
2215
|
-
page_size?: number;
|
|
2216
|
-
next_page_token?: string;
|
|
2217
|
-
};
|
|
2218
|
-
config?: Partial<FetcherConfig> & {
|
|
2219
|
-
client?: typeof client;
|
|
2220
|
-
};
|
|
2221
|
-
}): Promise<unknown>;
|
|
2222
|
-
/**
|
|
2223
|
-
* @summary Enable SIP phone
|
|
2224
|
-
* @description Enable a user to use a SIP phone.
|
|
2225
|
-
* 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.
|
|
2226
|
-
* **Prerequisites**:
|
|
2227
|
-
* * Currently only supported on Cisco and Avaya PBX systems.
|
|
2228
|
-
* * The account owner or account admin must first enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.
|
|
2229
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin`
|
|
2230
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:sip_phone:admin`
|
|
2231
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2232
|
-
* @link /sip_phones/phones
|
|
2233
|
-
*/
|
|
2234
|
-
declare function enableSIPPhonePhones({ body, config, }?: {
|
|
2235
|
-
body?: EnableSIPPhonePhonesBody;
|
|
2236
|
-
config?: Partial<FetcherConfig> & {
|
|
2237
|
-
client?: typeof client;
|
|
2238
|
-
};
|
|
2239
|
-
}): Promise<unknown>;
|
|
2240
|
-
/**
|
|
2241
|
-
* @summary Delete SIP phone
|
|
2242
|
-
* @description Delete a Zoom account's SIP phone.
|
|
2243
|
-
* **Prerequisites**:
|
|
2244
|
-
* * Currently only supported on Cisco and Avaya PBX systems.
|
|
2245
|
-
* * The user must enable **SIP Phone Integration** by contacting the [Zoom Sales](https://zoom.us/contactsales) team.
|
|
2246
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin`
|
|
2247
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:delete:sip_phone:admin`
|
|
2248
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2249
|
-
* @link /sip_phones/phones/{phoneId}
|
|
2250
|
-
*/
|
|
2251
|
-
declare function deleteSIPPhonePhones({ pathParams, config, }?: {
|
|
2252
|
-
pathParams: {
|
|
2253
|
-
phoneId: string;
|
|
2254
|
-
};
|
|
2255
|
-
config?: Partial<FetcherConfig> & {
|
|
2256
|
-
client?: typeof client;
|
|
2257
|
-
};
|
|
2258
|
-
}): Promise<unknown>;
|
|
2259
|
-
/**
|
|
2260
|
-
* @summary Update SIP phone
|
|
2261
|
-
* @description Update the information of a specific SIP phone on a Zoom account.
|
|
2262
|
-
* Zoom's Phone System Integration (PSI), also referred as SIP phones, lets an organization leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users can have softphone functionality within a single client while maintaining a comparable interface to a Zoom Phone.
|
|
2263
|
-
* **Prerequisites**:
|
|
2264
|
-
* * Currently only supported on Cisco and Avaya PBX systems.
|
|
2265
|
-
* * The account owner or account admin must first enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.
|
|
2266
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:write:admin`
|
|
2267
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `sip_phone:update:sip_phone:admin`
|
|
2268
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2269
|
-
* @link /sip_phones/phones/{phoneId}
|
|
2270
|
-
*/
|
|
2271
|
-
declare function updateSIPPhonePhones({ pathParams, body, config, }?: {
|
|
2272
|
-
pathParams: {
|
|
2273
|
-
phoneId: string;
|
|
2274
|
-
};
|
|
2275
|
-
body?: UpdateSIPPhonePhonesBody;
|
|
2276
|
-
config?: Partial<FetcherConfig> & {
|
|
2277
|
-
client?: typeof client;
|
|
2278
|
-
};
|
|
2279
|
-
}): Promise<unknown>;
|
|
2280
|
-
/**
|
|
2281
|
-
* @summary List an account's meeting or webinar summaries
|
|
2282
|
-
* @description Retrieve a list of all meeting or webinar summaries available for an account.
|
|
2283
|
-
* **Prerequisites**
|
|
2284
|
-
* * The host must have a Pro, Business, or higher subscription plan.
|
|
2285
|
-
* * For meetings - the host's **Meeting Summary with AI Companion** user setting must be enabled.
|
|
2286
|
-
* * For webinars - the host's **Webinar Summary with AI Companion** user setting must be enabled.
|
|
2287
|
-
* * End-to-End Encrypted (E2EE) meetings do not support summaries.
|
|
2288
|
-
* Learn more about [enabling or disabling AI Companion meeting summaries](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057960).
|
|
2289
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_summary:read:admin`
|
|
2290
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_summaries:admin`
|
|
2291
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
2292
|
-
* @link /meetings/meeting_summaries
|
|
2293
|
-
*/
|
|
2294
|
-
declare function listmeetingsummaries({ queryParams, config, }?: {
|
|
2295
|
-
queryParams?: {
|
|
2296
|
-
page_size?: number;
|
|
2297
|
-
next_page_token?: string;
|
|
2298
|
-
from?: string;
|
|
2299
|
-
to?: string;
|
|
2300
|
-
time_filter_field?: "summary_start_time" | "summary_created_time";
|
|
2301
|
-
};
|
|
2302
|
-
config?: Partial<FetcherConfig> & {
|
|
2303
|
-
client?: typeof client;
|
|
2304
|
-
};
|
|
2305
|
-
}): Promise<unknown>;
|
|
2306
|
-
/**
|
|
2307
|
-
* @summary Get a meeting or webinar summary
|
|
2308
|
-
* @description Retrieve the summary of a meeting or webinar.
|
|
2309
|
-
* **Prerequisites**
|
|
2310
|
-
* - The host must have a Pro, Business, or higher subscription plan.
|
|
2311
|
-
* - For meetings - the host's **Meeting Summary with AI Companion** user setting must be enabled.
|
|
2312
|
-
* - For webinars - the host's **Webinar Summary with AI Companion** user setting must be enabled.
|
|
2313
|
-
* - End-to-End Encrypted (E2EE) meetings do not support summaries.
|
|
2314
|
-
* Learn more about [enabling or disabling AI Companion meeting summaries](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0057960).
|
|
2315
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_summary:read`,`meeting_summary:read:admin`
|
|
2316
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:summary`,`meeting:read:summary:admin`
|
|
2317
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2318
|
-
* @link /meetings/{meetingId}/meeting_summary
|
|
2319
|
-
*/
|
|
2320
|
-
declare function getameetingsummary({ pathParams, config, }?: {
|
|
2321
|
-
pathParams: {
|
|
2322
|
-
meetingId: string;
|
|
2323
|
-
};
|
|
2324
|
-
config?: Partial<FetcherConfig> & {
|
|
2325
|
-
client?: typeof client;
|
|
2326
|
-
};
|
|
2327
|
-
}): Promise<unknown>;
|
|
2328
|
-
/**
|
|
2329
|
-
* @summary Delete a meeting or webinar summary
|
|
2330
|
-
* @description Delete the summary of a meeting or webinar.
|
|
2331
|
-
* **Prerequisites**
|
|
2332
|
-
* * The host must have a Pro, Business, or higher subscription plan.
|
|
2333
|
-
* * For meetings - the host's **Meeting Summary with AI Companion** user setting must be enabled.
|
|
2334
|
-
* * For webinars - the host's **Webinar Summary with AI Companion** user setting must be enabled.
|
|
2335
|
-
* * End-to-End Encrypted (E2EE) meetings do not support summaries.
|
|
2336
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_summary:write`,`meeting_summary:write:admin`
|
|
2337
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:summary`,`meeting:delete:summary:admin`
|
|
2338
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2339
|
-
* @link /meetings/{meetingId}/meeting_summary
|
|
2340
|
-
*/
|
|
2341
|
-
declare function deletemeetingorwebinarsummary({ pathParams, config, }?: {
|
|
2342
|
-
pathParams: {
|
|
2343
|
-
meetingId: string;
|
|
2344
|
-
};
|
|
2345
|
-
config?: Partial<FetcherConfig> & {
|
|
2346
|
-
client?: typeof client;
|
|
2347
|
-
};
|
|
2348
|
-
}): Promise<unknown>;
|
|
2349
|
-
/**
|
|
2350
|
-
* @summary List a user's meeting or webinar summaries
|
|
2351
|
-
* @description Retrieve a list of meeting or webinar summaries hosted by the specified user.
|
|
2352
|
-
* **Prerequisites**
|
|
2353
|
-
* * The host must have a Pro, Business, or higher subscription plan.
|
|
2354
|
-
* * For meetings - the host's **Meeting Summary with AI Companion** user setting must be enabled.
|
|
2355
|
-
* * For webinars - the host's **Webinar Summary with AI Companion** user setting must be enabled.
|
|
2356
|
-
* * End-to-End Encrypted (E2EE) meetings do not support summaries.
|
|
2357
|
-
* The specified user must belong to the current account.
|
|
2358
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting_summary:read`,`meeting_summary:read:admin`
|
|
2359
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_summaries`,`meeting:read:list_summaries:admin`
|
|
2360
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
2361
|
-
* @link /users/{userId}/meeting_summaries
|
|
2362
|
-
*/
|
|
2363
|
-
declare function listUserMeetingSummaries({ pathParams, queryParams, config, }?: {
|
|
2364
|
-
pathParams: {
|
|
2365
|
-
userId: string;
|
|
2366
|
-
};
|
|
2367
|
-
queryParams?: {
|
|
2368
|
-
page_size?: number;
|
|
2369
|
-
next_page_token?: string;
|
|
2370
|
-
from?: string;
|
|
2371
|
-
to?: string;
|
|
2372
|
-
time_filter_field?: "summary_start_time" | "summary_created_time";
|
|
2373
|
-
};
|
|
2374
|
-
config?: Partial<FetcherConfig> & {
|
|
2375
|
-
client?: typeof client;
|
|
2376
|
-
};
|
|
2377
|
-
}): Promise<unknown>;
|
|
2378
|
-
/**
|
|
2379
|
-
* @summary Get a meeting survey
|
|
2380
|
-
* @description 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.
|
|
2381
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
2382
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:survey`,`meeting:read:survey:admin`
|
|
2383
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2384
|
-
* @link /meetings/{meetingId}/survey
|
|
2385
|
-
*/
|
|
2386
|
-
declare function meetingSurveyGet({ pathParams, config, }?: {
|
|
2387
|
-
pathParams: {
|
|
2388
|
-
meetingId: bigint;
|
|
2389
|
-
};
|
|
2390
|
-
config?: Partial<FetcherConfig> & {
|
|
2391
|
-
client?: typeof client;
|
|
2392
|
-
};
|
|
2393
|
-
}): Promise<unknown>;
|
|
2394
|
-
/**
|
|
2395
|
-
* @summary Delete a meeting survey
|
|
2396
|
-
* @description Delete a [meeting survey](https://support.zoom.us/hc/en-us/articles/4404969060621-Post-meeting-survey-and-reporting).
|
|
2397
|
-
* **Prerequisites:**
|
|
2398
|
-
* * The host must be a **Pro** user type.
|
|
2399
|
-
* * The [**Meeting Survey**](https://support.zoom.us/hc/en-us/articles/4404939095053-Enabling-meeting-surveys) feature enabled in the host's account.
|
|
2400
|
-
* * The meeting must be a scheduled meeting. Instant meetings do not have survey features enabled.
|
|
2401
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
2402
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:delete:survey`,`meeting:delete:survey:admin`
|
|
2403
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2404
|
-
* @link /meetings/{meetingId}/survey
|
|
2405
|
-
*/
|
|
2406
|
-
declare function meetingSurveyDelete({ pathParams, config, }?: {
|
|
2407
|
-
pathParams: {
|
|
2408
|
-
meetingId: bigint;
|
|
2409
|
-
};
|
|
2410
|
-
config?: Partial<FetcherConfig> & {
|
|
2411
|
-
client?: typeof client;
|
|
2412
|
-
};
|
|
2413
|
-
}): Promise<unknown>;
|
|
2414
|
-
/**
|
|
2415
|
-
* @summary Update a meeting survey
|
|
2416
|
-
* @description 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.
|
|
2417
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write`,`meeting:write:admin`
|
|
2418
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:update:survey`,`meeting:update:survey:admin`
|
|
2419
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2420
|
-
* @link /meetings/{meetingId}/survey
|
|
2421
|
-
*/
|
|
2422
|
-
declare function meetingSurveyUpdate({ pathParams, body, config, }?: {
|
|
2423
|
-
pathParams: {
|
|
2424
|
-
meetingId: bigint;
|
|
2425
|
-
};
|
|
2426
|
-
body?: MeetingSurveyUpdateBody;
|
|
2427
|
-
config?: Partial<FetcherConfig> & {
|
|
2428
|
-
client?: typeof client;
|
|
2429
|
-
};
|
|
2430
|
-
}): Promise<unknown>;
|
|
2431
|
-
/**
|
|
2432
|
-
* @summary Get account's TSP information
|
|
2433
|
-
* @description Get information on Telephony Service Provider (TSP) on an account level.
|
|
2434
|
-
* **Prerequisites**
|
|
2435
|
-
* * TSP audio must be enabled on the Zoom account before using this API.
|
|
2436
|
-
* * The Zoom account must have a Pro or higher subscription plan to enable TSP.
|
|
2437
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:admin`
|
|
2438
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:tsp:admin`
|
|
2439
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2440
|
-
* @link /tsp
|
|
2441
|
-
*/
|
|
2442
|
-
declare function tsp({ config }?: {
|
|
2443
|
-
config?: Partial<FetcherConfig> & {
|
|
2444
|
-
client?: typeof client;
|
|
2445
|
-
};
|
|
2446
|
-
}): Promise<unknown>;
|
|
2447
|
-
/**
|
|
2448
|
-
* @summary Update an account's TSP information
|
|
2449
|
-
* @description Update information of the Telephony Service Provider (TSP) set up on an account.
|
|
2450
|
-
* **Prerequisites**
|
|
2451
|
-
* * Enable TSP on the Zoom account before using this API.
|
|
2452
|
-
* * A Pro or higher subscription plan to enable TSP.
|
|
2453
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`
|
|
2454
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:update:tsp:admin`
|
|
2455
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2456
|
-
* @link /tsp
|
|
2457
|
-
*/
|
|
2458
|
-
declare function tspUpdate({ body, config, }?: {
|
|
2459
|
-
body?: TspUpdateBody;
|
|
2460
|
-
config?: Partial<FetcherConfig> & {
|
|
2461
|
-
client?: typeof client;
|
|
2462
|
-
};
|
|
2463
|
-
}): Promise<unknown>;
|
|
2464
|
-
/**
|
|
2465
|
-
* @summary List user's TSP accounts
|
|
2466
|
-
* @description List all of a user's TSP accounts. A user can have a maximum of two TSP accounts.
|
|
2467
|
-
* **Prerequisites**
|
|
2468
|
-
* * TSP (Telephony Service Provider) audio must be enabled on the Zoom account before using this API.
|
|
2469
|
-
* * The Zoom account must have a Pro or higher subscription plan to enable TSP.
|
|
2470
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:admin`,`tsp:read`
|
|
2471
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:list_tsp_accounts`,`tsp:read:list_tsp_accounts:admin`
|
|
2472
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
2473
|
-
* @link /users/{userId}/tsp
|
|
2474
|
-
*/
|
|
2475
|
-
declare function userTSPs({ pathParams, config, }?: {
|
|
2476
|
-
pathParams: {
|
|
2477
|
-
userId: string;
|
|
2478
|
-
};
|
|
2479
|
-
config?: Partial<FetcherConfig> & {
|
|
2480
|
-
client?: typeof client;
|
|
2481
|
-
};
|
|
2482
|
-
}): Promise<unknown>;
|
|
2483
|
-
/**
|
|
2484
|
-
* @summary Add a user's TSP account
|
|
2485
|
-
* @description Add a user's TSP account.
|
|
2486
|
-
* **Prerequisites**
|
|
2487
|
-
* * TSP (Telephony Service Provider) audio must be enabled on the Zoom account before using this API.
|
|
2488
|
-
* * The Zoom account must have a Pro or higher subscription plan to enable TSP.
|
|
2489
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`,`tsp:write`
|
|
2490
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:tsp_account`,`tsp:write:tsp_account:admin`
|
|
2491
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2492
|
-
* @link /users/{userId}/tsp
|
|
2493
|
-
*/
|
|
2494
|
-
declare function userTSPCreate({ pathParams, body, config, }?: {
|
|
2495
|
-
pathParams: {
|
|
2496
|
-
userId: string;
|
|
2497
|
-
};
|
|
2498
|
-
body?: UserTSPCreateBody;
|
|
2499
|
-
config?: Partial<FetcherConfig> & {
|
|
2500
|
-
client?: typeof client;
|
|
2501
|
-
};
|
|
2502
|
-
}): Promise<unknown>;
|
|
2503
|
-
/**
|
|
2504
|
-
* @summary Set global dial-in URL for a TSP user
|
|
2505
|
-
* @description 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. A global dial-in page can provide a list of global access numbers to use to conduct audio conferencing.
|
|
2506
|
-
* **Prerequisites**
|
|
2507
|
-
* * TSP (Telephony Service Provider) audio must be enabled on the Zoom account before using this API.
|
|
2508
|
-
* * The Zoom account must have a Pro or higher subscription plan to enable TSP.
|
|
2509
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`,`tsp:write`
|
|
2510
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:update:tsp_settings`,`tsp:update:tsp_settings:admin`
|
|
2511
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2512
|
-
* @link /users/{userId}/tsp/settings
|
|
2513
|
-
*/
|
|
2514
|
-
declare function tspUrlUpdate({ pathParams, body, config, }?: {
|
|
2515
|
-
pathParams: {
|
|
2516
|
-
userId: string;
|
|
2517
|
-
};
|
|
2518
|
-
body?: TspUrlUpdateBody;
|
|
2519
|
-
config?: Partial<FetcherConfig> & {
|
|
2520
|
-
client?: typeof client;
|
|
2521
|
-
};
|
|
2522
|
-
}): Promise<unknown>;
|
|
2523
|
-
/**
|
|
2524
|
-
* @summary Get a user's TSP account
|
|
2525
|
-
* @description Retrieve details of a specific TSP account enabled for a specific user. Each user can have a maximum of two TSP accounts.
|
|
2526
|
-
* **Prerequisites**
|
|
2527
|
-
* * TSP (Telephony Service Provider) audio must be enabled on the Zoom account before using this API.
|
|
2528
|
-
* * The Zoom account must have a Pro or higher subscription plan to enable TSP.
|
|
2529
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:admin`,`tsp:read`
|
|
2530
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:read:tsp_account`,`tsp:read:tsp_account:admin`
|
|
2531
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2532
|
-
* @link /users/{userId}/tsp/{tspId}
|
|
2533
|
-
*/
|
|
2534
|
-
declare function userTSP({ pathParams, config, }?: {
|
|
2535
|
-
pathParams: {
|
|
2536
|
-
userId: string;
|
|
2537
|
-
tspId: "1" | "2";
|
|
2538
|
-
};
|
|
2539
|
-
config?: Partial<FetcherConfig> & {
|
|
2540
|
-
client?: typeof client;
|
|
2541
|
-
};
|
|
2542
|
-
}): Promise<unknown>;
|
|
2543
|
-
/**
|
|
2544
|
-
* @summary Delete a user's TSP account
|
|
2545
|
-
* @description Delete a user's TSP account.
|
|
2546
|
-
* **Prerequisites**
|
|
2547
|
-
* * TSP (Telephony Service Provider) audio must be enabled on the Zoom account before using this API.
|
|
2548
|
-
* * The Zoom account must have a Pro or higher subscription plan to enable TSP.
|
|
2549
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`,`tsp:write`
|
|
2550
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:delete:tsp_account`,`tsp:delete:tsp_account:admin`
|
|
2551
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2552
|
-
* @link /users/{userId}/tsp/{tspId}
|
|
2553
|
-
*/
|
|
2554
|
-
declare function userTSPDelete({ pathParams, config, }?: {
|
|
2555
|
-
pathParams: {
|
|
2556
|
-
userId: string;
|
|
2557
|
-
tspId: "1" | "2";
|
|
2558
|
-
};
|
|
2559
|
-
config?: Partial<FetcherConfig> & {
|
|
2560
|
-
client?: typeof client;
|
|
2561
|
-
};
|
|
2562
|
-
}): Promise<unknown>;
|
|
2563
|
-
/**
|
|
2564
|
-
* @summary Update a TSP account
|
|
2565
|
-
* @description Update a user's Telephony Service Provider (TSP) account.
|
|
2566
|
-
* **Prerequisites**
|
|
2567
|
-
* * TSP audio enabled on the Zoom account before using this API.
|
|
2568
|
-
* * A Pro or higher subscription plan to enable TSP.
|
|
2569
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:write:admin`,`tsp:write`
|
|
2570
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tsp:update:tsp_account`,`tsp:update:tsp_account:admin`
|
|
2571
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2572
|
-
* @link /users/{userId}/tsp/{tspId}
|
|
2573
|
-
*/
|
|
2574
|
-
declare function userTSPUpdate({ pathParams, body, config, }?: {
|
|
2575
|
-
pathParams: {
|
|
2576
|
-
userId: string;
|
|
2577
|
-
tspId: "1" | "2";
|
|
2578
|
-
};
|
|
2579
|
-
body?: UserTSPUpdateBody;
|
|
2580
|
-
config?: Partial<FetcherConfig> & {
|
|
2581
|
-
client?: typeof client;
|
|
2582
|
-
};
|
|
2583
|
-
}): Promise<unknown>;
|
|
2584
|
-
/**
|
|
2585
|
-
* @summary List meeting templates
|
|
2586
|
-
* @description List available [meeting templates](https://support.zoom.us/hc/en-us/articles/360036559151-Meeting-templates) for a user. For user-level apps, pass [the `me` value](/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.
|
|
2587
|
-
* **Prerequisites**:
|
|
2588
|
-
* * Host user must have a Zoom Meetings Basic license or higher.
|
|
2589
|
-
* [Learn more about creating and managing meeting templates](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067229).
|
|
2590
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read`,`meeting:read:admin`
|
|
2591
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:read:list_templates`,`meeting:read:list_templates:admin`
|
|
2592
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
2593
|
-
* @link /users/{userId}/meeting_templates
|
|
2594
|
-
*/
|
|
2595
|
-
declare function listMeetingTemplates({ pathParams, config, }?: {
|
|
2596
|
-
pathParams: {
|
|
2597
|
-
userId: string;
|
|
2598
|
-
};
|
|
2599
|
-
config?: Partial<FetcherConfig> & {
|
|
2600
|
-
client?: typeof client;
|
|
2601
|
-
};
|
|
2602
|
-
}): Promise<unknown>;
|
|
2603
|
-
/**
|
|
2604
|
-
* @summary Create a meeting template from an existing meeting
|
|
2605
|
-
* @description Create a meeting template from an existing meeting.
|
|
2606
|
-
* **Prerequisites**
|
|
2607
|
-
* * Host user must have a Zoom Meetings Basic license or higher.
|
|
2608
|
-
* * You can only create up to 40 meeting templates.
|
|
2609
|
-
* [Learn more about creating and managing meeting templates](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0067229).
|
|
2610
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:admin`,`meeting:write`
|
|
2611
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `meeting:write:template`,`meeting:write:template:admin`
|
|
2612
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
2613
|
-
* @link /users/{userId}/meeting_templates
|
|
2614
|
-
*/
|
|
2615
|
-
declare function meetingTemplateCreate({ pathParams, body, config, }?: {
|
|
2616
|
-
pathParams: {
|
|
2617
|
-
userId: string;
|
|
2618
|
-
};
|
|
2619
|
-
body?: MeetingTemplateCreateBody;
|
|
2620
|
-
config?: Partial<FetcherConfig> & {
|
|
2621
|
-
client?: typeof client;
|
|
2622
|
-
};
|
|
2623
|
-
}): Promise<unknown>;
|
|
2624
|
-
/**
|
|
2625
|
-
* @summary List tracking fields
|
|
2626
|
-
* @description List all the [tracking fields](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields) on your Zoom account. Tracking fields let you analyze usage by various fields within an organization.
|
|
2627
|
-
* **Prerequisites:**
|
|
2628
|
-
* * A Business, Education, API or higher plan.
|
|
2629
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:read:admin`
|
|
2630
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_field:read:list_tracking_fields:admin`
|
|
2631
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
2632
|
-
* @link /tracking_fields
|
|
2633
|
-
*/
|
|
2634
|
-
declare function trackingfieldList({ config }?: {
|
|
2635
|
-
config?: Partial<FetcherConfig> & {
|
|
2636
|
-
client?: typeof client;
|
|
2637
|
-
};
|
|
2638
|
-
}): Promise<unknown>;
|
|
2639
|
-
/**
|
|
2640
|
-
* @summary Create a tracking field
|
|
2641
|
-
* @description Use this API to create a new [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields). Tracking fields let you analyze usage by various fields within an organization. When scheduling a meeting, tracking fields will be included in the meeting options.
|
|
2642
|
-
* **Prerequisites:**
|
|
2643
|
-
* * A Business, Education, API or higher plan.
|
|
2644
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:write:admin`
|
|
2645
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_field:write:tracking_field:admin`
|
|
2646
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2647
|
-
* @link /tracking_fields
|
|
2648
|
-
*/
|
|
2649
|
-
declare function trackingfieldCreate({ body, config, }?: {
|
|
2650
|
-
body?: TrackingfieldCreateBody;
|
|
2651
|
-
config?: Partial<FetcherConfig> & {
|
|
2652
|
-
client?: typeof client;
|
|
2653
|
-
};
|
|
2654
|
-
}): Promise<unknown>;
|
|
2655
|
-
/**
|
|
2656
|
-
* @summary Get a tracking field
|
|
2657
|
-
* @description Use this API to return information about a [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields).
|
|
2658
|
-
* **Prerequisites:**
|
|
2659
|
-
* * A Business, Education, API or higher plan.
|
|
2660
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:read:admin`
|
|
2661
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_field:read:tracking_field:admin`
|
|
2662
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2663
|
-
* @link /tracking_fields/{fieldId}
|
|
2664
|
-
*/
|
|
2665
|
-
declare function trackingfieldGet({ pathParams, config, }?: {
|
|
2666
|
-
pathParams: {
|
|
2667
|
-
fieldId: string;
|
|
2668
|
-
};
|
|
2669
|
-
config?: Partial<FetcherConfig> & {
|
|
2670
|
-
client?: typeof client;
|
|
2671
|
-
};
|
|
2672
|
-
}): Promise<unknown>;
|
|
2673
|
-
/**
|
|
2674
|
-
* @summary Delete a tracking field
|
|
2675
|
-
* @description Delete a [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields).
|
|
2676
|
-
* **Prerequisites:**
|
|
2677
|
-
* * A Business, Education, API or higher plan.
|
|
2678
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:write:admin`
|
|
2679
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_field:delete:tracking_field:admin`
|
|
2680
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2681
|
-
* @link /tracking_fields/{fieldId}
|
|
2682
|
-
*/
|
|
2683
|
-
declare function trackingfieldDelete({ pathParams, config, }?: {
|
|
2684
|
-
pathParams: {
|
|
2685
|
-
fieldId: string;
|
|
2686
|
-
};
|
|
2687
|
-
config?: Partial<FetcherConfig> & {
|
|
2688
|
-
client?: typeof client;
|
|
2689
|
-
};
|
|
2690
|
-
}): Promise<unknown>;
|
|
2691
|
-
/**
|
|
2692
|
-
* @summary Update a tracking field
|
|
2693
|
-
* @description Update a [tracking field](https://support.zoom.us/hc/en-us/articles/115000293426-Scheduling-Tracking-Fields).
|
|
2694
|
-
* **Prerequisites:**
|
|
2695
|
-
* * A Business, Education, API or higher plan.
|
|
2696
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_fields:write:admin`
|
|
2697
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `tracking_field:update:tracking_field:admin`
|
|
2698
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2699
|
-
* @link /tracking_fields/{fieldId}
|
|
2700
|
-
*/
|
|
2701
|
-
declare function trackingfieldUpdate({ pathParams, body, config, }?: {
|
|
2702
|
-
pathParams: {
|
|
2703
|
-
fieldId: string;
|
|
2704
|
-
};
|
|
2705
|
-
body?: TrackingfieldUpdateBody;
|
|
2706
|
-
config?: Partial<FetcherConfig> & {
|
|
2707
|
-
client?: typeof client;
|
|
2708
|
-
};
|
|
2709
|
-
}): Promise<unknown>;
|
|
2710
|
-
/**
|
|
2711
|
-
* @summary Delete a live webinar message
|
|
2712
|
-
* @description Deletes a message in a live webinar based on ID.
|
|
2713
|
-
* **Prerequisites:**
|
|
2714
|
-
* * Have Zoom enable the DLP for the in-meeting chat feature to use this API.
|
|
2715
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
2716
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:live_webinar_chat_message`,`webinar:delete:live_webinar_chat_message:admin`
|
|
2717
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
2718
|
-
* @link /live_webinars/{webinarId}/chat/messages/{messageId}
|
|
2719
|
-
*/
|
|
2720
|
-
declare function deleteWebinarChatMessageById({ pathParams, queryParams, config, }?: {
|
|
2721
|
-
pathParams: {
|
|
2722
|
-
webinarId: bigint;
|
|
2723
|
-
messageId: string;
|
|
2724
|
-
};
|
|
2725
|
-
queryParams?: {
|
|
2726
|
-
file_ids?: string;
|
|
2727
|
-
};
|
|
2728
|
-
config?: Partial<FetcherConfig> & {
|
|
2729
|
-
client?: typeof client;
|
|
2730
|
-
};
|
|
2731
|
-
}): Promise<unknown>;
|
|
2732
|
-
/**
|
|
2733
|
-
* @summary Get webinar absentees
|
|
2734
|
-
* @description List absentees of a webinar.
|
|
2735
|
-
* **Prerequisites**
|
|
2736
|
-
* * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on.
|
|
2737
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
2738
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_absentees`,`webinar:read:list_absentees:admin`
|
|
2739
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
2740
|
-
* @link /past_webinars/{webinarId}/absentees
|
|
2741
|
-
*/
|
|
2742
|
-
declare function webinarAbsentees({ pathParams, queryParams, config, }?: {
|
|
2743
|
-
pathParams: {
|
|
2744
|
-
webinarId: string;
|
|
2745
|
-
};
|
|
2746
|
-
queryParams?: {
|
|
2747
|
-
occurrence_id?: string;
|
|
2748
|
-
page_size?: number;
|
|
2749
|
-
next_page_token?: string;
|
|
2750
|
-
};
|
|
2751
|
-
config?: Partial<FetcherConfig> & {
|
|
2752
|
-
client?: typeof client;
|
|
2753
|
-
};
|
|
2754
|
-
}): Promise<unknown>;
|
|
2755
|
-
/**
|
|
2756
|
-
* @summary List past webinar instances
|
|
2757
|
-
* @description List past webinar instances.
|
|
2758
|
-
* **Prerequisites**
|
|
2759
|
-
* * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on.
|
|
2760
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
2761
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_past_instances`,`webinar:read:list_past_instances:admin`
|
|
2762
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2763
|
-
* @link /past_webinars/{webinarId}/instances
|
|
2764
|
-
*/
|
|
2765
|
-
declare function pastWebinars({ pathParams, config, }?: {
|
|
2766
|
-
pathParams: {
|
|
2767
|
-
webinarId: bigint;
|
|
2768
|
-
};
|
|
2769
|
-
config?: Partial<FetcherConfig> & {
|
|
2770
|
-
client?: typeof client;
|
|
2771
|
-
};
|
|
2772
|
-
}): Promise<unknown>;
|
|
2773
|
-
/**
|
|
2774
|
-
* @summary List webinar participants
|
|
2775
|
-
* @description Retrieve a list of all the participants who attended a webinar hosted in the past.
|
|
2776
|
-
* **Prerequisites:**
|
|
2777
|
-
* * A Pro or higher plan with a webinar add-on.
|
|
2778
|
-
* **NOTE:** After meetings with hundreds of participants, the attendance data takes some time to be generated. If you receive a duration of 0 for users' time in the meeting, you may have called the endpoint before the data is fully processed. Implement a short delay or retry logic before fetching participant data.
|
|
2779
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
2780
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_past_participants:admin`,`webinar:read:list_past_participants`
|
|
2781
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
2782
|
-
* @link /past_webinars/{webinarId}/participants
|
|
2783
|
-
*/
|
|
2784
|
-
declare function listWebinarParticipants({ pathParams, queryParams, config, }?: {
|
|
2785
|
-
pathParams: {
|
|
2786
|
-
webinarId: string;
|
|
2787
|
-
};
|
|
2788
|
-
queryParams?: {
|
|
2789
|
-
page_size?: number;
|
|
2790
|
-
next_page_token?: string;
|
|
2791
|
-
};
|
|
2792
|
-
config?: Partial<FetcherConfig> & {
|
|
2793
|
-
client?: typeof client;
|
|
2794
|
-
};
|
|
2795
|
-
}): Promise<unknown>;
|
|
2796
|
-
/**
|
|
2797
|
-
* @summary List past webinar poll results
|
|
2798
|
-
* @description The polling feature for webinar lets you create single-choice or multiple-choice polling questions for your webinars. This API endpoint retrieves the results for webinar polls of a specific webinar.
|
|
2799
|
-
* **Prerequisites:**
|
|
2800
|
-
* * [Webinar license](https://zoom.us/webinar)
|
|
2801
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
2802
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_past_polls`,`webinar:read:list_past_polls:admin`
|
|
2803
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
2804
|
-
* @link /past_webinars/{webinarId}/polls
|
|
2805
|
-
*/
|
|
2806
|
-
declare function listPastWebinarPollResults({ pathParams, config, }?: {
|
|
2807
|
-
pathParams: {
|
|
2808
|
-
webinarId: string;
|
|
2809
|
-
};
|
|
2810
|
-
config?: Partial<FetcherConfig> & {
|
|
2811
|
-
client?: typeof client;
|
|
2812
|
-
};
|
|
2813
|
-
}): Promise<unknown>;
|
|
2814
|
-
/**
|
|
2815
|
-
* @summary List Q&As of a past webinar
|
|
2816
|
-
* @description List the Q&A of a specific past webinar.
|
|
2817
|
-
* The [question and answer (Q&A)](https://support.zoom.us/hc/en-us/articles/203686015-Getting-Started-with-Question-Answer) feature for webinars lets attendees ask questions during the webinar and for the panelists, co-hosts and host to answer their questions.
|
|
2818
|
-
* **Prerequisites**
|
|
2819
|
-
* * [Webinar license](https://zoom.us/webinar)
|
|
2820
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
2821
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:past_qa`,`webinar:read:past_qa:admin`
|
|
2822
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
2823
|
-
* @link /past_webinars/{webinarId}/qa
|
|
2824
|
-
*/
|
|
2825
|
-
declare function listPastWebinarQA({ pathParams, config, }?: {
|
|
2826
|
-
pathParams: {
|
|
2827
|
-
webinarId: string;
|
|
2828
|
-
};
|
|
2829
|
-
config?: Partial<FetcherConfig> & {
|
|
2830
|
-
client?: typeof client;
|
|
2831
|
-
};
|
|
2832
|
-
}): Promise<unknown>;
|
|
2833
|
-
/**
|
|
2834
|
-
* @summary List webinar templates
|
|
2835
|
-
* @description 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).
|
|
2836
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read`,`webinar:read:admin`
|
|
2837
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_templates`,`webinar:read:list_templates:admin`
|
|
2838
|
-
* @link /users/{userId}/webinar_templates
|
|
2839
|
-
*/
|
|
2840
|
-
declare function listWebinarTemplates({ pathParams, config, }?: {
|
|
2841
|
-
pathParams: {
|
|
2842
|
-
userId: string;
|
|
2843
|
-
};
|
|
2844
|
-
config?: Partial<FetcherConfig> & {
|
|
2845
|
-
client?: typeof client;
|
|
2846
|
-
};
|
|
2847
|
-
}): Promise<unknown>;
|
|
2848
|
-
/**
|
|
2849
|
-
* @summary Create a webinar template
|
|
2850
|
-
* @description Create a webinar template from an existing webinar.
|
|
2851
|
-
* **Prerequisites**
|
|
2852
|
-
* * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on.
|
|
2853
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
2854
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:template`,`webinar:write:template:admin`
|
|
2855
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
2856
|
-
* @link /users/{userId}/webinar_templates
|
|
2857
|
-
*/
|
|
2858
|
-
declare function webinarTemplateCreate({ pathParams, body, config, }?: {
|
|
2859
|
-
pathParams: {
|
|
2860
|
-
userId: string;
|
|
2861
|
-
};
|
|
2862
|
-
body?: WebinarTemplateCreateBody;
|
|
2863
|
-
config?: Partial<FetcherConfig> & {
|
|
2864
|
-
client?: typeof client;
|
|
2865
|
-
};
|
|
2866
|
-
}): Promise<unknown>;
|
|
2867
|
-
/**
|
|
2868
|
-
* @summary List webinars
|
|
2869
|
-
* @description List all the webinars scheduled by or on behalf a webinar host. For user-level apps, pass [the `me` value](https://developers.zoom.us/docs/api/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.
|
|
2870
|
-
* Zoom users with a [webinar plan](https://zoom.us/webinar) have access to creating and managing webinars. Webinars let a host broadcast a Zoom meeting to up to 10,000 attendees.
|
|
2871
|
-
* **Note** This API only returns a user's [unexpired webinars](https://support.zoom.us/hc/en-us/articles/201362373-Meeting-ID#h_c73f9b08-c1c0-4a1a-b538-e01ebb98e844).
|
|
2872
|
-
* **Prerequisites**
|
|
2873
|
-
* * A Pro or higher plan with the webinar add-on.
|
|
2874
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
2875
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_webinars`,`webinar:read:list_webinars:admin`
|
|
2876
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
2877
|
-
* @link /users/{userId}/webinars
|
|
2878
|
-
*/
|
|
2879
|
-
declare function webinars({ pathParams, queryParams, config, }?: {
|
|
2880
|
-
pathParams: {
|
|
2881
|
-
userId: string;
|
|
2882
|
-
};
|
|
2883
|
-
queryParams?: {
|
|
2884
|
-
type?: "scheduled" | "upcoming";
|
|
2885
|
-
page_size?: number;
|
|
2886
|
-
page_number?: number;
|
|
2887
|
-
include_events_webinar?: boolean;
|
|
2888
|
-
};
|
|
2889
|
-
config?: Partial<FetcherConfig> & {
|
|
2890
|
-
client?: typeof client;
|
|
2891
|
-
};
|
|
2892
|
-
}): Promise<unknown>;
|
|
2893
|
-
/**
|
|
2894
|
-
* @summary Create a webinar
|
|
2895
|
-
* @description Schedule a webinar for a user who is a webinar host. For user-level apps, pass [the `me` value](/docs/api/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.
|
|
2896
|
-
* Webinars allow a host to broadcast a Zoom meeting to up to 10,000 attendees.
|
|
2897
|
-
* **Rate limit**
|
|
2898
|
-
* Up to a maximum of **100 requests per day**. The rate limit is applied to the `userId` of the **webinar host** used to make the request.
|
|
2899
|
-
* **Prerequisites**
|
|
2900
|
-
* * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on.
|
|
2901
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
2902
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:webinar`,`webinar:write:webinar:admin`
|
|
2903
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2904
|
-
* @link /users/{userId}/webinars
|
|
2905
|
-
*/
|
|
2906
|
-
declare function webinarCreate({ pathParams, body, config, }?: {
|
|
2907
|
-
pathParams: {
|
|
2908
|
-
userId: string;
|
|
2909
|
-
};
|
|
2910
|
-
body?: WebinarCreateBody;
|
|
2911
|
-
config?: Partial<FetcherConfig> & {
|
|
2912
|
-
client?: typeof client;
|
|
2913
|
-
};
|
|
2914
|
-
}): Promise<unknown>;
|
|
2915
|
-
/**
|
|
2916
|
-
* @summary Get a webinar
|
|
2917
|
-
* @description Get details for a scheduled Zoom webinar.
|
|
2918
|
-
* **Prerequisites**
|
|
2919
|
-
* * Pro or higher plan with a Webinar add-on.
|
|
2920
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
2921
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:webinar`,`webinar:read:webinar:admin`
|
|
2922
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2923
|
-
* @link /webinars/{webinarId}
|
|
2924
|
-
*/
|
|
2925
|
-
declare function webinar({ pathParams, queryParams, config, }?: {
|
|
2926
|
-
pathParams: {
|
|
2927
|
-
webinarId: string;
|
|
2928
|
-
};
|
|
2929
|
-
queryParams?: {
|
|
2930
|
-
occurrence_id?: string;
|
|
2931
|
-
show_previous_occurrences?: boolean;
|
|
2932
|
-
};
|
|
2933
|
-
config?: Partial<FetcherConfig> & {
|
|
2934
|
-
client?: typeof client;
|
|
2935
|
-
};
|
|
2936
|
-
}): Promise<unknown>;
|
|
2937
|
-
/**
|
|
2938
|
-
* @summary Delete a webinar
|
|
2939
|
-
* @description Delete a webinar.
|
|
2940
|
-
* **Prerequisites:**
|
|
2941
|
-
* * Pro or higher plan with the webinar add-on.
|
|
2942
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
2943
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:webinar`,`webinar:delete:webinar:admin`
|
|
2944
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2945
|
-
* @link /webinars/{webinarId}
|
|
2946
|
-
*/
|
|
2947
|
-
declare function webinarDelete({ pathParams, queryParams, config, }?: {
|
|
2948
|
-
pathParams: {
|
|
2949
|
-
webinarId: bigint;
|
|
2950
|
-
};
|
|
2951
|
-
queryParams?: {
|
|
2952
|
-
occurrence_id?: string;
|
|
2953
|
-
cancel_webinar_reminder?: boolean;
|
|
2954
|
-
};
|
|
2955
|
-
config?: Partial<FetcherConfig> & {
|
|
2956
|
-
client?: typeof client;
|
|
2957
|
-
};
|
|
2958
|
-
}): Promise<unknown>;
|
|
2959
|
-
/**
|
|
2960
|
-
* @summary Update a webinar
|
|
2961
|
-
* @description Make updates to a scheduled webinar.
|
|
2962
|
-
* **100 requests per day**. The rate limit is applied to the `userId` of the **webinar host** used to make the request.
|
|
2963
|
-
* **Prerequisites**
|
|
2964
|
-
* * A Pro or higher plan with a webinar add-on.
|
|
2965
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
2966
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:webinar`,`webinar:update:webinar:admin`
|
|
2967
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
2968
|
-
* @link /webinars/{webinarId}
|
|
2969
|
-
*/
|
|
2970
|
-
declare function webinarUpdate({ pathParams, body, queryParams, config, }?: {
|
|
2971
|
-
pathParams: {
|
|
2972
|
-
webinarId: bigint;
|
|
2973
|
-
};
|
|
2974
|
-
body?: WebinarUpdateBody;
|
|
2975
|
-
queryParams?: {
|
|
2976
|
-
occurrence_id?: string;
|
|
2977
|
-
};
|
|
2978
|
-
config?: Partial<FetcherConfig> & {
|
|
2979
|
-
client?: typeof client;
|
|
2980
|
-
};
|
|
2981
|
-
}): Promise<unknown>;
|
|
2982
|
-
/**
|
|
2983
|
-
* @summary Perform batch registration
|
|
2984
|
-
* @description Register up to 30 registrants at once for a scheduled webinar that requires [registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-webinar-with-registration).
|
|
2985
|
-
* **Prerequisites:**
|
|
2986
|
-
* * The webinar host must be a licensed user.
|
|
2987
|
-
* * The webinar should be type `5`, a scheduled webinar. Other types of webinars are not supported by this API.
|
|
2988
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
2989
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:batch_registrants`,`webinar:write:batch_registrants:admin`
|
|
2990
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
2991
|
-
* @link /webinars/{webinarId}/batch_registrants
|
|
2992
|
-
*/
|
|
2993
|
-
declare function addBatchWebinarRegistrants({ pathParams, body, config, }?: {
|
|
2994
|
-
pathParams: {
|
|
2995
|
-
webinarId: string;
|
|
2996
|
-
};
|
|
2997
|
-
body?: AddBatchWebinarRegistrantsBody;
|
|
2998
|
-
config?: Partial<FetcherConfig> & {
|
|
2999
|
-
client?: typeof client;
|
|
3000
|
-
};
|
|
3001
|
-
}): Promise<unknown>;
|
|
3002
|
-
/**
|
|
3003
|
-
* @summary Get webinar's session branding
|
|
3004
|
-
* @description 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.
|
|
3005
|
-
* **Prerequisites**
|
|
3006
|
-
* * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on.
|
|
3007
|
-
* * Enable the **Webinar Session Branding** setting.
|
|
3008
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read`,`webinar:read:admin`
|
|
3009
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:branding`,`webinar:read:branding:admin`
|
|
3010
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3011
|
-
* @link /webinars/{webinarId}/branding
|
|
3012
|
-
*/
|
|
3013
|
-
declare function getWebinarBranding({ pathParams, config, }?: {
|
|
3014
|
-
pathParams: {
|
|
3015
|
-
webinarId: bigint;
|
|
3016
|
-
};
|
|
3017
|
-
config?: Partial<FetcherConfig> & {
|
|
3018
|
-
client?: typeof client;
|
|
3019
|
-
};
|
|
3020
|
-
}): Promise<unknown>;
|
|
3021
|
-
/**
|
|
3022
|
-
* @summary Create a webinar's branding name tag
|
|
3023
|
-
* @description 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:**
|
|
3024
|
-
* * The **Webinar Session Branding** setting enabled.
|
|
3025
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
3026
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:branding_name_tag`,`webinar:write:branding_name_tag:admin`
|
|
3027
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
3028
|
-
* @link /webinars/{webinarId}/branding/name_tags
|
|
3029
|
-
*/
|
|
3030
|
-
declare function createWebinarBrandingNameTag({ pathParams, body, config, }?: {
|
|
3031
|
-
pathParams: {
|
|
3032
|
-
webinarId: bigint;
|
|
3033
|
-
};
|
|
3034
|
-
body?: CreateWebinarBrandingNameTagBody;
|
|
3035
|
-
config?: Partial<FetcherConfig> & {
|
|
3036
|
-
client?: typeof client;
|
|
3037
|
-
};
|
|
3038
|
-
}): Promise<unknown>;
|
|
3039
|
-
/**
|
|
3040
|
-
* @summary Delete a webinar's branding name tag
|
|
3041
|
-
* @description Delete a webinar's [session branding](https://support.zoom.us/hc/en-us/articles/4836268732045-Using-Webinar-Session-Branding) name tag.
|
|
3042
|
-
* **Prerequisites:**
|
|
3043
|
-
* * The **Webinar Session Branding** setting enabled.
|
|
3044
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
3045
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:branding_name_tag`,`webinar:delete:branding_name_tag:admin`
|
|
3046
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3047
|
-
* @link /webinars/{webinarId}/branding/name_tags
|
|
3048
|
-
*/
|
|
3049
|
-
declare function deleteWebinarBrandingNameTag({ pathParams, queryParams, config, }?: {
|
|
3050
|
-
pathParams: {
|
|
3051
|
-
webinarId: bigint;
|
|
3052
|
-
};
|
|
3053
|
-
queryParams?: {
|
|
3054
|
-
name_tag_ids?: string;
|
|
3055
|
-
};
|
|
3056
|
-
config?: Partial<FetcherConfig> & {
|
|
3057
|
-
client?: typeof client;
|
|
3058
|
-
};
|
|
3059
|
-
}): Promise<unknown>;
|
|
3060
|
-
/**
|
|
3061
|
-
* @summary Update a webinar's branding name tag
|
|
3062
|
-
* @description Update a webinar's [session branding](https://support.zoom.us/hc/en-us/articles/4836268732045-Using-Webinar-Session-Branding) name tag. **Prerequisites:**
|
|
3063
|
-
* * The **Webinar Session Branding** setting enabled.
|
|
3064
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
3065
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:branding_name_tag`,`webinar:update:branding_name_tag:admin`
|
|
3066
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
3067
|
-
* @link /webinars/{webinarId}/branding/name_tags/{nameTagId}
|
|
3068
|
-
*/
|
|
3069
|
-
declare function updateWebinarBrandingNameTag({ pathParams, body, config, }?: {
|
|
3070
|
-
pathParams: {
|
|
3071
|
-
webinarId: bigint;
|
|
3072
|
-
nameTagId: string;
|
|
3073
|
-
};
|
|
3074
|
-
body?: UpdateWebinarBrandingNameTagBody;
|
|
3075
|
-
config?: Partial<FetcherConfig> & {
|
|
3076
|
-
client?: typeof client;
|
|
3077
|
-
};
|
|
3078
|
-
}): Promise<unknown>;
|
|
3079
|
-
/**
|
|
3080
|
-
* @summary Upload a webinar's branding virtual background
|
|
3081
|
-
* @description Upload a webinar's session branding [virtual background](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background). Hosts and panelists can select and use these virtual backgrounds during the webinar. Branding virtual background files have these restrictions:
|
|
3082
|
-
* * A webinar cannot exceed more than 10 virtual background files.
|
|
3083
|
-
* * You can only upload image files that are in JPG/JPEG, GIF or PNG format.
|
|
3084
|
-
* * The virtual background file size cannot exceed 15 megabytes (MB).
|
|
3085
|
-
* **Prerequisites:**
|
|
3086
|
-
* * The **Webinar Session Branding** setting enabled.
|
|
3087
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
3088
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:branding_virtual_background`,`webinar:write:branding_virtual_background:admin`
|
|
3089
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
3090
|
-
* @link /webinars/{webinarId}/branding/virtual_backgrounds
|
|
3091
|
-
*/
|
|
3092
|
-
declare function uploadWebinarBrandingVB({ pathParams, config, }?: {
|
|
3093
|
-
pathParams: {
|
|
3094
|
-
webinarId: bigint;
|
|
3095
|
-
};
|
|
3096
|
-
config?: Partial<FetcherConfig> & {
|
|
3097
|
-
client?: typeof client;
|
|
3098
|
-
};
|
|
3099
|
-
}): Promise<unknown>;
|
|
3100
|
-
/**
|
|
3101
|
-
* @summary Delete a webinar's branding virtual backgrounds
|
|
3102
|
-
* @description Delete a webinar's session branding [virtual background](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background).
|
|
3103
|
-
* **Prerequisites:**
|
|
3104
|
-
* * The **Webinar Session Branding** setting enabled.
|
|
3105
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
3106
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:branding_virtual_background`,`webinar:delete:branding_virtual_background:admin`
|
|
3107
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3108
|
-
* @link /webinars/{webinarId}/branding/virtual_backgrounds
|
|
3109
|
-
*/
|
|
3110
|
-
declare function deleteWebinarBrandingVB({ pathParams, queryParams, config, }?: {
|
|
3111
|
-
pathParams: {
|
|
3112
|
-
webinarId: bigint;
|
|
3113
|
-
};
|
|
3114
|
-
queryParams?: {
|
|
3115
|
-
ids?: string;
|
|
3116
|
-
};
|
|
3117
|
-
config?: Partial<FetcherConfig> & {
|
|
3118
|
-
client?: typeof client;
|
|
3119
|
-
};
|
|
3120
|
-
}): Promise<unknown>;
|
|
3121
|
-
/**
|
|
3122
|
-
* @summary Set webinar's default branding virtual background
|
|
3123
|
-
* @description Set a webinar's default session branding [virtual background](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background).
|
|
3124
|
-
* **Prerequisites:**
|
|
3125
|
-
* * The **Webinar Session Branding** setting enabled.
|
|
3126
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
3127
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:branding_virtual_background`,`webinar:update:branding_virtual_background:admin`
|
|
3128
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3129
|
-
* @link /webinars/{webinarId}/branding/virtual_backgrounds
|
|
3130
|
-
*/
|
|
3131
|
-
declare function setWebinarBrandingVB({ pathParams, queryParams, config, }?: {
|
|
3132
|
-
pathParams: {
|
|
3133
|
-
webinarId: bigint;
|
|
3134
|
-
};
|
|
3135
|
-
queryParams?: {
|
|
3136
|
-
id?: string;
|
|
3137
|
-
set_default_for_all_panelists?: boolean;
|
|
3138
|
-
};
|
|
3139
|
-
config?: Partial<FetcherConfig> & {
|
|
3140
|
-
client?: typeof client;
|
|
3141
|
-
};
|
|
3142
|
-
}): Promise<unknown>;
|
|
3143
|
-
/**
|
|
3144
|
-
* @summary Upload a webinar's branding wallpaper
|
|
3145
|
-
* @description Upload a webinar's session branding wallpaper file. Webinar branding wallpaper files have these requirements:
|
|
3146
|
-
* * A webinar can only have one wallpaper file.
|
|
3147
|
-
* * You can only upload image files that are in JPG/JPEG, GIF, or PNG format.
|
|
3148
|
-
* * Image files must be 16:9 ratio. The recommended image size is 1920 x 1080 pixels.
|
|
3149
|
-
* * The wallpaper file size cannot exceed 15 megabytes.
|
|
3150
|
-
* **Prerequisites:**
|
|
3151
|
-
* * The **Webinar Session Branding** setting enabled.
|
|
3152
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
3153
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:branding_wallpaper`,`webinar:write:branding_wallpaper:admin`
|
|
3154
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
3155
|
-
* @link /webinars/{webinarId}/branding/wallpaper
|
|
3156
|
-
*/
|
|
3157
|
-
declare function uploadWebinarBrandingWallpaper({ pathParams, config, }?: {
|
|
3158
|
-
pathParams: {
|
|
3159
|
-
webinarId: bigint;
|
|
3160
|
-
};
|
|
3161
|
-
config?: Partial<FetcherConfig> & {
|
|
3162
|
-
client?: typeof client;
|
|
3163
|
-
};
|
|
3164
|
-
}): Promise<unknown>;
|
|
3165
|
-
/**
|
|
3166
|
-
* @summary Delete a webinar's branding wallpaper
|
|
3167
|
-
* @description Delete a webinar's session branding wallpaper file.
|
|
3168
|
-
* **Prerequisites:**
|
|
3169
|
-
* * The **Webinar Session Branding** setting enabled.
|
|
3170
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
3171
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:branding_wallpaper`,`webinar:delete:branding_wallpaper:admin`
|
|
3172
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3173
|
-
* @link /webinars/{webinarId}/branding/wallpaper
|
|
3174
|
-
*/
|
|
3175
|
-
declare function deleteWebinarBrandingWallpaper({ pathParams, config, }?: {
|
|
3176
|
-
pathParams: {
|
|
3177
|
-
webinarId: bigint;
|
|
3178
|
-
};
|
|
3179
|
-
config?: Partial<FetcherConfig> & {
|
|
3180
|
-
client?: typeof client;
|
|
3181
|
-
};
|
|
3182
|
-
}): Promise<unknown>;
|
|
3183
|
-
/**
|
|
3184
|
-
* @summary Create webinar's invite links
|
|
3185
|
-
* @description Create a batch of invitation links for a webinar.
|
|
3186
|
-
* **Prerequisites:**
|
|
3187
|
-
* * Business, Education or API Plan with the Webinar add-on.
|
|
3188
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
3189
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:invite_links`,`webinar:write:invite_links:admin`
|
|
3190
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3191
|
-
* @link /webinars/{webinarId}/invite_links
|
|
3192
|
-
*/
|
|
3193
|
-
declare function webinarInviteLinksCreate({ pathParams, body, config, }?: {
|
|
3194
|
-
pathParams: {
|
|
3195
|
-
webinarId: bigint;
|
|
3196
|
-
};
|
|
3197
|
-
body?: WebinarInviteLinksCreateBody;
|
|
3198
|
-
config?: Partial<FetcherConfig> & {
|
|
3199
|
-
client?: typeof client;
|
|
3200
|
-
};
|
|
3201
|
-
}): Promise<unknown>;
|
|
3202
|
-
/**
|
|
3203
|
-
* @summary Get a webinar's join token for live streaming
|
|
3204
|
-
* @description Retrieve a webinar's archive token to allow live streaming. The join token lets a recording bot implemented using Zoom meeting SDK connect to a Zoom meeting **hosted by the issuer of the token**, and can call the streaming method automatically. It supports both regular live streaming and raw streaming.
|
|
3205
|
-
* **Prerequisites:**
|
|
3206
|
-
* * A Pro or higher plan with a Webinar add-on.
|
|
3207
|
-
* * The **Allow livestreaming of webinars** user setting enabled in the Zoom web portal.
|
|
3208
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar_token:read:admin:live_streaming`,`webinar_token:read:live_streaming`
|
|
3209
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:live_streaming_token`,`webinar:read:live_streaming_token:admin`
|
|
3210
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3211
|
-
* @link /webinars/{webinarId}/jointoken/live_streaming
|
|
3212
|
-
*/
|
|
3213
|
-
declare function webinarLiveStreamingJoinToken({ pathParams, config, }?: {
|
|
3214
|
-
pathParams: {
|
|
3215
|
-
webinarId: bigint;
|
|
3216
|
-
};
|
|
3217
|
-
config?: Partial<FetcherConfig> & {
|
|
3218
|
-
client?: typeof client;
|
|
3219
|
-
};
|
|
3220
|
-
}): Promise<unknown>;
|
|
3221
|
-
/**
|
|
3222
|
-
* @summary Get a webinar's archive token for local archiving
|
|
3223
|
-
* @description Use this API to get a webinar's archive token to allow local archiving. The archive token allows a meeting SDK app or bot to get archive permission to access the webinar's raw audio and video media stream in real-time.
|
|
3224
|
-
* **Prerequisites:**
|
|
3225
|
-
* * A Pro or higher plan with a Webinar Add-on.
|
|
3226
|
-
* * The **Archive meetings and webinars** account setting enabled in the Zoom web portal.
|
|
3227
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar_token:read:admin:local_archiving`
|
|
3228
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:local_archiving_token:admin`
|
|
3229
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3230
|
-
* @link /webinars/{webinarId}/jointoken/local_archiving
|
|
3231
|
-
*/
|
|
3232
|
-
declare function webinarLocalArchivingArchiveToken({ pathParams, config, }?: {
|
|
3233
|
-
pathParams: {
|
|
3234
|
-
webinarId: bigint;
|
|
3235
|
-
};
|
|
3236
|
-
config?: Partial<FetcherConfig> & {
|
|
3237
|
-
client?: typeof client;
|
|
3238
|
-
};
|
|
3239
|
-
}): Promise<unknown>;
|
|
3240
|
-
/**
|
|
3241
|
-
* @summary Get a webinar's join token for local recording
|
|
3242
|
-
* @description Retrieve a webinar's join token to allow for local recording. The join token lets a recording bot implemented using Zoom Meeting SDK connect to a Zoom webinar. The recording bot can then automatically start locally recording. This supports both regular and raw local recording.
|
|
3243
|
-
* **Prerequisites:**
|
|
3244
|
-
* * A Pro or higher plan with a Webinar add-on.
|
|
3245
|
-
* * The **Local recording** user setting enabled in the Zoom web portal.
|
|
3246
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar_token:read:admin:local_recording`,`webinar_token:read:local_recording`
|
|
3247
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:local_recording_token`,`webinar:read:local_recording_token:admin`
|
|
3248
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3249
|
-
* @link /webinars/{webinarId}/jointoken/local_recording
|
|
3250
|
-
*/
|
|
3251
|
-
declare function webinarLocalRecordingJoinToken({ pathParams, config, }?: {
|
|
3252
|
-
pathParams: {
|
|
3253
|
-
webinarId: bigint;
|
|
3254
|
-
};
|
|
3255
|
-
config?: Partial<FetcherConfig> & {
|
|
3256
|
-
client?: typeof client;
|
|
3257
|
-
};
|
|
3258
|
-
}): Promise<unknown>;
|
|
3259
|
-
/**
|
|
3260
|
-
* @summary Get live stream details
|
|
3261
|
-
* @description Get a webinar's live stream configuration details, such as Stream URL, Stream Key and Page URL.
|
|
3262
|
-
* Zoom allows users to [live stream a webinar](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform.
|
|
3263
|
-
* **Prerequisites:**
|
|
3264
|
-
* * Pro or higher plan with the webinar add-on.
|
|
3265
|
-
* * Live streaming details must have been [configured](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service#h_01589a6f-a40a-4e18-a448-cb746e52ebc5) for the webinar.
|
|
3266
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
3267
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:livestream`,`webinar:read:livestream:admin`
|
|
3268
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3269
|
-
* @link /webinars/{webinarId}/livestream
|
|
3270
|
-
*/
|
|
3271
|
-
declare function getWebinarLiveStreamDetails({ pathParams, config, }?: {
|
|
3272
|
-
pathParams: {
|
|
3273
|
-
webinarId: string;
|
|
3274
|
-
};
|
|
3275
|
-
config?: Partial<FetcherConfig> & {
|
|
3276
|
-
client?: typeof client;
|
|
3277
|
-
};
|
|
3278
|
-
}): Promise<unknown>;
|
|
3279
|
-
/**
|
|
3280
|
-
* @summary Update a live stream
|
|
3281
|
-
* @description Update a webinar's live stream information.
|
|
3282
|
-
* **Prerequisites:**
|
|
3283
|
-
* * Pro or higher plan with the webinar add-on.
|
|
3284
|
-
* * Live streaming details must be [configured](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service#h_01589a6f-a40a-4e18-a448-cb746e52ebc5) for the webinar.
|
|
3285
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
3286
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:livestream`,`webinar:update:livestream:admin`
|
|
3287
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3288
|
-
* @link /webinars/{webinarId}/livestream
|
|
3289
|
-
*/
|
|
3290
|
-
declare function webinarLiveStreamUpdate({ pathParams, body, config, }?: {
|
|
3291
|
-
pathParams: {
|
|
3292
|
-
webinarId: bigint;
|
|
3293
|
-
};
|
|
3294
|
-
body?: WebinarLiveStreamUpdateBody;
|
|
3295
|
-
config?: Partial<FetcherConfig> & {
|
|
3296
|
-
client?: typeof client;
|
|
3297
|
-
};
|
|
3298
|
-
}): Promise<unknown>;
|
|
3299
|
-
/**
|
|
3300
|
-
* @summary Update live stream status
|
|
3301
|
-
* @description Lets users [live stream a webinar](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Update the status of a webinar's live stream.
|
|
3302
|
-
* **Prerequisites:**
|
|
3303
|
-
* * Pro or higher plan with a Webinar Add-on.
|
|
3304
|
-
* * Live streaming details must be [configured](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service#h_01589a6f-a40a-4e18-a448-cb746e52ebc5) for the webinar.
|
|
3305
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
3306
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:livestream_status`,`webinar:update:livestream_status:admin`
|
|
3307
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3308
|
-
* @link /webinars/{webinarId}/livestream/status
|
|
3309
|
-
*/
|
|
3310
|
-
declare function webinarLiveStreamStatusUpdate({ pathParams, body, config, }?: {
|
|
3311
|
-
pathParams: {
|
|
3312
|
-
webinarId: bigint;
|
|
3313
|
-
};
|
|
3314
|
-
body?: WebinarLiveStreamStatusUpdateBody;
|
|
3315
|
-
config?: Partial<FetcherConfig> & {
|
|
3316
|
-
client?: typeof client;
|
|
3317
|
-
};
|
|
3318
|
-
}): Promise<unknown>;
|
|
3319
|
-
/**
|
|
3320
|
-
* @summary List panelists
|
|
3321
|
-
* @description List all of a webinar's panelists.
|
|
3322
|
-
* Webinar panelists can view and send video, screen share, annotate, and do much more compared to webinar attendees.
|
|
3323
|
-
* **Prerequisites:**
|
|
3324
|
-
* * Pro or a higher plan with [Webinar Add-on](https://zoom.us/webinar).
|
|
3325
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
3326
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_panelists`,`webinar:read:list_panelists:admin`
|
|
3327
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
3328
|
-
* @link /webinars/{webinarId}/panelists
|
|
3329
|
-
*/
|
|
3330
|
-
declare function webinarPanelists({ pathParams, config, }?: {
|
|
3331
|
-
pathParams: {
|
|
3332
|
-
webinarId: bigint;
|
|
3333
|
-
};
|
|
3334
|
-
config?: Partial<FetcherConfig> & {
|
|
3335
|
-
client?: typeof client;
|
|
3336
|
-
};
|
|
3337
|
-
}): Promise<unknown>;
|
|
3338
|
-
/**
|
|
3339
|
-
* @summary Add panelists
|
|
3340
|
-
* @description Panelists in a webinar can view and send video, screen share, annotate, and do much more compared to attendees in a webinar.
|
|
3341
|
-
* [Add panelists](https://support.zoom.us/hc/en-us/articles/115005657826-Inviting-Panelists-to-a-Webinar#h_7550d59e-23f5-4703-9e22-e76bded1ed70) to a scheduled webinar.
|
|
3342
|
-
* **Prerequisites:**
|
|
3343
|
-
* * Pro or a higher plan with the [Webinar Add-on](https://zoom.us/webinar).
|
|
3344
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
3345
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:panelist`,`webinar:write:panelist:admin`
|
|
3346
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
3347
|
-
* @link /webinars/{webinarId}/panelists
|
|
3348
|
-
*/
|
|
3349
|
-
declare function webinarPanelistCreate({ pathParams, body, config, }?: {
|
|
3350
|
-
pathParams: {
|
|
3351
|
-
webinarId: bigint;
|
|
3352
|
-
};
|
|
3353
|
-
body?: WebinarPanelistCreateBody;
|
|
3354
|
-
config?: Partial<FetcherConfig> & {
|
|
3355
|
-
client?: typeof client;
|
|
3356
|
-
};
|
|
3357
|
-
}): Promise<unknown>;
|
|
3358
|
-
/**
|
|
3359
|
-
* @summary Remove all panelists
|
|
3360
|
-
* @description Remove all the panelists from a webinar.
|
|
3361
|
-
* **Prerequisites:**
|
|
3362
|
-
* * Pro or a higher plan with the [webinar add-on](https://zoom.us/webinar).
|
|
3363
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
3364
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:panelist`,`webinar:delete:panelist:admin`
|
|
3365
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3366
|
-
* @link /webinars/{webinarId}/panelists
|
|
3367
|
-
*/
|
|
3368
|
-
declare function webinarPanelistsDelete({ pathParams, config, }?: {
|
|
3369
|
-
pathParams: {
|
|
3370
|
-
webinarId: bigint;
|
|
3371
|
-
};
|
|
3372
|
-
config?: Partial<FetcherConfig> & {
|
|
3373
|
-
client?: typeof client;
|
|
3374
|
-
};
|
|
3375
|
-
}): Promise<unknown>;
|
|
3376
|
-
/**
|
|
3377
|
-
* @summary Remove a panelist
|
|
3378
|
-
* @description [Remove](https://support.zoom.us/hc/en-us/articles/115005657826-Inviting-Panelists-to-a-Webinar#h_de31f237-a91c-4fb2-912b-ecfba8ec5ffb) a single panelist from a webinar.
|
|
3379
|
-
* Retrieve the `panelistId` by calling **List Panelists API**.
|
|
3380
|
-
* **Prerequisites:**
|
|
3381
|
-
* * Pro or a higher plan with the [webinar add-on](https://zoom.us/webinar).
|
|
3382
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
3383
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:panelist`,`webinar:delete:panelist:admin`
|
|
3384
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3385
|
-
* @link /webinars/{webinarId}/panelists/{panelistId}
|
|
3386
|
-
*/
|
|
3387
|
-
declare function webinarPanelistDelete({ pathParams, config, }?: {
|
|
3388
|
-
pathParams: {
|
|
3389
|
-
webinarId: bigint;
|
|
3390
|
-
panelistId: string;
|
|
3391
|
-
};
|
|
3392
|
-
config?: Partial<FetcherConfig> & {
|
|
3393
|
-
client?: typeof client;
|
|
3394
|
-
};
|
|
3395
|
-
}): Promise<unknown>;
|
|
3396
|
-
/**
|
|
3397
|
-
* @summary List a webinar's polls
|
|
3398
|
-
* @description Lists all the [polls](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) of a webinar.
|
|
3399
|
-
* **Prerequisites**
|
|
3400
|
-
* * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on.
|
|
3401
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
3402
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_polls`,`webinar:read:list_polls:admin`
|
|
3403
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3404
|
-
* @link /webinars/{webinarId}/polls
|
|
3405
|
-
*/
|
|
3406
|
-
declare function webinarPolls({ pathParams, queryParams, config, }?: {
|
|
3407
|
-
pathParams: {
|
|
3408
|
-
webinarId: bigint;
|
|
3409
|
-
};
|
|
3410
|
-
queryParams?: {
|
|
3411
|
-
anonymous?: boolean;
|
|
3412
|
-
};
|
|
3413
|
-
config?: Partial<FetcherConfig> & {
|
|
3414
|
-
client?: typeof client;
|
|
3415
|
-
};
|
|
3416
|
-
}): Promise<unknown>;
|
|
3417
|
-
/**
|
|
3418
|
-
* @summary Create a webinar's poll
|
|
3419
|
-
* @description Creates a [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) for a webinar.
|
|
3420
|
-
* **Prerequisites**
|
|
3421
|
-
* * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on.
|
|
3422
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
3423
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:poll`,`webinar:write:poll:admin`
|
|
3424
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3425
|
-
* @link /webinars/{webinarId}/polls
|
|
3426
|
-
*/
|
|
3427
|
-
declare function webinarPollCreate({ pathParams, body, config, }?: {
|
|
3428
|
-
pathParams: {
|
|
3429
|
-
webinarId: bigint;
|
|
3430
|
-
};
|
|
3431
|
-
body?: WebinarPollCreateBody;
|
|
3432
|
-
config?: Partial<FetcherConfig> & {
|
|
3433
|
-
client?: typeof client;
|
|
3434
|
-
};
|
|
3435
|
-
}): Promise<unknown>;
|
|
3436
|
-
/**
|
|
3437
|
-
* @summary Get a webinar poll
|
|
3438
|
-
* @description Returns a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars) details.
|
|
3439
|
-
* **Prerequisites**
|
|
3440
|
-
* * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on.
|
|
3441
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
3442
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:poll`,`webinar:read:poll:admin`
|
|
3443
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3444
|
-
* @link /webinars/{webinarId}/polls/{pollId}
|
|
3445
|
-
*/
|
|
3446
|
-
declare function webinarPollGet({ pathParams, config, }?: {
|
|
3447
|
-
pathParams: {
|
|
3448
|
-
webinarId: bigint;
|
|
3449
|
-
pollId: string;
|
|
3450
|
-
};
|
|
3451
|
-
config?: Partial<FetcherConfig> & {
|
|
3452
|
-
client?: typeof client;
|
|
3453
|
-
};
|
|
3454
|
-
}): Promise<unknown>;
|
|
3455
|
-
/**
|
|
3456
|
-
* @summary Update a webinar poll
|
|
3457
|
-
* @description Updates a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).
|
|
3458
|
-
* **Prerequisites**
|
|
3459
|
-
* * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on.
|
|
3460
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
3461
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:poll`,`webinar:update:poll:admin`
|
|
3462
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3463
|
-
* @link /webinars/{webinarId}/polls/{pollId}
|
|
3464
|
-
*/
|
|
3465
|
-
declare function webinarPollUpdate({ pathParams, body, config, }?: {
|
|
3466
|
-
pathParams: {
|
|
3467
|
-
webinarId: bigint;
|
|
3468
|
-
pollId: string;
|
|
3469
|
-
};
|
|
3470
|
-
body?: WebinarPollUpdateBody;
|
|
3471
|
-
config?: Partial<FetcherConfig> & {
|
|
3472
|
-
client?: typeof client;
|
|
3473
|
-
};
|
|
3474
|
-
}): Promise<unknown>;
|
|
3475
|
-
/**
|
|
3476
|
-
* @summary Delete a webinar poll
|
|
3477
|
-
* @description Delete a webinar's [poll](https://support.zoom.us/hc/en-us/articles/203749865-Polling-for-Webinars).
|
|
3478
|
-
* **Prerequisites**
|
|
3479
|
-
* * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on.
|
|
3480
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
3481
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:poll`,`webinar:delete:poll:admin`
|
|
3482
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3483
|
-
* @link /webinars/{webinarId}/polls/{pollId}
|
|
3484
|
-
*/
|
|
3485
|
-
declare function webinarPollDelete({ pathParams, config, }?: {
|
|
3486
|
-
pathParams: {
|
|
3487
|
-
webinarId: bigint;
|
|
3488
|
-
pollId: string;
|
|
3489
|
-
};
|
|
3490
|
-
config?: Partial<FetcherConfig> & {
|
|
3491
|
-
client?: typeof client;
|
|
3492
|
-
};
|
|
3493
|
-
}): Promise<unknown>;
|
|
3494
|
-
/**
|
|
3495
|
-
* @summary List webinar registrants
|
|
3496
|
-
* @description List all users that have registered for a given webinar. Zoom users with a [webinar plan](https://zoom.us/webinar) have access to creating and managing webinars. The webinar functionality lets a host broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a [webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the webinar.
|
|
3497
|
-
* **Prerequisites**
|
|
3498
|
-
* * Pro or higher plan with a Webinar add-on.
|
|
3499
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
3500
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_registrants`,`webinar:read:list_registrants:admin`
|
|
3501
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
3502
|
-
* @link /webinars/{webinarId}/registrants
|
|
3503
|
-
*/
|
|
3504
|
-
declare function webinarRegistrants({ pathParams, queryParams, config, }?: {
|
|
3505
|
-
pathParams: {
|
|
3506
|
-
webinarId: bigint;
|
|
3507
|
-
};
|
|
3508
|
-
queryParams?: {
|
|
3509
|
-
occurrence_id?: string;
|
|
3510
|
-
status?: "pending" | "approved" | "denied";
|
|
3511
|
-
tracking_source_id?: string;
|
|
3512
|
-
page_size?: number;
|
|
3513
|
-
page_number?: number;
|
|
3514
|
-
next_page_token?: string;
|
|
3515
|
-
};
|
|
3516
|
-
config?: Partial<FetcherConfig> & {
|
|
3517
|
-
client?: typeof client;
|
|
3518
|
-
};
|
|
3519
|
-
}): Promise<unknown>;
|
|
3520
|
-
/**
|
|
3521
|
-
* @summary Add a webinar registrant
|
|
3522
|
-
* @description Create and submit a user's registration for a webinar. Zoom users with a [Webinar plan](https://zoom.us/webinar) have access to creating and managing webinars. Webinars allow hosts to broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a [webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the webinar.
|
|
3523
|
-
* **Prerequisites:**
|
|
3524
|
-
* * A Pro or higher plan with the Webinar add-on.
|
|
3525
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
3526
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:registrant`,`webinar:write:registrant:admin`
|
|
3527
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3528
|
-
* @link /webinars/{webinarId}/registrants
|
|
3529
|
-
*/
|
|
3530
|
-
declare function webinarRegistrantCreate({ pathParams, body, queryParams, config, }?: {
|
|
3531
|
-
pathParams: {
|
|
3532
|
-
webinarId: bigint;
|
|
3533
|
-
};
|
|
3534
|
-
body?: WebinarRegistrantCreateBody;
|
|
3535
|
-
queryParams?: {
|
|
3536
|
-
occurrence_ids?: string;
|
|
3537
|
-
};
|
|
3538
|
-
config?: Partial<FetcherConfig> & {
|
|
3539
|
-
client?: typeof client;
|
|
3540
|
-
};
|
|
3541
|
-
}): Promise<unknown>;
|
|
3542
|
-
/**
|
|
3543
|
-
* @summary List registration questions
|
|
3544
|
-
* @description List registration questions and fields that are to be answered by users while registering for a webinar.
|
|
3545
|
-
* Scheduling a [webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form with fields and questions before they can receive the link to join the webinar.
|
|
3546
|
-
* **Prerequisites:**
|
|
3547
|
-
* * Pro or higher plan with the webinar add-on.
|
|
3548
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
3549
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_registration_questions`,`webinar:read:list_registration_questions:admin`
|
|
3550
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3551
|
-
* @link /webinars/{webinarId}/registrants/questions
|
|
3552
|
-
*/
|
|
3553
|
-
declare function webinarRegistrantsQuestionsGet({ pathParams, config, }?: {
|
|
3554
|
-
pathParams: {
|
|
3555
|
-
webinarId: bigint;
|
|
3556
|
-
};
|
|
3557
|
-
config?: Partial<FetcherConfig> & {
|
|
3558
|
-
client?: typeof client;
|
|
3559
|
-
};
|
|
3560
|
-
}): Promise<unknown>;
|
|
3561
|
-
/**
|
|
3562
|
-
* @summary Update registration questions
|
|
3563
|
-
* @description Update registration questions and fields of a scheduled webinar for users to answer during webinar registration. Scheduling a [webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form with fields and questions before they can receive the link to join the webinar.
|
|
3564
|
-
* **Prerequisites:**
|
|
3565
|
-
* * Pro or higher plan with a Webinar Add-on.
|
|
3566
|
-
* * Registration option for Webinar should be set as required to use this API.
|
|
3567
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
3568
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:registration_question`,`webinar:update:registration_question:admin`
|
|
3569
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3570
|
-
* @link /webinars/{webinarId}/registrants/questions
|
|
3571
|
-
*/
|
|
3572
|
-
declare function webinarRegistrantQuestionUpdate({ pathParams, body, config, }?: {
|
|
3573
|
-
pathParams: {
|
|
3574
|
-
webinarId: bigint;
|
|
3575
|
-
};
|
|
3576
|
-
body?: WebinarRegistrantQuestionUpdateBody;
|
|
3577
|
-
config?: Partial<FetcherConfig> & {
|
|
3578
|
-
client?: typeof client;
|
|
3579
|
-
};
|
|
3580
|
-
}): Promise<unknown>;
|
|
3581
|
-
/**
|
|
3582
|
-
* @summary Update registrant's status
|
|
3583
|
-
* @description Update webinar registrants' registration status. You can approve or deny a registrant, or revoke a registrant's approval.
|
|
3584
|
-
* **Prerequisites**
|
|
3585
|
-
* * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on.
|
|
3586
|
-
* This API has an additional rate limit of requests per registrant, per 24-hour period. [See the Rate Limits page](/docs/api/rate-limits/) for more information.
|
|
3587
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
3588
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:registrant_status`,`webinar:update:registrant_status:admin`
|
|
3589
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
3590
|
-
* @link /webinars/{webinarId}/registrants/status
|
|
3591
|
-
*/
|
|
3592
|
-
declare function webinarRegistrantStatus({ pathParams, body, queryParams, config, }?: {
|
|
3593
|
-
pathParams: {
|
|
3594
|
-
webinarId: bigint;
|
|
3595
|
-
};
|
|
3596
|
-
body?: WebinarRegistrantStatusBody;
|
|
3597
|
-
queryParams?: {
|
|
3598
|
-
occurrence_id?: string;
|
|
3599
|
-
};
|
|
3600
|
-
config?: Partial<FetcherConfig> & {
|
|
3601
|
-
client?: typeof client;
|
|
3602
|
-
};
|
|
3603
|
-
}): Promise<unknown>;
|
|
3604
|
-
/**
|
|
3605
|
-
* @summary Get a webinar registrant
|
|
3606
|
-
* @description Zoom users with a [webinar plan](https://zoom.us/webinar) have access to creating and managing webinars. The webinar feature lets a host broadcast a Zoom meeting to up to 10,000 attendees. Scheduling a [webinar with registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-Webinar-with-Registration) requires your registrants to complete a brief form before receiving the link to join the webinar.
|
|
3607
|
-
* Use this API to get details on a specific user who has registered for the webinar.
|
|
3608
|
-
* **Prerequisites:**
|
|
3609
|
-
* * The account must have a webinar plan.
|
|
3610
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
3611
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:registrant`,`webinar:read:registrant:admin`
|
|
3612
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3613
|
-
* @link /webinars/{webinarId}/registrants/{registrantId}
|
|
3614
|
-
*/
|
|
3615
|
-
declare function webinarRegistrantGet({ pathParams, queryParams, config, }?: {
|
|
3616
|
-
pathParams: {
|
|
3617
|
-
webinarId: bigint;
|
|
3618
|
-
registrantId: string;
|
|
3619
|
-
};
|
|
3620
|
-
queryParams?: {
|
|
3621
|
-
occurrence_id?: string;
|
|
3622
|
-
};
|
|
3623
|
-
config?: Partial<FetcherConfig> & {
|
|
3624
|
-
client?: typeof client;
|
|
3625
|
-
};
|
|
3626
|
-
}): Promise<unknown>;
|
|
3627
|
-
/**
|
|
3628
|
-
* @summary Delete a webinar registrant
|
|
3629
|
-
* @description Delete a webinar registrant.
|
|
3630
|
-
* **Prerequisites**
|
|
3631
|
-
* * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on.
|
|
3632
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
3633
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:registrant`,`webinar:delete:registrant:admin`
|
|
3634
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3635
|
-
* @link /webinars/{webinarId}/registrants/{registrantId}
|
|
3636
|
-
*/
|
|
3637
|
-
declare function deleteWebinarRegistrant({ pathParams, queryParams, config, }?: {
|
|
3638
|
-
pathParams: {
|
|
3639
|
-
webinarId: number;
|
|
3640
|
-
registrantId: string;
|
|
3641
|
-
};
|
|
3642
|
-
queryParams?: {
|
|
3643
|
-
occurrence_id?: string;
|
|
3644
|
-
};
|
|
3645
|
-
config?: Partial<FetcherConfig> & {
|
|
3646
|
-
client?: typeof client;
|
|
3647
|
-
};
|
|
3648
|
-
}): Promise<unknown>;
|
|
3649
|
-
/**
|
|
3650
|
-
* @summary Get a webinar SIP URI with passcode
|
|
3651
|
-
* @description 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.
|
|
3652
|
-
* **Prerequisites**
|
|
3653
|
-
* * A Pro or higher plan with a [Webinar plan](https://zoom.us/webinar) add-on.
|
|
3654
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:sip_dialing`,`webinar:write:admin:sip_dialing`
|
|
3655
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:sip_dialing`,`webinar:write:sip_dialing:admin`
|
|
3656
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3657
|
-
* @link /webinars/{webinarId}/sip_dialing
|
|
3658
|
-
*/
|
|
3659
|
-
declare function getWebinarSipDialingWithPasscode({ pathParams, body, config, }?: {
|
|
3660
|
-
pathParams: {
|
|
3661
|
-
webinarId: bigint;
|
|
3662
|
-
};
|
|
3663
|
-
body?: GetWebinarSipDialingWithPasscodeBody;
|
|
3664
|
-
config?: Partial<FetcherConfig> & {
|
|
3665
|
-
client?: typeof client;
|
|
3666
|
-
};
|
|
3667
|
-
}): Promise<unknown>;
|
|
3668
|
-
/**
|
|
3669
|
-
* @summary Update webinar status
|
|
3670
|
-
* @description Update a webinar's status. Use this API to end an ongoing webinar.
|
|
3671
|
-
* **Prerequisites:**
|
|
3672
|
-
* * The account must hold a valid [Webinar plan](https://zoom.us/webinar).
|
|
3673
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write:admin`,`webinar:write`
|
|
3674
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:status`,`webinar:update:status:admin`
|
|
3675
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3676
|
-
* @link /webinars/{webinarId}/status
|
|
3677
|
-
*/
|
|
3678
|
-
declare function webinarStatus({ pathParams, body, config, }?: {
|
|
3679
|
-
pathParams: {
|
|
3680
|
-
webinarId: bigint;
|
|
3681
|
-
};
|
|
3682
|
-
body?: WebinarStatusBody;
|
|
3683
|
-
config?: Partial<FetcherConfig> & {
|
|
3684
|
-
client?: typeof client;
|
|
3685
|
-
};
|
|
3686
|
-
}): Promise<unknown>;
|
|
3687
|
-
/**
|
|
3688
|
-
* @summary Get a webinar survey
|
|
3689
|
-
* @description Return information about a [webinar survey](https://support.zoom.us/hc/en-us/articles/360048745651).
|
|
3690
|
-
* **Prerequisites:**
|
|
3691
|
-
* * A Pro or higher plan with the Webinar add-on.
|
|
3692
|
-
* * The [**Webinar Survey**](https://support.zoom.us/hc/en-us/articles/360061293191-Enabling-webinar-survey) feature enabled in the host's account.
|
|
3693
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
3694
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:survey`,`webinar:read:survey:admin`
|
|
3695
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3696
|
-
* @link /webinars/{webinarId}/survey
|
|
3697
|
-
*/
|
|
3698
|
-
declare function webinarSurveyGet({ pathParams, config, }?: {
|
|
3699
|
-
pathParams: {
|
|
3700
|
-
webinarId: bigint;
|
|
3701
|
-
};
|
|
3702
|
-
config?: Partial<FetcherConfig> & {
|
|
3703
|
-
client?: typeof client;
|
|
3704
|
-
};
|
|
3705
|
-
}): Promise<unknown>;
|
|
3706
|
-
/**
|
|
3707
|
-
* @summary Delete a webinar survey
|
|
3708
|
-
* @description Delete a [webinar survey](https://support.zoom.us/hc/en-us/articles/360048745651).
|
|
3709
|
-
* **Prerequisites:**
|
|
3710
|
-
* * A Pro or higher plan with the Webinar Add-on.
|
|
3711
|
-
* * The [**Webinar Survey**](https://support.zoom.us/hc/en-us/articles/360061293191-Enabling-webinar-survey) feature enabled in the host's account.
|
|
3712
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
3713
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:delete:survey`,`webinar:delete:survey:admin`
|
|
3714
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3715
|
-
* @link /webinars/{webinarId}/survey
|
|
3716
|
-
*/
|
|
3717
|
-
declare function webinarSurveyDelete({ pathParams, config, }?: {
|
|
3718
|
-
pathParams: {
|
|
3719
|
-
webinarId: bigint;
|
|
3720
|
-
};
|
|
3721
|
-
config?: Partial<FetcherConfig> & {
|
|
3722
|
-
client?: typeof client;
|
|
3723
|
-
};
|
|
3724
|
-
}): Promise<unknown>;
|
|
3725
|
-
/**
|
|
3726
|
-
* @summary Update a webinar survey
|
|
3727
|
-
* @description 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.
|
|
3728
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:write`,`webinar:write:admin`
|
|
3729
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:update:survey`,`webinar:update:survey:admin`
|
|
3730
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3731
|
-
* @link /webinars/{webinarId}/survey
|
|
3732
|
-
*/
|
|
3733
|
-
declare function webinarSurveyUpdate({ pathParams, body, config, }?: {
|
|
3734
|
-
pathParams: {
|
|
3735
|
-
webinarId: bigint;
|
|
3736
|
-
};
|
|
3737
|
-
body?: WebinarSurveyUpdateBody;
|
|
3738
|
-
config?: Partial<FetcherConfig> & {
|
|
3739
|
-
client?: typeof client;
|
|
3740
|
-
};
|
|
3741
|
-
}): Promise<unknown>;
|
|
3742
|
-
/**
|
|
3743
|
-
* @summary Get webinar's token
|
|
3744
|
-
* @description Use this API to get a webinar's [closed caption token (caption URL)](https://support.zoom.us/hc/en-us/articles/115002212983-Using-a-third-party-closed-captioning-service). This token lets you use a third-party service to stream text to their closed captioning software to the Zoom webinar.
|
|
3745
|
-
* **Prerequisites:**
|
|
3746
|
-
* * A Pro or higher plan with the Webinar add-on.
|
|
3747
|
-
* * The **Closed captioning** setting enabled in the Zoom web portal.
|
|
3748
|
-
* *
|
|
3749
|
-
* * The **Allow use of caption API Token to integrate with 3rd-party Closed Captioning services** setting enabled.
|
|
3750
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read`,`webinar:read:admin`
|
|
3751
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:token`,`webinar:read:token:admin`
|
|
3752
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
3753
|
-
* @link /webinars/{webinarId}/token
|
|
3754
|
-
*/
|
|
3755
|
-
declare function webinarToken({ pathParams, queryParams, config, }?: {
|
|
3756
|
-
pathParams: {
|
|
3757
|
-
webinarId: bigint;
|
|
3758
|
-
};
|
|
3759
|
-
queryParams?: {
|
|
3760
|
-
type?: "closed_caption_token";
|
|
3761
|
-
};
|
|
3762
|
-
config?: Partial<FetcherConfig> & {
|
|
3763
|
-
client?: typeof client;
|
|
3764
|
-
};
|
|
3765
|
-
}): Promise<unknown>;
|
|
3766
|
-
/**
|
|
3767
|
-
* @summary Get webinar tracking sources
|
|
3768
|
-
* @description [Webinar Registration Tracking Sources](https://support.zoom.us/hc/en-us/articles/360000315683-Webinar-Registration-Source-Tracking) allow you to see where your registrants are coming from if you share the webinar registration page in multiple platforms. You can then use the source tracking to see the number of registrants generated from each platform.
|
|
3769
|
-
* Use this API to list information on all the tracking sources of a Webinar.
|
|
3770
|
-
* **Prerequisites**:
|
|
3771
|
-
* * [Webinar license](https://zoom.us/webinar).
|
|
3772
|
-
* * Registration must be required for the Webinar.
|
|
3773
|
-
* **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:admin`,`webinar:read`
|
|
3774
|
-
* **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `webinar:read:list_tracking_sources`,`webinar:read:list_tracking_sources:admin`
|
|
3775
|
-
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
3776
|
-
* @link /webinars/{webinarId}/tracking_sources
|
|
3777
|
-
*/
|
|
3778
|
-
declare function getTrackingSources({ pathParams, config, }?: {
|
|
3779
|
-
pathParams: {
|
|
3780
|
-
webinarId: bigint;
|
|
3781
|
-
};
|
|
3782
|
-
config?: Partial<FetcherConfig> & {
|
|
3783
|
-
client?: typeof client;
|
|
3784
|
-
};
|
|
3785
|
-
}): Promise<unknown>;
|
|
3786
|
-
declare const operationsByPath: {
|
|
3787
|
-
"GET /archive_files": typeof listArchivedFiles;
|
|
3788
|
-
"GET /archive_files/download_audit": typeof listArchiveFileDownloadAudit;
|
|
3789
|
-
"GET /archive_files/statistics": typeof getArchivedFileStatistics;
|
|
3790
|
-
"PATCH /archive_files/{fileId}": typeof updateArchivedFile;
|
|
3791
|
-
"GET /meetings/{meetingId}/jointoken/local_archiving": typeof meetingLocalArchivingArchiveToken;
|
|
3792
|
-
"GET /past_meetings/{meetingUUID}/archive_files": typeof getArchivedFiles;
|
|
3793
|
-
"DELETE /past_meetings/{meetingUUID}/archive_files": typeof deleteArchivedFiles;
|
|
3794
|
-
"GET /meetings/{meetingId}/recordings": typeof recordingGet;
|
|
3795
|
-
"DELETE /meetings/{meetingId}/recordings": typeof recordingDelete;
|
|
3796
|
-
"GET /meetings/{meetingId}/recordings/analytics_details": typeof analyticsDetails;
|
|
3797
|
-
"GET /meetings/{meetingId}/recordings/analytics_summary": typeof analyticsSummary;
|
|
3798
|
-
"GET /meetings/{meetingId}/recordings/registrants": typeof meetingRecordingRegistrants;
|
|
3799
|
-
"POST /meetings/{meetingId}/recordings/registrants": typeof meetingRecordingRegistrantCreate;
|
|
3800
|
-
"GET /meetings/{meetingId}/recordings/registrants/questions": typeof recordingRegistrantsQuestionsGet;
|
|
3801
|
-
"PATCH /meetings/{meetingId}/recordings/registrants/questions": typeof recordingRegistrantQuestionUpdate;
|
|
3802
|
-
"PUT /meetings/{meetingId}/recordings/registrants/status": typeof meetingRecordingRegistrantStatus;
|
|
3803
|
-
"GET /meetings/{meetingId}/recordings/settings": typeof recordingSettingUpdate;
|
|
3804
|
-
"PATCH /meetings/{meetingId}/recordings/settings": typeof recordingSettingsUpdate;
|
|
3805
|
-
"DELETE /meetings/{meetingId}/recordings/{recordingId}": typeof recordingDeleteOne;
|
|
3806
|
-
"PUT /meetings/{meetingId}/recordings/{recordingId}/status": typeof recordingStatusUpdateOne;
|
|
3807
|
-
"PUT /meetings/{meetingUUID}/recordings/status": typeof recordingStatusUpdate;
|
|
3808
|
-
"GET /users/{userId}/recordings": typeof recordingsList;
|
|
3809
|
-
"GET /devices": typeof listDevices;
|
|
3810
|
-
"POST /devices": typeof addDevice;
|
|
3811
|
-
"GET /devices/groups": typeof getzdmgroupinfo;
|
|
3812
|
-
"POST /devices/zpa/assignment": typeof assigndevicetoauserCommonarea;
|
|
3813
|
-
"GET /devices/zpa/settings": typeof getZpaDeviceListProfileSettingOfaUser;
|
|
3814
|
-
"POST /devices/zpa/upgrade": typeof upgradeZpasApp;
|
|
3815
|
-
"DELETE /devices/zpa/vendors/{vendor}/mac_addresses/{macAddress}": typeof deleteZpaDeviceByVendorAndMacAddress;
|
|
3816
|
-
"GET /devices/zpa/zdm_groups/{zdmGroupId}/versions": typeof getZpaVersioninfo;
|
|
3817
|
-
"GET /devices/{deviceId}": typeof getDevice;
|
|
3818
|
-
"DELETE /devices/{deviceId}": typeof deleteDevice;
|
|
3819
|
-
"PATCH /devices/{deviceId}": typeof updateDevice;
|
|
3820
|
-
"PATCH /devices/{deviceId}/assign_group": typeof assginGroup;
|
|
3821
|
-
"PATCH /devices/{deviceId}/assignment": typeof changeDeviceAssociation;
|
|
3822
|
-
"GET /h323/devices": typeof deviceList;
|
|
3823
|
-
"POST /h323/devices": typeof deviceCreate;
|
|
3824
|
-
"DELETE /h323/devices/{deviceId}": typeof deviceDelete;
|
|
3825
|
-
"PATCH /h323/devices/{deviceId}": typeof deviceUpdate;
|
|
3826
|
-
"POST /meetings/{meetingId}/open_apps": typeof meetingAppAdd;
|
|
3827
|
-
"DELETE /meetings/{meetingId}/open_apps": typeof meetingAppDelete;
|
|
3828
|
-
"DELETE /live_meetings/{meetingId}/chat/messages/{messageId}": typeof deleteMeetingChatMessageById;
|
|
3829
|
-
"PATCH /live_meetings/{meetingId}/chat/messages/{messageId}": typeof updateMeetingChatMessageById;
|
|
3830
|
-
"PATCH /live_meetings/{meetingId}/events": typeof inMeetingControl;
|
|
3831
|
-
"GET /meetings/{meetingId}/jointoken/local_recording": typeof meetingLocalRecordingJoinToken;
|
|
3832
|
-
"GET /meetings/{meetingId}/token": typeof meetingToken;
|
|
3833
|
-
"POST /meetings/{meetingId}/batch_registrants": typeof addBatchRegistrants;
|
|
3834
|
-
"GET /meetings/{meetingId}/invitation": typeof meetingInvitation;
|
|
3835
|
-
"POST /meetings/{meetingId}/invite_links": typeof meetingInviteLinksCreate;
|
|
3836
|
-
"GET /meetings/{meetingId}/registrants": typeof meetingRegistrants;
|
|
3837
|
-
"POST /meetings/{meetingId}/registrants": typeof meetingRegistrantCreate;
|
|
3838
|
-
"GET /meetings/{meetingId}/registrants/questions": typeof meetingRegistrantsQuestionsGet;
|
|
3839
|
-
"PATCH /meetings/{meetingId}/registrants/questions": typeof meetingRegistrantQuestionUpdate;
|
|
3840
|
-
"PUT /meetings/{meetingId}/registrants/status": typeof meetingRegistrantStatus;
|
|
3841
|
-
"GET /meetings/{meetingId}/registrants/{registrantId}": typeof meetingRegistrantGet;
|
|
3842
|
-
"DELETE /meetings/{meetingId}/registrants/{registrantId}": typeof meetingregistrantdelete;
|
|
3843
|
-
"GET /meetings/{meetingId}/jointoken/live_streaming": typeof meetingLiveStreamingJoinToken;
|
|
3844
|
-
"GET /meetings/{meetingId}/livestream": typeof getMeetingLiveStreamDetails;
|
|
3845
|
-
"PATCH /meetings/{meetingId}/livestream": typeof meetingLiveStreamUpdate;
|
|
3846
|
-
"PATCH /meetings/{meetingId}/livestream/status": typeof meetingLiveStreamStatusUpdate;
|
|
3847
|
-
"GET /meetings/{meetingId}/transcript": typeof getMeetingTranscript;
|
|
3848
|
-
"DELETE /meetings/{meetingId}/transcript": typeof deleteMeetingTranscript;
|
|
3849
|
-
"PATCH /live_meetings/{meetingId}/rtms_app/status": typeof meetingRTMSStatusUpdate;
|
|
3850
|
-
"GET /meetings/{meetingId}": typeof meeting;
|
|
3851
|
-
"DELETE /meetings/{meetingId}": typeof meetingDelete;
|
|
3852
|
-
"PATCH /meetings/{meetingId}": typeof meetingUpdate;
|
|
3853
|
-
"POST /meetings/{meetingId}/sip_dialing": typeof getSipDialingWithPasscode;
|
|
3854
|
-
"PUT /meetings/{meetingId}/status": typeof meetingStatus;
|
|
3855
|
-
"GET /past_meetings/{meetingId}": typeof pastMeetingDetails;
|
|
3856
|
-
"GET /past_meetings/{meetingId}/instances": typeof pastMeetings;
|
|
3857
|
-
"GET /past_meetings/{meetingId}/participants": typeof pastMeetingParticipants;
|
|
3858
|
-
"GET /past_meetings/{meetingId}/qa": typeof listPastMeetingQA;
|
|
3859
|
-
"GET /users/{userId}/meetings": typeof meetings;
|
|
3860
|
-
"POST /users/{userId}/meetings": typeof meetingCreate;
|
|
3861
|
-
"GET /users/{userId}/upcoming_meetings": typeof listUpcomingMeeting;
|
|
3862
|
-
"GET /users/{userId}/pac": typeof userPACs;
|
|
3863
|
-
"POST /meetings/{meetingId}/batch_polls": typeof createBatchPolls;
|
|
3864
|
-
"GET /meetings/{meetingId}/polls": typeof meetingPolls;
|
|
3865
|
-
"POST /meetings/{meetingId}/polls": typeof meetingPollCreate;
|
|
3866
|
-
"GET /meetings/{meetingId}/polls/{pollId}": typeof meetingPollGet;
|
|
3867
|
-
"PUT /meetings/{meetingId}/polls/{pollId}": typeof meetingPollUpdate;
|
|
3868
|
-
"DELETE /meetings/{meetingId}/polls/{pollId}": typeof meetingPollDelete;
|
|
3869
|
-
"GET /past_meetings/{meetingId}/polls": typeof listPastMeetingPolls;
|
|
3870
|
-
"GET /report/activities": typeof reportSignInSignOutActivities;
|
|
3871
|
-
"GET /report/billing": typeof getBillingReport;
|
|
3872
|
-
"GET /report/billing/invoices": typeof getBillingInvoicesReports;
|
|
3873
|
-
"GET /report/cloud_recording": typeof reportCloudRecording;
|
|
3874
|
-
"GET /report/daily": typeof reportDaily;
|
|
3875
|
-
"GET /report/disclaimer": typeof getdisclaimerreport;
|
|
3876
|
-
"GET /report/history_meetings": typeof gethistorymeetingandwebinarlist;
|
|
3877
|
-
"GET /report/meeting_activities": typeof reportMeetingactivitylogs;
|
|
3878
|
-
"GET /report/meetings/{meetingId}": typeof reportMeetingDetails;
|
|
3879
|
-
"GET /report/meetings/{meetingId}/participants": typeof reportMeetingParticipants;
|
|
3880
|
-
"GET /report/meetings/{meetingId}/polls": typeof reportMeetingPolls;
|
|
3881
|
-
"GET /report/meetings/{meetingId}/qa": typeof reportMeetingQA;
|
|
3882
|
-
"GET /report/meetings/{meetingId}/survey": typeof reportMeetingSurvey;
|
|
3883
|
-
"GET /report/operationlogs": typeof reportOperationLogs;
|
|
3884
|
-
"GET /report/remote_support": typeof getremotesupportreport;
|
|
3885
|
-
"GET /report/telephone": typeof reportTelephone;
|
|
3886
|
-
"GET /report/upcoming_events": typeof reportUpcomingEvents;
|
|
3887
|
-
"GET /report/users": typeof reportUsers;
|
|
3888
|
-
"GET /report/users/{userId}/meetings": typeof reportMeetings;
|
|
3889
|
-
"GET /report/webinars/{webinarId}": typeof reportWebinarDetails;
|
|
3890
|
-
"GET /report/webinars/{webinarId}/participants": typeof reportWebinarParticipants;
|
|
3891
|
-
"GET /report/webinars/{webinarId}/polls": typeof reportWebinarPolls;
|
|
3892
|
-
"GET /report/webinars/{webinarId}/qa": typeof reportWebinarQA;
|
|
3893
|
-
"GET /report/webinars/{webinarId}/survey": typeof reportWebinarSurvey;
|
|
3894
|
-
"GET /sip_phones/phones": typeof listSIPPhonePhones;
|
|
3895
|
-
"POST /sip_phones/phones": typeof enableSIPPhonePhones;
|
|
3896
|
-
"DELETE /sip_phones/phones/{phoneId}": typeof deleteSIPPhonePhones;
|
|
3897
|
-
"PATCH /sip_phones/phones/{phoneId}": typeof updateSIPPhonePhones;
|
|
3898
|
-
"GET /meetings/meeting_summaries": typeof listmeetingsummaries;
|
|
3899
|
-
"GET /meetings/{meetingId}/meeting_summary": typeof getameetingsummary;
|
|
3900
|
-
"DELETE /meetings/{meetingId}/meeting_summary": typeof deletemeetingorwebinarsummary;
|
|
3901
|
-
"GET /users/{userId}/meeting_summaries": typeof listUserMeetingSummaries;
|
|
3902
|
-
"GET /meetings/{meetingId}/survey": typeof meetingSurveyGet;
|
|
3903
|
-
"DELETE /meetings/{meetingId}/survey": typeof meetingSurveyDelete;
|
|
3904
|
-
"PATCH /meetings/{meetingId}/survey": typeof meetingSurveyUpdate;
|
|
3905
|
-
"GET /tsp": typeof tsp;
|
|
3906
|
-
"PATCH /tsp": typeof tspUpdate;
|
|
3907
|
-
"GET /users/{userId}/tsp": typeof userTSPs;
|
|
3908
|
-
"POST /users/{userId}/tsp": typeof userTSPCreate;
|
|
3909
|
-
"PATCH /users/{userId}/tsp/settings": typeof tspUrlUpdate;
|
|
3910
|
-
"GET /users/{userId}/tsp/{tspId}": typeof userTSP;
|
|
3911
|
-
"DELETE /users/{userId}/tsp/{tspId}": typeof userTSPDelete;
|
|
3912
|
-
"PATCH /users/{userId}/tsp/{tspId}": typeof userTSPUpdate;
|
|
3913
|
-
"GET /users/{userId}/meeting_templates": typeof listMeetingTemplates;
|
|
3914
|
-
"POST /users/{userId}/meeting_templates": typeof meetingTemplateCreate;
|
|
3915
|
-
"GET /tracking_fields": typeof trackingfieldList;
|
|
3916
|
-
"POST /tracking_fields": typeof trackingfieldCreate;
|
|
3917
|
-
"GET /tracking_fields/{fieldId}": typeof trackingfieldGet;
|
|
3918
|
-
"DELETE /tracking_fields/{fieldId}": typeof trackingfieldDelete;
|
|
3919
|
-
"PATCH /tracking_fields/{fieldId}": typeof trackingfieldUpdate;
|
|
3920
|
-
"DELETE /live_webinars/{webinarId}/chat/messages/{messageId}": typeof deleteWebinarChatMessageById;
|
|
3921
|
-
"GET /past_webinars/{webinarId}/absentees": typeof webinarAbsentees;
|
|
3922
|
-
"GET /past_webinars/{webinarId}/instances": typeof pastWebinars;
|
|
3923
|
-
"GET /past_webinars/{webinarId}/participants": typeof listWebinarParticipants;
|
|
3924
|
-
"GET /past_webinars/{webinarId}/polls": typeof listPastWebinarPollResults;
|
|
3925
|
-
"GET /past_webinars/{webinarId}/qa": typeof listPastWebinarQA;
|
|
3926
|
-
"GET /users/{userId}/webinar_templates": typeof listWebinarTemplates;
|
|
3927
|
-
"POST /users/{userId}/webinar_templates": typeof webinarTemplateCreate;
|
|
3928
|
-
"GET /users/{userId}/webinars": typeof webinars;
|
|
3929
|
-
"POST /users/{userId}/webinars": typeof webinarCreate;
|
|
3930
|
-
"GET /webinars/{webinarId}": typeof webinar;
|
|
3931
|
-
"DELETE /webinars/{webinarId}": typeof webinarDelete;
|
|
3932
|
-
"PATCH /webinars/{webinarId}": typeof webinarUpdate;
|
|
3933
|
-
"POST /webinars/{webinarId}/batch_registrants": typeof addBatchWebinarRegistrants;
|
|
3934
|
-
"GET /webinars/{webinarId}/branding": typeof getWebinarBranding;
|
|
3935
|
-
"POST /webinars/{webinarId}/branding/name_tags": typeof createWebinarBrandingNameTag;
|
|
3936
|
-
"DELETE /webinars/{webinarId}/branding/name_tags": typeof deleteWebinarBrandingNameTag;
|
|
3937
|
-
"PATCH /webinars/{webinarId}/branding/name_tags/{nameTagId}": typeof updateWebinarBrandingNameTag;
|
|
3938
|
-
"POST /webinars/{webinarId}/branding/virtual_backgrounds": typeof uploadWebinarBrandingVB;
|
|
3939
|
-
"DELETE /webinars/{webinarId}/branding/virtual_backgrounds": typeof deleteWebinarBrandingVB;
|
|
3940
|
-
"PATCH /webinars/{webinarId}/branding/virtual_backgrounds": typeof setWebinarBrandingVB;
|
|
3941
|
-
"POST /webinars/{webinarId}/branding/wallpaper": typeof uploadWebinarBrandingWallpaper;
|
|
3942
|
-
"DELETE /webinars/{webinarId}/branding/wallpaper": typeof deleteWebinarBrandingWallpaper;
|
|
3943
|
-
"POST /webinars/{webinarId}/invite_links": typeof webinarInviteLinksCreate;
|
|
3944
|
-
"GET /webinars/{webinarId}/jointoken/live_streaming": typeof webinarLiveStreamingJoinToken;
|
|
3945
|
-
"GET /webinars/{webinarId}/jointoken/local_archiving": typeof webinarLocalArchivingArchiveToken;
|
|
3946
|
-
"GET /webinars/{webinarId}/jointoken/local_recording": typeof webinarLocalRecordingJoinToken;
|
|
3947
|
-
"GET /webinars/{webinarId}/livestream": typeof getWebinarLiveStreamDetails;
|
|
3948
|
-
"PATCH /webinars/{webinarId}/livestream": typeof webinarLiveStreamUpdate;
|
|
3949
|
-
"PATCH /webinars/{webinarId}/livestream/status": typeof webinarLiveStreamStatusUpdate;
|
|
3950
|
-
"GET /webinars/{webinarId}/panelists": typeof webinarPanelists;
|
|
3951
|
-
"POST /webinars/{webinarId}/panelists": typeof webinarPanelistCreate;
|
|
3952
|
-
"DELETE /webinars/{webinarId}/panelists": typeof webinarPanelistsDelete;
|
|
3953
|
-
"DELETE /webinars/{webinarId}/panelists/{panelistId}": typeof webinarPanelistDelete;
|
|
3954
|
-
"GET /webinars/{webinarId}/polls": typeof webinarPolls;
|
|
3955
|
-
"POST /webinars/{webinarId}/polls": typeof webinarPollCreate;
|
|
3956
|
-
"GET /webinars/{webinarId}/polls/{pollId}": typeof webinarPollGet;
|
|
3957
|
-
"PUT /webinars/{webinarId}/polls/{pollId}": typeof webinarPollUpdate;
|
|
3958
|
-
"DELETE /webinars/{webinarId}/polls/{pollId}": typeof webinarPollDelete;
|
|
3959
|
-
"GET /webinars/{webinarId}/registrants": typeof webinarRegistrants;
|
|
3960
|
-
"POST /webinars/{webinarId}/registrants": typeof webinarRegistrantCreate;
|
|
3961
|
-
"GET /webinars/{webinarId}/registrants/questions": typeof webinarRegistrantsQuestionsGet;
|
|
3962
|
-
"PATCH /webinars/{webinarId}/registrants/questions": typeof webinarRegistrantQuestionUpdate;
|
|
3963
|
-
"PUT /webinars/{webinarId}/registrants/status": typeof webinarRegistrantStatus;
|
|
3964
|
-
"GET /webinars/{webinarId}/registrants/{registrantId}": typeof webinarRegistrantGet;
|
|
3965
|
-
"DELETE /webinars/{webinarId}/registrants/{registrantId}": typeof deleteWebinarRegistrant;
|
|
3966
|
-
"POST /webinars/{webinarId}/sip_dialing": typeof getWebinarSipDialingWithPasscode;
|
|
3967
|
-
"PUT /webinars/{webinarId}/status": typeof webinarStatus;
|
|
3968
|
-
"GET /webinars/{webinarId}/survey": typeof webinarSurveyGet;
|
|
3969
|
-
"DELETE /webinars/{webinarId}/survey": typeof webinarSurveyDelete;
|
|
3970
|
-
"PATCH /webinars/{webinarId}/survey": typeof webinarSurveyUpdate;
|
|
3971
|
-
"GET /webinars/{webinarId}/token": typeof webinarToken;
|
|
3972
|
-
"GET /webinars/{webinarId}/tracking_sources": typeof getTrackingSources;
|
|
3973
|
-
};
|
|
3974
|
-
declare const operationsByTag: {
|
|
3975
|
-
archiving: {
|
|
3976
|
-
listArchivedFiles: typeof listArchivedFiles;
|
|
3977
|
-
listArchiveFileDownloadAudit: typeof listArchiveFileDownloadAudit;
|
|
3978
|
-
getArchivedFileStatistics: typeof getArchivedFileStatistics;
|
|
3979
|
-
updateArchivedFile: typeof updateArchivedFile;
|
|
3980
|
-
meetingLocalArchivingArchiveToken: typeof meetingLocalArchivingArchiveToken;
|
|
3981
|
-
getArchivedFiles: typeof getArchivedFiles;
|
|
3982
|
-
deleteArchivedFiles: typeof deleteArchivedFiles;
|
|
3983
|
-
};
|
|
3984
|
-
cloudRecording: {
|
|
3985
|
-
recordingGet: typeof recordingGet;
|
|
3986
|
-
recordingDelete: typeof recordingDelete;
|
|
3987
|
-
analyticsDetails: typeof analyticsDetails;
|
|
3988
|
-
analyticsSummary: typeof analyticsSummary;
|
|
3989
|
-
meetingRecordingRegistrants: typeof meetingRecordingRegistrants;
|
|
3990
|
-
meetingRecordingRegistrantCreate: typeof meetingRecordingRegistrantCreate;
|
|
3991
|
-
recordingRegistrantsQuestionsGet: typeof recordingRegistrantsQuestionsGet;
|
|
3992
|
-
recordingRegistrantQuestionUpdate: typeof recordingRegistrantQuestionUpdate;
|
|
3993
|
-
meetingRecordingRegistrantStatus: typeof meetingRecordingRegistrantStatus;
|
|
3994
|
-
recordingSettingUpdate: typeof recordingSettingUpdate;
|
|
3995
|
-
recordingSettingsUpdate: typeof recordingSettingsUpdate;
|
|
3996
|
-
recordingDeleteOne: typeof recordingDeleteOne;
|
|
3997
|
-
recordingStatusUpdateOne: typeof recordingStatusUpdateOne;
|
|
3998
|
-
recordingStatusUpdate: typeof recordingStatusUpdate;
|
|
3999
|
-
recordingsList: typeof recordingsList;
|
|
4000
|
-
};
|
|
4001
|
-
devices: {
|
|
4002
|
-
listDevices: typeof listDevices;
|
|
4003
|
-
addDevice: typeof addDevice;
|
|
4004
|
-
getzdmgroupinfo: typeof getzdmgroupinfo;
|
|
4005
|
-
assigndevicetoauserCommonarea: typeof assigndevicetoauserCommonarea;
|
|
4006
|
-
getZpaDeviceListProfileSettingOfaUser: typeof getZpaDeviceListProfileSettingOfaUser;
|
|
4007
|
-
upgradeZpasApp: typeof upgradeZpasApp;
|
|
4008
|
-
deleteZpaDeviceByVendorAndMacAddress: typeof deleteZpaDeviceByVendorAndMacAddress;
|
|
4009
|
-
getZpaVersioninfo: typeof getZpaVersioninfo;
|
|
4010
|
-
getDevice: typeof getDevice;
|
|
4011
|
-
deleteDevice: typeof deleteDevice;
|
|
4012
|
-
updateDevice: typeof updateDevice;
|
|
4013
|
-
assginGroup: typeof assginGroup;
|
|
4014
|
-
changeDeviceAssociation: typeof changeDeviceAssociation;
|
|
4015
|
-
};
|
|
4016
|
-
h323Devices: {
|
|
4017
|
-
deviceList: typeof deviceList;
|
|
4018
|
-
deviceCreate: typeof deviceCreate;
|
|
4019
|
-
deviceDelete: typeof deviceDelete;
|
|
4020
|
-
deviceUpdate: typeof deviceUpdate;
|
|
4021
|
-
};
|
|
4022
|
-
inMeetingApps: {
|
|
4023
|
-
meetingAppAdd: typeof meetingAppAdd;
|
|
4024
|
-
meetingAppDelete: typeof meetingAppDelete;
|
|
4025
|
-
};
|
|
4026
|
-
inMeetingFeatures: {
|
|
4027
|
-
deleteMeetingChatMessageById: typeof deleteMeetingChatMessageById;
|
|
4028
|
-
updateMeetingChatMessageById: typeof updateMeetingChatMessageById;
|
|
4029
|
-
inMeetingControl: typeof inMeetingControl;
|
|
4030
|
-
meetingLocalRecordingJoinToken: typeof meetingLocalRecordingJoinToken;
|
|
4031
|
-
meetingToken: typeof meetingToken;
|
|
4032
|
-
};
|
|
4033
|
-
invitationRegistration: {
|
|
4034
|
-
addBatchRegistrants: typeof addBatchRegistrants;
|
|
4035
|
-
meetingInvitation: typeof meetingInvitation;
|
|
4036
|
-
meetingInviteLinksCreate: typeof meetingInviteLinksCreate;
|
|
4037
|
-
meetingRegistrants: typeof meetingRegistrants;
|
|
4038
|
-
meetingRegistrantCreate: typeof meetingRegistrantCreate;
|
|
4039
|
-
meetingRegistrantsQuestionsGet: typeof meetingRegistrantsQuestionsGet;
|
|
4040
|
-
meetingRegistrantQuestionUpdate: typeof meetingRegistrantQuestionUpdate;
|
|
4041
|
-
meetingRegistrantStatus: typeof meetingRegistrantStatus;
|
|
4042
|
-
meetingRegistrantGet: typeof meetingRegistrantGet;
|
|
4043
|
-
meetingregistrantdelete: typeof meetingregistrantdelete;
|
|
4044
|
-
};
|
|
4045
|
-
liveStreaming: {
|
|
4046
|
-
meetingLiveStreamingJoinToken: typeof meetingLiveStreamingJoinToken;
|
|
4047
|
-
getMeetingLiveStreamDetails: typeof getMeetingLiveStreamDetails;
|
|
4048
|
-
meetingLiveStreamUpdate: typeof meetingLiveStreamUpdate;
|
|
4049
|
-
meetingLiveStreamStatusUpdate: typeof meetingLiveStreamStatusUpdate;
|
|
4050
|
-
};
|
|
4051
|
-
meetingTranscript: {
|
|
4052
|
-
getMeetingTranscript: typeof getMeetingTranscript;
|
|
4053
|
-
deleteMeetingTranscript: typeof deleteMeetingTranscript;
|
|
4054
|
-
};
|
|
4055
|
-
meetings: {
|
|
4056
|
-
meetingRTMSStatusUpdate: typeof meetingRTMSStatusUpdate;
|
|
4057
|
-
meeting: typeof meeting;
|
|
4058
|
-
meetingDelete: typeof meetingDelete;
|
|
4059
|
-
meetingUpdate: typeof meetingUpdate;
|
|
4060
|
-
getSipDialingWithPasscode: typeof getSipDialingWithPasscode;
|
|
4061
|
-
meetingStatus: typeof meetingStatus;
|
|
4062
|
-
pastMeetingDetails: typeof pastMeetingDetails;
|
|
4063
|
-
pastMeetings: typeof pastMeetings;
|
|
4064
|
-
pastMeetingParticipants: typeof pastMeetingParticipants;
|
|
4065
|
-
listPastMeetingQA: typeof listPastMeetingQA;
|
|
4066
|
-
meetings: typeof meetings;
|
|
4067
|
-
meetingCreate: typeof meetingCreate;
|
|
4068
|
-
listUpcomingMeeting: typeof listUpcomingMeeting;
|
|
4069
|
-
};
|
|
4070
|
-
pac: {
|
|
4071
|
-
userPACs: typeof userPACs;
|
|
4072
|
-
};
|
|
4073
|
-
polls: {
|
|
4074
|
-
createBatchPolls: typeof createBatchPolls;
|
|
4075
|
-
meetingPolls: typeof meetingPolls;
|
|
4076
|
-
meetingPollCreate: typeof meetingPollCreate;
|
|
4077
|
-
meetingPollGet: typeof meetingPollGet;
|
|
4078
|
-
meetingPollUpdate: typeof meetingPollUpdate;
|
|
4079
|
-
meetingPollDelete: typeof meetingPollDelete;
|
|
4080
|
-
listPastMeetingPolls: typeof listPastMeetingPolls;
|
|
4081
|
-
};
|
|
4082
|
-
reports: {
|
|
4083
|
-
reportSignInSignOutActivities: typeof reportSignInSignOutActivities;
|
|
4084
|
-
getBillingReport: typeof getBillingReport;
|
|
4085
|
-
getBillingInvoicesReports: typeof getBillingInvoicesReports;
|
|
4086
|
-
reportCloudRecording: typeof reportCloudRecording;
|
|
4087
|
-
reportDaily: typeof reportDaily;
|
|
4088
|
-
getdisclaimerreport: typeof getdisclaimerreport;
|
|
4089
|
-
gethistorymeetingandwebinarlist: typeof gethistorymeetingandwebinarlist;
|
|
4090
|
-
reportMeetingactivitylogs: typeof reportMeetingactivitylogs;
|
|
4091
|
-
reportMeetingDetails: typeof reportMeetingDetails;
|
|
4092
|
-
reportMeetingParticipants: typeof reportMeetingParticipants;
|
|
4093
|
-
reportMeetingPolls: typeof reportMeetingPolls;
|
|
4094
|
-
reportMeetingQA: typeof reportMeetingQA;
|
|
4095
|
-
reportMeetingSurvey: typeof reportMeetingSurvey;
|
|
4096
|
-
reportOperationLogs: typeof reportOperationLogs;
|
|
4097
|
-
getremotesupportreport: typeof getremotesupportreport;
|
|
4098
|
-
reportTelephone: typeof reportTelephone;
|
|
4099
|
-
reportUpcomingEvents: typeof reportUpcomingEvents;
|
|
4100
|
-
reportUsers: typeof reportUsers;
|
|
4101
|
-
reportMeetings: typeof reportMeetings;
|
|
4102
|
-
reportWebinarDetails: typeof reportWebinarDetails;
|
|
4103
|
-
reportWebinarParticipants: typeof reportWebinarParticipants;
|
|
4104
|
-
reportWebinarPolls: typeof reportWebinarPolls;
|
|
4105
|
-
reportWebinarQA: typeof reportWebinarQA;
|
|
4106
|
-
reportWebinarSurvey: typeof reportWebinarSurvey;
|
|
4107
|
-
};
|
|
4108
|
-
sipPhone: {
|
|
4109
|
-
listSIPPhonePhones: typeof listSIPPhonePhones;
|
|
4110
|
-
enableSIPPhonePhones: typeof enableSIPPhonePhones;
|
|
4111
|
-
deleteSIPPhonePhones: typeof deleteSIPPhonePhones;
|
|
4112
|
-
updateSIPPhonePhones: typeof updateSIPPhonePhones;
|
|
4113
|
-
};
|
|
4114
|
-
summaries: {
|
|
4115
|
-
listmeetingsummaries: typeof listmeetingsummaries;
|
|
4116
|
-
getameetingsummary: typeof getameetingsummary;
|
|
4117
|
-
deletemeetingorwebinarsummary: typeof deletemeetingorwebinarsummary;
|
|
4118
|
-
listUserMeetingSummaries: typeof listUserMeetingSummaries;
|
|
4119
|
-
};
|
|
4120
|
-
surveys: {
|
|
4121
|
-
meetingSurveyGet: typeof meetingSurveyGet;
|
|
4122
|
-
meetingSurveyDelete: typeof meetingSurveyDelete;
|
|
4123
|
-
meetingSurveyUpdate: typeof meetingSurveyUpdate;
|
|
4124
|
-
};
|
|
4125
|
-
tsp: {
|
|
4126
|
-
tsp: typeof tsp;
|
|
4127
|
-
tspUpdate: typeof tspUpdate;
|
|
4128
|
-
userTSPs: typeof userTSPs;
|
|
4129
|
-
userTSPCreate: typeof userTSPCreate;
|
|
4130
|
-
tspUrlUpdate: typeof tspUrlUpdate;
|
|
4131
|
-
userTSP: typeof userTSP;
|
|
4132
|
-
userTSPDelete: typeof userTSPDelete;
|
|
4133
|
-
userTSPUpdate: typeof userTSPUpdate;
|
|
4134
|
-
};
|
|
4135
|
-
templates: {
|
|
4136
|
-
listMeetingTemplates: typeof listMeetingTemplates;
|
|
4137
|
-
meetingTemplateCreate: typeof meetingTemplateCreate;
|
|
4138
|
-
};
|
|
4139
|
-
trackingField: {
|
|
4140
|
-
trackingfieldList: typeof trackingfieldList;
|
|
4141
|
-
trackingfieldCreate: typeof trackingfieldCreate;
|
|
4142
|
-
trackingfieldGet: typeof trackingfieldGet;
|
|
4143
|
-
trackingfieldDelete: typeof trackingfieldDelete;
|
|
4144
|
-
trackingfieldUpdate: typeof trackingfieldUpdate;
|
|
4145
|
-
};
|
|
4146
|
-
webinars: {
|
|
4147
|
-
deleteWebinarChatMessageById: typeof deleteWebinarChatMessageById;
|
|
4148
|
-
webinarAbsentees: typeof webinarAbsentees;
|
|
4149
|
-
pastWebinars: typeof pastWebinars;
|
|
4150
|
-
listWebinarParticipants: typeof listWebinarParticipants;
|
|
4151
|
-
listPastWebinarPollResults: typeof listPastWebinarPollResults;
|
|
4152
|
-
listPastWebinarQA: typeof listPastWebinarQA;
|
|
4153
|
-
listWebinarTemplates: typeof listWebinarTemplates;
|
|
4154
|
-
webinarTemplateCreate: typeof webinarTemplateCreate;
|
|
4155
|
-
webinars: typeof webinars;
|
|
4156
|
-
webinarCreate: typeof webinarCreate;
|
|
4157
|
-
webinar: typeof webinar;
|
|
4158
|
-
webinarDelete: typeof webinarDelete;
|
|
4159
|
-
webinarUpdate: typeof webinarUpdate;
|
|
4160
|
-
addBatchWebinarRegistrants: typeof addBatchWebinarRegistrants;
|
|
4161
|
-
getWebinarBranding: typeof getWebinarBranding;
|
|
4162
|
-
createWebinarBrandingNameTag: typeof createWebinarBrandingNameTag;
|
|
4163
|
-
deleteWebinarBrandingNameTag: typeof deleteWebinarBrandingNameTag;
|
|
4164
|
-
updateWebinarBrandingNameTag: typeof updateWebinarBrandingNameTag;
|
|
4165
|
-
uploadWebinarBrandingVB: typeof uploadWebinarBrandingVB;
|
|
4166
|
-
deleteWebinarBrandingVB: typeof deleteWebinarBrandingVB;
|
|
4167
|
-
setWebinarBrandingVB: typeof setWebinarBrandingVB;
|
|
4168
|
-
uploadWebinarBrandingWallpaper: typeof uploadWebinarBrandingWallpaper;
|
|
4169
|
-
deleteWebinarBrandingWallpaper: typeof deleteWebinarBrandingWallpaper;
|
|
4170
|
-
webinarInviteLinksCreate: typeof webinarInviteLinksCreate;
|
|
4171
|
-
webinarLiveStreamingJoinToken: typeof webinarLiveStreamingJoinToken;
|
|
4172
|
-
webinarLocalArchivingArchiveToken: typeof webinarLocalArchivingArchiveToken;
|
|
4173
|
-
webinarLocalRecordingJoinToken: typeof webinarLocalRecordingJoinToken;
|
|
4174
|
-
getWebinarLiveStreamDetails: typeof getWebinarLiveStreamDetails;
|
|
4175
|
-
webinarLiveStreamUpdate: typeof webinarLiveStreamUpdate;
|
|
4176
|
-
webinarLiveStreamStatusUpdate: typeof webinarLiveStreamStatusUpdate;
|
|
4177
|
-
webinarPanelists: typeof webinarPanelists;
|
|
4178
|
-
webinarPanelistCreate: typeof webinarPanelistCreate;
|
|
4179
|
-
webinarPanelistsDelete: typeof webinarPanelistsDelete;
|
|
4180
|
-
webinarPanelistDelete: typeof webinarPanelistDelete;
|
|
4181
|
-
webinarPolls: typeof webinarPolls;
|
|
4182
|
-
webinarPollCreate: typeof webinarPollCreate;
|
|
4183
|
-
webinarPollGet: typeof webinarPollGet;
|
|
4184
|
-
webinarPollUpdate: typeof webinarPollUpdate;
|
|
4185
|
-
webinarPollDelete: typeof webinarPollDelete;
|
|
4186
|
-
webinarRegistrants: typeof webinarRegistrants;
|
|
4187
|
-
webinarRegistrantCreate: typeof webinarRegistrantCreate;
|
|
4188
|
-
webinarRegistrantsQuestionsGet: typeof webinarRegistrantsQuestionsGet;
|
|
4189
|
-
webinarRegistrantQuestionUpdate: typeof webinarRegistrantQuestionUpdate;
|
|
4190
|
-
webinarRegistrantStatus: typeof webinarRegistrantStatus;
|
|
4191
|
-
webinarRegistrantGet: typeof webinarRegistrantGet;
|
|
4192
|
-
deleteWebinarRegistrant: typeof deleteWebinarRegistrant;
|
|
4193
|
-
getWebinarSipDialingWithPasscode: typeof getWebinarSipDialingWithPasscode;
|
|
4194
|
-
webinarStatus: typeof webinarStatus;
|
|
4195
|
-
webinarSurveyGet: typeof webinarSurveyGet;
|
|
4196
|
-
webinarSurveyDelete: typeof webinarSurveyDelete;
|
|
4197
|
-
webinarSurveyUpdate: typeof webinarSurveyUpdate;
|
|
4198
|
-
webinarToken: typeof webinarToken;
|
|
4199
|
-
getTrackingSources: typeof getTrackingSources;
|
|
4200
|
-
};
|
|
4201
|
-
};
|
|
4202
|
-
declare const tagDictionary: {
|
|
4203
|
-
readonly archiving: {
|
|
4204
|
-
readonly GET: readonly ["listArchivedFiles", "listArchiveFileDownloadAudit", "getArchivedFileStatistics", "meetingLocalArchivingArchiveToken", "getArchivedFiles"];
|
|
4205
|
-
readonly PATCH: readonly ["updateArchivedFile"];
|
|
4206
|
-
readonly DELETE: readonly ["deleteArchivedFiles"];
|
|
4207
|
-
};
|
|
4208
|
-
readonly cloudRecording: {
|
|
4209
|
-
readonly GET: readonly ["recordingGet", "analyticsDetails", "analyticsSummary", "meetingRecordingRegistrants", "recordingRegistrantsQuestionsGet", "recordingSettingUpdate", "recordingsList"];
|
|
4210
|
-
readonly DELETE: readonly ["recordingDelete", "recordingDeleteOne"];
|
|
4211
|
-
readonly POST: readonly ["meetingRecordingRegistrantCreate"];
|
|
4212
|
-
readonly PATCH: readonly ["recordingRegistrantQuestionUpdate", "recordingSettingsUpdate"];
|
|
4213
|
-
readonly PUT: readonly ["meetingRecordingRegistrantStatus", "recordingStatusUpdateOne", "recordingStatusUpdate"];
|
|
4214
|
-
};
|
|
4215
|
-
readonly devices: {
|
|
4216
|
-
readonly GET: readonly ["listDevices", "getzdmgroupinfo", "getZpaDeviceListProfileSettingOfaUser", "getZpaVersioninfo", "getDevice"];
|
|
4217
|
-
readonly POST: readonly ["addDevice", "assigndevicetoauserCommonarea", "upgradeZpasApp"];
|
|
4218
|
-
readonly DELETE: readonly ["deleteZpaDeviceByVendorAndMacAddress", "deleteDevice"];
|
|
4219
|
-
readonly PATCH: readonly ["updateDevice", "assginGroup", "changeDeviceAssociation"];
|
|
4220
|
-
};
|
|
4221
|
-
readonly h323Devices: {
|
|
4222
|
-
readonly GET: readonly ["deviceList"];
|
|
4223
|
-
readonly POST: readonly ["deviceCreate"];
|
|
4224
|
-
readonly DELETE: readonly ["deviceDelete"];
|
|
4225
|
-
readonly PATCH: readonly ["deviceUpdate"];
|
|
4226
|
-
};
|
|
4227
|
-
readonly inMeetingApps: {
|
|
4228
|
-
readonly POST: readonly ["meetingAppAdd"];
|
|
4229
|
-
readonly DELETE: readonly ["meetingAppDelete"];
|
|
4230
|
-
};
|
|
4231
|
-
readonly inMeetingFeatures: {
|
|
4232
|
-
readonly DELETE: readonly ["deleteMeetingChatMessageById"];
|
|
4233
|
-
readonly PATCH: readonly ["updateMeetingChatMessageById", "inMeetingControl"];
|
|
4234
|
-
readonly GET: readonly ["meetingLocalRecordingJoinToken", "meetingToken"];
|
|
4235
|
-
};
|
|
4236
|
-
readonly invitationRegistration: {
|
|
4237
|
-
readonly POST: readonly ["addBatchRegistrants", "meetingInviteLinksCreate", "meetingRegistrantCreate"];
|
|
4238
|
-
readonly GET: readonly ["meetingInvitation", "meetingRegistrants", "meetingRegistrantsQuestionsGet", "meetingRegistrantGet"];
|
|
4239
|
-
readonly PATCH: readonly ["meetingRegistrantQuestionUpdate"];
|
|
4240
|
-
readonly PUT: readonly ["meetingRegistrantStatus"];
|
|
4241
|
-
readonly DELETE: readonly ["meetingregistrantdelete"];
|
|
4242
|
-
};
|
|
4243
|
-
readonly liveStreaming: {
|
|
4244
|
-
readonly GET: readonly ["meetingLiveStreamingJoinToken", "getMeetingLiveStreamDetails"];
|
|
4245
|
-
readonly PATCH: readonly ["meetingLiveStreamUpdate", "meetingLiveStreamStatusUpdate"];
|
|
4246
|
-
};
|
|
4247
|
-
readonly meetingTranscript: {
|
|
4248
|
-
readonly GET: readonly ["getMeetingTranscript"];
|
|
4249
|
-
readonly DELETE: readonly ["deleteMeetingTranscript"];
|
|
4250
|
-
};
|
|
4251
|
-
readonly meetings: {
|
|
4252
|
-
readonly PATCH: readonly ["meetingRTMSStatusUpdate", "meetingUpdate"];
|
|
4253
|
-
readonly GET: readonly ["meeting", "pastMeetingDetails", "pastMeetings", "pastMeetingParticipants", "listPastMeetingQA", "meetings", "listUpcomingMeeting"];
|
|
4254
|
-
readonly DELETE: readonly ["meetingDelete"];
|
|
4255
|
-
readonly POST: readonly ["getSipDialingWithPasscode", "meetingCreate"];
|
|
4256
|
-
readonly PUT: readonly ["meetingStatus"];
|
|
4257
|
-
};
|
|
4258
|
-
readonly pac: {
|
|
4259
|
-
readonly GET: readonly ["userPACs"];
|
|
4260
|
-
};
|
|
4261
|
-
readonly polls: {
|
|
4262
|
-
readonly POST: readonly ["createBatchPolls", "meetingPollCreate"];
|
|
4263
|
-
readonly GET: readonly ["meetingPolls", "meetingPollGet", "listPastMeetingPolls"];
|
|
4264
|
-
readonly PUT: readonly ["meetingPollUpdate"];
|
|
4265
|
-
readonly DELETE: readonly ["meetingPollDelete"];
|
|
4266
|
-
};
|
|
4267
|
-
readonly reports: {
|
|
4268
|
-
readonly GET: readonly ["reportSignInSignOutActivities", "getBillingReport", "getBillingInvoicesReports", "reportCloudRecording", "reportDaily", "getdisclaimerreport", "gethistorymeetingandwebinarlist", "reportMeetingactivitylogs", "reportMeetingDetails", "reportMeetingParticipants", "reportMeetingPolls", "reportMeetingQA", "reportMeetingSurvey", "reportOperationLogs", "getremotesupportreport", "reportTelephone", "reportUpcomingEvents", "reportUsers", "reportMeetings", "reportWebinarDetails", "reportWebinarParticipants", "reportWebinarPolls", "reportWebinarQA", "reportWebinarSurvey"];
|
|
4269
|
-
};
|
|
4270
|
-
readonly sipPhone: {
|
|
4271
|
-
readonly GET: readonly ["listSIPPhonePhones"];
|
|
4272
|
-
readonly POST: readonly ["enableSIPPhonePhones"];
|
|
4273
|
-
readonly DELETE: readonly ["deleteSIPPhonePhones"];
|
|
4274
|
-
readonly PATCH: readonly ["updateSIPPhonePhones"];
|
|
4275
|
-
};
|
|
4276
|
-
readonly summaries: {
|
|
4277
|
-
readonly GET: readonly ["listmeetingsummaries", "getameetingsummary", "listUserMeetingSummaries"];
|
|
4278
|
-
readonly DELETE: readonly ["deletemeetingorwebinarsummary"];
|
|
4279
|
-
};
|
|
4280
|
-
readonly surveys: {
|
|
4281
|
-
readonly GET: readonly ["meetingSurveyGet"];
|
|
4282
|
-
readonly DELETE: readonly ["meetingSurveyDelete"];
|
|
4283
|
-
readonly PATCH: readonly ["meetingSurveyUpdate"];
|
|
4284
|
-
};
|
|
4285
|
-
readonly tsp: {
|
|
4286
|
-
readonly GET: readonly ["tsp", "userTSPs", "userTSP"];
|
|
4287
|
-
readonly PATCH: readonly ["tspUpdate", "tspUrlUpdate", "userTSPUpdate"];
|
|
4288
|
-
readonly POST: readonly ["userTSPCreate"];
|
|
4289
|
-
readonly DELETE: readonly ["userTSPDelete"];
|
|
4290
|
-
};
|
|
4291
|
-
readonly templates: {
|
|
4292
|
-
readonly GET: readonly ["listMeetingTemplates"];
|
|
4293
|
-
readonly POST: readonly ["meetingTemplateCreate"];
|
|
4294
|
-
};
|
|
4295
|
-
readonly trackingField: {
|
|
4296
|
-
readonly GET: readonly ["trackingfieldList", "trackingfieldGet"];
|
|
4297
|
-
readonly POST: readonly ["trackingfieldCreate"];
|
|
4298
|
-
readonly DELETE: readonly ["trackingfieldDelete"];
|
|
4299
|
-
readonly PATCH: readonly ["trackingfieldUpdate"];
|
|
4300
|
-
};
|
|
4301
|
-
readonly webinars: {
|
|
4302
|
-
readonly DELETE: readonly ["deleteWebinarChatMessageById", "webinarDelete", "deleteWebinarBrandingNameTag", "deleteWebinarBrandingVB", "deleteWebinarBrandingWallpaper", "webinarPanelistsDelete", "webinarPanelistDelete", "webinarPollDelete", "deleteWebinarRegistrant", "webinarSurveyDelete"];
|
|
4303
|
-
readonly GET: readonly ["webinarAbsentees", "pastWebinars", "listWebinarParticipants", "listPastWebinarPollResults", "listPastWebinarQA", "listWebinarTemplates", "webinars", "webinar", "getWebinarBranding", "webinarLiveStreamingJoinToken", "webinarLocalArchivingArchiveToken", "webinarLocalRecordingJoinToken", "getWebinarLiveStreamDetails", "webinarPanelists", "webinarPolls", "webinarPollGet", "webinarRegistrants", "webinarRegistrantsQuestionsGet", "webinarRegistrantGet", "webinarSurveyGet", "webinarToken", "getTrackingSources"];
|
|
4304
|
-
readonly POST: readonly ["webinarTemplateCreate", "webinarCreate", "addBatchWebinarRegistrants", "createWebinarBrandingNameTag", "uploadWebinarBrandingVB", "uploadWebinarBrandingWallpaper", "webinarInviteLinksCreate", "webinarPanelistCreate", "webinarPollCreate", "webinarRegistrantCreate", "getWebinarSipDialingWithPasscode"];
|
|
4305
|
-
readonly PATCH: readonly ["webinarUpdate", "updateWebinarBrandingNameTag", "setWebinarBrandingVB", "webinarLiveStreamUpdate", "webinarLiveStreamStatusUpdate", "webinarRegistrantQuestionUpdate", "webinarSurveyUpdate"];
|
|
4306
|
-
readonly PUT: readonly ["webinarPollUpdate", "webinarRegistrantStatus", "webinarStatus"];
|
|
4307
|
-
};
|
|
4308
|
-
};
|
|
4309
|
-
|
|
4310
|
-
export { addBatchRegistrants, addBatchWebinarRegistrants, addDevice, analyticsDetails, analyticsSummary, assginGroup, assigndevicetoauserCommonarea, changeDeviceAssociation, createBatchPolls, createWebinarBrandingNameTag, deleteArchivedFiles, deleteDevice, deleteMeetingChatMessageById, deleteMeetingTranscript, deleteSIPPhonePhones, deleteWebinarBrandingNameTag, deleteWebinarBrandingVB, deleteWebinarBrandingWallpaper, deleteWebinarChatMessageById, deleteWebinarRegistrant, deleteZpaDeviceByVendorAndMacAddress, deletemeetingorwebinarsummary, deviceCreate, deviceDelete, deviceList, deviceUpdate, enableSIPPhonePhones, getArchivedFileStatistics, getArchivedFiles, getBillingInvoicesReports, getBillingReport, getDevice, getMeetingLiveStreamDetails, getMeetingTranscript, getSipDialingWithPasscode, getTrackingSources, getWebinarBranding, getWebinarLiveStreamDetails, getWebinarSipDialingWithPasscode, getZpaDeviceListProfileSettingOfaUser, getZpaVersioninfo, getameetingsummary, getdisclaimerreport, gethistorymeetingandwebinarlist, getremotesupportreport, getzdmgroupinfo, inMeetingControl, listArchiveFileDownloadAudit, listArchivedFiles, listDevices, listMeetingTemplates, listPastMeetingPolls, listPastMeetingQA, listPastWebinarPollResults, listPastWebinarQA, listSIPPhonePhones, listUpcomingMeeting, listUserMeetingSummaries, listWebinarParticipants, listWebinarTemplates, listmeetingsummaries, meeting, meetingAppAdd, meetingAppDelete, meetingCreate, meetingDelete, meetingInvitation, meetingInviteLinksCreate, meetingLiveStreamStatusUpdate, meetingLiveStreamUpdate, meetingLiveStreamingJoinToken, meetingLocalArchivingArchiveToken, meetingLocalRecordingJoinToken, meetingPollCreate, meetingPollDelete, meetingPollGet, meetingPollUpdate, meetingPolls, meetingRTMSStatusUpdate, meetingRecordingRegistrantCreate, meetingRecordingRegistrantStatus, meetingRecordingRegistrants, meetingRegistrantCreate, meetingRegistrantGet, meetingRegistrantQuestionUpdate, meetingRegistrantStatus, meetingRegistrants, meetingRegistrantsQuestionsGet, meetingStatus, meetingSurveyDelete, meetingSurveyGet, meetingSurveyUpdate, meetingTemplateCreate, meetingToken, meetingUpdate, meetingregistrantdelete, meetings, operationsByPath, operationsByTag, pastMeetingDetails, pastMeetingParticipants, pastMeetings, pastWebinars, recordingDelete, recordingDeleteOne, recordingGet, recordingRegistrantQuestionUpdate, recordingRegistrantsQuestionsGet, recordingSettingUpdate, recordingSettingsUpdate, recordingStatusUpdate, recordingStatusUpdateOne, recordingsList, reportCloudRecording, reportDaily, reportMeetingDetails, reportMeetingParticipants, reportMeetingPolls, reportMeetingQA, reportMeetingSurvey, reportMeetingactivitylogs, reportMeetings, reportOperationLogs, reportSignInSignOutActivities, reportTelephone, reportUpcomingEvents, reportUsers, reportWebinarDetails, reportWebinarParticipants, reportWebinarPolls, reportWebinarQA, reportWebinarSurvey, setWebinarBrandingVB, tagDictionary, trackingfieldCreate, trackingfieldDelete, trackingfieldGet, trackingfieldList, trackingfieldUpdate, tsp, tspUpdate, tspUrlUpdate, updateArchivedFile, updateDevice, updateMeetingChatMessageById, updateSIPPhonePhones, updateWebinarBrandingNameTag, upgradeZpasApp, uploadWebinarBrandingVB, uploadWebinarBrandingWallpaper, userPACs, userTSP, userTSPCreate, userTSPDelete, userTSPUpdate, userTSPs, webinar, webinarAbsentees, webinarCreate, webinarDelete, webinarInviteLinksCreate, webinarLiveStreamStatusUpdate, webinarLiveStreamUpdate, webinarLiveStreamingJoinToken, webinarLocalArchivingArchiveToken, webinarLocalRecordingJoinToken, webinarPanelistCreate, webinarPanelistDelete, webinarPanelists, webinarPanelistsDelete, webinarPollCreate, webinarPollDelete, webinarPollGet, webinarPollUpdate, webinarPolls, webinarRegistrantCreate, webinarRegistrantGet, webinarRegistrantQuestionUpdate, webinarRegistrantStatus, webinarRegistrants, webinarRegistrantsQuestionsGet, webinarStatus, webinarSurveyDelete, webinarSurveyGet, webinarSurveyUpdate, webinarTemplateCreate, webinarToken, webinarUpdate, webinars };
|
|
1
|
+
export { U as addBatchRegistrants, bs as addBatchWebinarRegistrants, x as addDevice, e as analyticsDetails, f as analyticsSummary, H as assginGroup, z as assigndevicetoauserCommonarea, I as changeDeviceAssociation, am as createBatchPolls, bu as createWebinarBrandingNameTag, d as deleteArchivedFiles, F as deleteDevice, P as deleteMeetingChatMessageById, a7 as deleteMeetingTranscript, aT as deleteSIPPhonePhones, bv as deleteWebinarBrandingNameTag, by as deleteWebinarBrandingVB, bB as deleteWebinarBrandingWallpaper, bf as deleteWebinarChatMessageById, bY as deleteWebinarRegistrant, C as deleteZpaDeviceByVendorAndMacAddress, aX as deletemeetingorwebinarsummary, K as deviceCreate, L as deviceDelete, J as deviceList, M as deviceUpdate, aS as enableSIPPhonePhones, g as getArchivedFileStatistics, b as getArchivedFiles, av as getBillingInvoicesReports, au as getBillingReport, E as getDevice, a3 as getMeetingLiveStreamDetails, a6 as getMeetingTranscript, ac as getSipDialingWithPasscode, c3 as getTrackingSources, bt as getWebinarBranding, bG as getWebinarLiveStreamDetails, bZ as getWebinarSipDialingWithPasscode, A as getZpaDeviceListProfileSettingOfaUser, D as getZpaVersioninfo, aW as getameetingsummary, ay as getdisclaimerreport, az as gethistorymeetingandwebinarlist, aH as getremotesupportreport, y as getzdmgroupinfo, R as inMeetingControl, a as listArchiveFileDownloadAudit, l as listArchivedFiles, w as listDevices, b8 as listMeetingTemplates, as as listPastMeetingPolls, ah as listPastMeetingQA, bj as listPastWebinarPollResults, bk as listPastWebinarQA, aR as listSIPPhonePhones, ak as listUpcomingMeeting, aY as listUserMeetingSummaries, bi as listWebinarParticipants, bl as listWebinarTemplates, aV as listmeetingsummaries, a9 as meeting, N as meetingAppAdd, O as meetingAppDelete, aj as meetingCreate, aa as meetingDelete, V as meetingInvitation, W as meetingInviteLinksCreate, a5 as meetingLiveStreamStatusUpdate, a4 as meetingLiveStreamUpdate, a2 as meetingLiveStreamingJoinToken, m as meetingLocalArchivingArchiveToken, S as meetingLocalRecordingJoinToken, ao as meetingPollCreate, ar as meetingPollDelete, ap as meetingPollGet, aq as meetingPollUpdate, an as meetingPolls, a8 as meetingRTMSStatusUpdate, i as meetingRecordingRegistrantCreate, n as meetingRecordingRegistrantStatus, h as meetingRecordingRegistrants, Y as meetingRegistrantCreate, a0 as meetingRegistrantGet, _ as meetingRegistrantQuestionUpdate, $ as meetingRegistrantStatus, X as meetingRegistrants, Z as meetingRegistrantsQuestionsGet, ad as meetingStatus, a_ as meetingSurveyDelete, aZ as meetingSurveyGet, a$ as meetingSurveyUpdate, b9 as meetingTemplateCreate, T as meetingToken, ab as meetingUpdate, a1 as meetingregistrantdelete, ai as meetings, c7 as operationsByPath, c4 as operationsByTag, ae as pastMeetingDetails, ag as pastMeetingParticipants, af as pastMeetings, bh as pastWebinars, c as recordingDelete, q as recordingDeleteOne, r as recordingGet, k as recordingRegistrantQuestionUpdate, j as recordingRegistrantsQuestionsGet, o as recordingSettingUpdate, p as recordingSettingsUpdate, t as recordingStatusUpdate, s as recordingStatusUpdateOne, v as recordingsList, aw as reportCloudRecording, ax as reportDaily, aB as reportMeetingDetails, aC as reportMeetingParticipants, aD as reportMeetingPolls, aE as reportMeetingQA, aF as reportMeetingSurvey, aA as reportMeetingactivitylogs, aL as reportMeetings, aG as reportOperationLogs, at as reportSignInSignOutActivities, aI as reportTelephone, aJ as reportUpcomingEvents, aK as reportUsers, aM as reportWebinarDetails, aN as reportWebinarParticipants, aO as reportWebinarPolls, aP as reportWebinarQA, aQ as reportWebinarSurvey, bz as setWebinarBrandingVB, c5 as tagDictionary, bb as trackingfieldCreate, bd as trackingfieldDelete, bc as trackingfieldGet, ba as trackingfieldList, be as trackingfieldUpdate, b0 as tsp, b1 as tspUpdate, b4 as tspUrlUpdate, u as updateArchivedFile, G as updateDevice, Q as updateMeetingChatMessageById, aU as updateSIPPhonePhones, bw as updateWebinarBrandingNameTag, B as upgradeZpasApp, bx as uploadWebinarBrandingVB, bA as uploadWebinarBrandingWallpaper, al as userPACs, b5 as userTSP, b3 as userTSPCreate, b6 as userTSPDelete, b7 as userTSPUpdate, b2 as userTSPs, bp as webinar, bg as webinarAbsentees, bo as webinarCreate, bq as webinarDelete, bC as webinarInviteLinksCreate, bI as webinarLiveStreamStatusUpdate, bH as webinarLiveStreamUpdate, bD as webinarLiveStreamingJoinToken, bE as webinarLocalArchivingArchiveToken, bF as webinarLocalRecordingJoinToken, bK as webinarPanelistCreate, bM as webinarPanelistDelete, bJ as webinarPanelists, bL as webinarPanelistsDelete, bO as webinarPollCreate, bR as webinarPollDelete, bP as webinarPollGet, bQ as webinarPollUpdate, bN as webinarPolls, bT as webinarRegistrantCreate, bX as webinarRegistrantGet, bV as webinarRegistrantQuestionUpdate, bW as webinarRegistrantStatus, bS as webinarRegistrants, bU as webinarRegistrantsQuestionsGet, b_ as webinarStatus, c0 as webinarSurveyDelete, b$ as webinarSurveyGet, c1 as webinarSurveyUpdate, bm as webinarTemplateCreate, c2 as webinarToken, br as webinarUpdate, bn as webinars } from './components-lqucvmze.js';
|
|
4311
2
|
//# sourceMappingURL=components.d.mts.map
|