zoom-api-js 0.1.3 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +12 -20
- package/CHANGELOG.md +6 -0
- package/dist/{index.js → index.cjs} +15 -55
- package/dist/index.d.cts +27313 -0
- package/dist/index.d.mts +435 -129
- package/dist/index.d.ts +435 -129
- package/dist/index.mjs +14 -30
- package/package.json +6 -10
- package/dist/index.js.map +0 -1
- package/dist/index.mjs.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -149,10 +149,11 @@ type ListArchivedFilesResponse = {
|
|
|
149
149
|
* * `CC` - A file containing the closed captions of the recording, in VTT file format.
|
|
150
150
|
* * `CHAT_MESSAGE` - A JSON file encoded in base64 format containing chat messages. The file also includes waiting room chats, deleted messages, meeting emojis and non-verbal feedback.
|
|
151
151
|
* * `TRANSCRIPT` - A JSON file include audio transcript wording.
|
|
152
|
+
* * `SUB_GROUP_MEMBER_LOG` - A json file containing records of members entering and leaving the subgroup.
|
|
152
153
|
*
|
|
153
154
|
* @example CHAT
|
|
154
155
|
*/
|
|
155
|
-
file_type: 'MP4' | 'M4A' | 'CHAT' | 'CC' | 'CHAT_MESSAGE' | 'TRANSCRIPT';
|
|
156
|
+
file_type: 'MP4' | 'M4A' | 'CHAT' | 'CC' | 'CHAT_MESSAGE' | 'TRANSCRIPT' | 'SUB_GROUP_MEMBER_LOG';
|
|
156
157
|
/**
|
|
157
158
|
* The archive file's unique ID.
|
|
158
159
|
*
|
|
@@ -629,10 +630,11 @@ type GetArchivedFilesResponse = {
|
|
|
629
630
|
* * `CC` - A file containing the closed captions of the recording, in VTT file format.
|
|
630
631
|
* * `CHAT_MESSAGE` - A JSON file encoded in base64 format containing chat messages. The file also includes waiting room chats, deleted messages, meeting emojis and non-verbal feedback.
|
|
631
632
|
* * `TRANSCRIPT` - A JSON file include audio transcript wording.
|
|
633
|
+
* * `SUB_GROUP_MEMBER_LOG` - A JSON file containing records of members entering and leaving the subgroup.
|
|
632
634
|
*
|
|
633
635
|
* @example CHAT
|
|
634
636
|
*/
|
|
635
|
-
file_type: 'MP4' | 'M4A' | 'CHAT' | 'CC' | 'CHAT_MESSAGE' | 'TRANSCRIPT';
|
|
637
|
+
file_type: 'MP4' | 'M4A' | 'CHAT' | 'CC' | 'CHAT_MESSAGE' | 'TRANSCRIPT' | 'SUB_GROUP_MEMBER_LOG';
|
|
636
638
|
/**
|
|
637
639
|
* The archive file's unique ID.
|
|
638
640
|
*
|
|
@@ -3359,6 +3361,10 @@ type UpgradeZpasAppVariables = {
|
|
|
3359
3361
|
/**
|
|
3360
3362
|
* Upgrade ZPA firmware or app by Zoom Device Manager (ZDM) group ID.
|
|
3361
3363
|
*
|
|
3364
|
+
* **Prerequisites:**
|
|
3365
|
+
*
|
|
3366
|
+
* * Account owner or admin permissions.
|
|
3367
|
+
*
|
|
3362
3368
|
* **Scopes:** `device:write:admin`
|
|
3363
3369
|
*
|
|
3364
3370
|
* **Granular Scopes:** `device:write:zpa_os_app:admin`,`device:write:zpa_os_app:master`
|
|
@@ -4102,18 +4108,19 @@ type InMeetingControlPathParams = {
|
|
|
4102
4108
|
type InMeetingControlError = ErrorWrapper<undefined>;
|
|
4103
4109
|
type InMeetingControlRequestBody = {
|
|
4104
4110
|
/**
|
|
4105
|
-
* The
|
|
4106
|
-
* * `recording.start`
|
|
4107
|
-
* * `recording.stop`
|
|
4108
|
-
* * `recording.pause`
|
|
4109
|
-
* * `recording.resume`
|
|
4110
|
-
* * `participant.invite`
|
|
4111
|
-
* * `participant.invite.callout`
|
|
4112
|
-
* * `participant.invite.room_system_callout`
|
|
4111
|
+
* The method that you would like to control.
|
|
4112
|
+
* * `recording.start` - Start the recording.
|
|
4113
|
+
* * `recording.stop` - Stop the recording.
|
|
4114
|
+
* * `recording.pause` - Pause the recording.
|
|
4115
|
+
* * `recording.resume` - Resume a paused recording.
|
|
4116
|
+
* * `participant.invite` - Invite a participant to the meeting.
|
|
4117
|
+
* * `participant.invite.callout` - Invite a participant to the meeting through [call out (phone)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0062038).
|
|
4118
|
+
* * `participant.invite.room_system_callout` - Invite a participant to the meeting through [call out (room system)](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065721).
|
|
4119
|
+
* * `waiting_room.update` - Update the waiting room with a custom message.
|
|
4113
4120
|
*
|
|
4114
4121
|
* @example recording.start
|
|
4115
4122
|
*/
|
|
4116
|
-
method?:
|
|
4123
|
+
method?: 'recording.start' | 'recording.stop' | 'recording.pause' | 'recording.resume' | 'participant.invite' | 'participant.invite.callout' | 'participant.invite.room_system_callout' | 'waiting_room.update';
|
|
4117
4124
|
/**
|
|
4118
4125
|
* The in-meeting parameters.
|
|
4119
4126
|
*/
|
|
@@ -4250,6 +4257,18 @@ type InMeetingControlRequestBody = {
|
|
|
4250
4257
|
value?: string;
|
|
4251
4258
|
}[];
|
|
4252
4259
|
};
|
|
4260
|
+
/**
|
|
4261
|
+
* The title displayed in the waiting room. Use this field if you pass the `waiting_room.update` value for the `method` field.
|
|
4262
|
+
*
|
|
4263
|
+
* @example waiting room title
|
|
4264
|
+
*/
|
|
4265
|
+
waiting_room_title?: string;
|
|
4266
|
+
/**
|
|
4267
|
+
* The description shown in the waiting room. Use this field if you pass the `waiting_room.update` value for the `method` field.
|
|
4268
|
+
*
|
|
4269
|
+
* @example waiting room description
|
|
4270
|
+
*/
|
|
4271
|
+
waiting_room_description?: string;
|
|
4253
4272
|
};
|
|
4254
4273
|
};
|
|
4255
4274
|
type InMeetingControlVariables = {
|
|
@@ -4259,15 +4278,13 @@ type InMeetingControlVariables = {
|
|
|
4259
4278
|
/**
|
|
4260
4279
|
* Control [in-meeting](https://support.zoom.us/hc/en-us/articles/360021921032-In-Meeting-Controls) features. In-meeting controls include starting and stopping a recording, pausing and resuming a recording, and inviting participants.
|
|
4261
4280
|
*
|
|
4262
|
-
* **Note:** This API's recording control only works for cloud recordings
|
|
4281
|
+
* **Note:** This API's recording control only works for cloud recordings, **not** for local recordings.
|
|
4263
4282
|
*
|
|
4264
4283
|
* **Prerequisites:**
|
|
4265
|
-
* * The meeting **must** be a live meeting **except** inviting participants to the meeting through [call out (phone)/(room system)].
|
|
4284
|
+
* * The meeting **must** be a live meeting **except** 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).
|
|
4266
4285
|
* * Recording control: [Cloud recording](https://support.zoom.us/hc/en-us/articles/360060231472-Enabling-cloud-recording) must be enabled on the account.
|
|
4267
4286
|
* * The user calling this API must be the host or an alternative meeting host.
|
|
4268
4287
|
*
|
|
4269
|
-
*
|
|
4270
|
-
*
|
|
4271
4288
|
* **Scopes:** `meeting:write`,`meeting:write:admin`,`meeting:master`
|
|
4272
4289
|
*
|
|
4273
4290
|
* **Granular Scopes:** `meeting:update:in_meeting_controls`,`meeting:update:in_meeting_controls:admin`
|
|
@@ -4566,7 +4583,7 @@ type MeetingResponse = {
|
|
|
4566
4583
|
*/
|
|
4567
4584
|
start_time?: string;
|
|
4568
4585
|
/**
|
|
4569
|
-
* Occurrence status
|
|
4586
|
+
* Occurrence status.
|
|
4570
4587
|
* `available` - Available occurrence.
|
|
4571
4588
|
* `deleted` - Deleted occurrence.
|
|
4572
4589
|
*
|
|
@@ -4582,13 +4599,13 @@ type MeetingResponse = {
|
|
|
4582
4599
|
*/
|
|
4583
4600
|
password?: string;
|
|
4584
4601
|
/**
|
|
4585
|
-
* [Personal meeting ID (PMI)](
|
|
4602
|
+
* [Personal meeting ID (PMI)](/docs/api/rest/using-zoom-apis/#understanding-personal-meeting-id-pmi). Only used for scheduled meetings and recurring meetings with no fixed time.
|
|
4586
4603
|
*
|
|
4587
4604
|
* @example 97891943927
|
|
4588
4605
|
*/
|
|
4589
4606
|
pmi?: string;
|
|
4590
4607
|
/**
|
|
4591
|
-
* Whether the prescheduled meeting was created via the [GSuite app](https://support.zoom.us/hc/en-us/articles/360020187492-Zoom-for-GSuite-add-on). This **only** supports the meeting `type` value of `2` (scheduled meetings) and `3` (recurring meetings with no fixed time)
|
|
4608
|
+
* Whether the prescheduled meeting was created via the [GSuite app](https://support.zoom.us/hc/en-us/articles/360020187492-Zoom-for-GSuite-add-on). This **only** supports the meeting `type` value of `2` (scheduled meetings) and `3` (recurring meetings with no fixed time).
|
|
4592
4609
|
* * `true` - A GSuite prescheduled meeting.
|
|
4593
4610
|
* * `false` - A regular meeting.
|
|
4594
4611
|
*
|
|
@@ -4659,7 +4676,7 @@ type MeetingResponse = {
|
|
|
4659
4676
|
*/
|
|
4660
4677
|
repeat_interval?: number;
|
|
4661
4678
|
/**
|
|
4662
|
-
*
|
|
4679
|
+
* Recurring meeting types.
|
|
4663
4680
|
* `1` - Daily.
|
|
4664
4681
|
* `2` - Weekly.
|
|
4665
4682
|
* `3` - Monthly.
|
|
@@ -4739,14 +4756,14 @@ type MeetingResponse = {
|
|
|
4739
4756
|
*/
|
|
4740
4757
|
approved_list?: string[];
|
|
4741
4758
|
/**
|
|
4742
|
-
* List of countries
|
|
4759
|
+
* List of countries or regions from where participants can not join this meeting.
|
|
4743
4760
|
*/
|
|
4744
4761
|
denied_list?: string[];
|
|
4745
4762
|
/**
|
|
4746
|
-
* `true
|
|
4763
|
+
* `true` - Setting enabled to either allow users or block users from specific regions to join your meetings.
|
|
4747
4764
|
*
|
|
4748
4765
|
*
|
|
4749
|
-
* `false
|
|
4766
|
+
* `false` - Setting disabled.
|
|
4750
4767
|
*
|
|
4751
4768
|
* @example true
|
|
4752
4769
|
*/
|
|
@@ -4776,7 +4793,7 @@ type MeetingResponse = {
|
|
|
4776
4793
|
*/
|
|
4777
4794
|
audio?: 'both' | 'telephony' | 'voip' | 'thirdParty';
|
|
4778
4795
|
/**
|
|
4779
|
-
* Third party audio conference
|
|
4796
|
+
* Third party audio conference information.
|
|
4780
4797
|
*
|
|
4781
4798
|
* @maxLength 2048
|
|
4782
4799
|
* @example test
|
|
@@ -4793,14 +4810,14 @@ type MeetingResponse = {
|
|
|
4793
4810
|
*/
|
|
4794
4811
|
authentication_exception?: {
|
|
4795
4812
|
/**
|
|
4796
|
-
*
|
|
4813
|
+
* The participant's email address.
|
|
4797
4814
|
*
|
|
4798
4815
|
* @format email
|
|
4799
4816
|
* @example jchill@example.com
|
|
4800
4817
|
*/
|
|
4801
4818
|
email?: string;
|
|
4802
4819
|
/**
|
|
4803
|
-
*
|
|
4820
|
+
* The participant's name.
|
|
4804
4821
|
*
|
|
4805
4822
|
* @example Jill Chill
|
|
4806
4823
|
*/
|
|
@@ -4819,13 +4836,13 @@ type MeetingResponse = {
|
|
|
4819
4836
|
*/
|
|
4820
4837
|
authentication_name?: string;
|
|
4821
4838
|
/**
|
|
4822
|
-
* Meeting authentication option
|
|
4839
|
+
* Meeting authentication option ID.
|
|
4823
4840
|
*
|
|
4824
4841
|
* @example signIn_D8cJuqWVQ623CI4Q8yQK0Q
|
|
4825
4842
|
*/
|
|
4826
4843
|
authentication_option?: string;
|
|
4827
4844
|
/**
|
|
4828
|
-
* Automatic recording
|
|
4845
|
+
* Automatic recording.
|
|
4829
4846
|
* `local` - Record on local.
|
|
4830
4847
|
* `cloud` - Record on cloud.
|
|
4831
4848
|
* `none` - Disabled.
|
|
@@ -4845,7 +4862,7 @@ type MeetingResponse = {
|
|
|
4845
4862
|
*/
|
|
4846
4863
|
enable?: boolean;
|
|
4847
4864
|
/**
|
|
4848
|
-
* Create room
|
|
4865
|
+
* Create room or rooms.
|
|
4849
4866
|
*/
|
|
4850
4867
|
rooms?: {
|
|
4851
4868
|
/**
|
|
@@ -4871,7 +4888,7 @@ type MeetingResponse = {
|
|
|
4871
4888
|
*/
|
|
4872
4889
|
calendar_type?: 1 | 2;
|
|
4873
4890
|
/**
|
|
4874
|
-
* Close registration after event date
|
|
4891
|
+
* Close registration after event date.
|
|
4875
4892
|
*
|
|
4876
4893
|
* @example false
|
|
4877
4894
|
* @default false
|
|
@@ -4886,13 +4903,13 @@ type MeetingResponse = {
|
|
|
4886
4903
|
*/
|
|
4887
4904
|
cn_meeting?: boolean;
|
|
4888
4905
|
/**
|
|
4889
|
-
* Contact email for registration
|
|
4906
|
+
* Contact email for registration.
|
|
4890
4907
|
*
|
|
4891
4908
|
* @example jchill@example.com
|
|
4892
4909
|
*/
|
|
4893
4910
|
contact_email?: string;
|
|
4894
4911
|
/**
|
|
4895
|
-
* Contact name for registration
|
|
4912
|
+
* Contact name for registration.
|
|
4896
4913
|
*
|
|
4897
4914
|
* @example Jill Chill
|
|
4898
4915
|
*/
|
|
@@ -4965,11 +4982,11 @@ type MeetingResponse = {
|
|
|
4965
4982
|
*/
|
|
4966
4983
|
focus_mode?: boolean;
|
|
4967
4984
|
/**
|
|
4968
|
-
* List of global dial-in countries
|
|
4985
|
+
* List of global dial-in countries.
|
|
4969
4986
|
*/
|
|
4970
4987
|
global_dial_in_countries?: string[];
|
|
4971
4988
|
/**
|
|
4972
|
-
* Global Dial-in Countries
|
|
4989
|
+
* Global Dial-in Countries and Regions
|
|
4973
4990
|
*/
|
|
4974
4991
|
global_dial_in_numbers?: {
|
|
4975
4992
|
/**
|
|
@@ -4979,19 +4996,19 @@ type MeetingResponse = {
|
|
|
4979
4996
|
*/
|
|
4980
4997
|
city?: string;
|
|
4981
4998
|
/**
|
|
4982
|
-
* Country code
|
|
4999
|
+
* Country code, such as BR.
|
|
4983
5000
|
*
|
|
4984
5001
|
* @example US
|
|
4985
5002
|
*/
|
|
4986
5003
|
country?: string;
|
|
4987
5004
|
/**
|
|
4988
|
-
* Full name of country
|
|
5005
|
+
* Full name of country, such as Brazil.
|
|
4989
5006
|
*
|
|
4990
5007
|
* @example US
|
|
4991
5008
|
*/
|
|
4992
5009
|
country_name?: string;
|
|
4993
5010
|
/**
|
|
4994
|
-
* Phone number
|
|
5011
|
+
* Phone number, such as +1 2332357613.
|
|
4995
5012
|
*
|
|
4996
5013
|
* @example +1 1000200200
|
|
4997
5014
|
*/
|
|
@@ -5035,6 +5052,61 @@ type MeetingResponse = {
|
|
|
5035
5052
|
* @default false
|
|
5036
5053
|
*/
|
|
5037
5054
|
join_before_host?: boolean;
|
|
5055
|
+
/**
|
|
5056
|
+
* [Q&A](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065237) for meeting.
|
|
5057
|
+
*/
|
|
5058
|
+
question_and_answer?: {
|
|
5059
|
+
/**
|
|
5060
|
+
* * `true` - Enable [Q&A](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065237) for the meeting.
|
|
5061
|
+
*
|
|
5062
|
+
* * `false` - Disable Q&A for the meeting.
|
|
5063
|
+
*
|
|
5064
|
+
* @example true
|
|
5065
|
+
*/
|
|
5066
|
+
enable?: boolean;
|
|
5067
|
+
/**
|
|
5068
|
+
* * `true` - Allow participants to submit questions.
|
|
5069
|
+
*
|
|
5070
|
+
* * `false` - Don't allow participants to submit questions.
|
|
5071
|
+
*
|
|
5072
|
+
* @example true
|
|
5073
|
+
*/
|
|
5074
|
+
allow_submit_questions?: boolean;
|
|
5075
|
+
/**
|
|
5076
|
+
* * `true` - Allow participants to send questions without providing their name to the host, co-host, and panelists.
|
|
5077
|
+
*
|
|
5078
|
+
* * `false` - Don't allow anonymous questions. Not supported for simulive meetings.
|
|
5079
|
+
*
|
|
5080
|
+
* @example true
|
|
5081
|
+
*/
|
|
5082
|
+
allow_anonymous_questions?: boolean;
|
|
5083
|
+
/**
|
|
5084
|
+
* Indicate whether you want attendees to be able to view only answered questions, or view all questions.
|
|
5085
|
+
*
|
|
5086
|
+
* * `answered` - Attendees can only view answered questions.
|
|
5087
|
+
*
|
|
5088
|
+
* * `all` - Attendees can view all questions submitted in the Q&A.
|
|
5089
|
+
*
|
|
5090
|
+
* @example all
|
|
5091
|
+
*/
|
|
5092
|
+
question_visibility?: 'answered' | 'all';
|
|
5093
|
+
/**
|
|
5094
|
+
* * `true` - Attendees can answer questions or leave a comment in the question thread.
|
|
5095
|
+
*
|
|
5096
|
+
* * `false` - Attendees can't answer questions or leave a comment in the question thread.
|
|
5097
|
+
*
|
|
5098
|
+
* @example true
|
|
5099
|
+
*/
|
|
5100
|
+
attendees_can_comment?: boolean;
|
|
5101
|
+
/**
|
|
5102
|
+
* * `true` - Attendees can select the thumbs up button to bring popular questions to the top of the Q&A window.
|
|
5103
|
+
*
|
|
5104
|
+
* * `false` - Attendees can't select the thumbs up button on questions.
|
|
5105
|
+
*
|
|
5106
|
+
* @example true
|
|
5107
|
+
*/
|
|
5108
|
+
attendees_can_upvote?: boolean;
|
|
5109
|
+
};
|
|
5038
5110
|
/**
|
|
5039
5111
|
* The meeting's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details.
|
|
5040
5112
|
*
|
|
@@ -5398,6 +5470,15 @@ type MeetingResponse = {
|
|
|
5398
5470
|
* @example 123456
|
|
5399
5471
|
*/
|
|
5400
5472
|
dynamic_host_key?: string;
|
|
5473
|
+
/**
|
|
5474
|
+
* The platform through which the meeting was created.
|
|
5475
|
+
* * `other` - Created through another platform.
|
|
5476
|
+
* * `open_api` - Created through Open API.
|
|
5477
|
+
* * `web_portal` - Created through the web portal.
|
|
5478
|
+
*
|
|
5479
|
+
* @example open_api
|
|
5480
|
+
*/
|
|
5481
|
+
creation_source?: 'other' | 'open_api' | 'web_portal';
|
|
5401
5482
|
};
|
|
5402
5483
|
type MeetingVariables = {
|
|
5403
5484
|
pathParams: MeetingPathParams;
|
|
@@ -5463,7 +5544,7 @@ type MeetingDeleteVariables = {
|
|
|
5463
5544
|
*
|
|
5464
5545
|
*
|
|
5465
5546
|
*
|
|
5466
|
-
* **Scopes:** `meeting:write`,`meeting:write
|
|
5547
|
+
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
5467
5548
|
*
|
|
5468
5549
|
* **Granular Scopes:** `meeting:delete:meeting`,`meeting:delete:meeting:admin`
|
|
5469
5550
|
*
|
|
@@ -5505,11 +5586,12 @@ type MeetingUpdateRequestBody = {
|
|
|
5505
5586
|
*/
|
|
5506
5587
|
duration?: number;
|
|
5507
5588
|
/**
|
|
5508
|
-
*
|
|
5509
|
-
*
|
|
5510
|
-
* **Note** If the account owner or the admin has configured [minimum passcode requirement settings](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604), the passcode value provided here must meet those requirements.
|
|
5589
|
+
* The passcode required to join the meeting. By default, a passcode can **only** have a maximum length of 10 characters and only contain alphanumeric characters and the `@`, `-`, `_`, and `*` characters.
|
|
5511
5590
|
*
|
|
5512
|
-
*
|
|
5591
|
+
* **Note:**
|
|
5592
|
+
* * If the account owner or administrator has configured [minimum passcode requirement settings](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604), the passcode **must** meet those requirements.
|
|
5593
|
+
* * If passcode requirements are enabled, use the [**Get user settings**](https://developers.zoom.us/docs/api/users/#tag/users/GET/users/{userId}/settings) API or the [**Get account settings**](https://developers.zoom.us/docs/api/accounts/#tag/accounts/GET/accounts/{accountId}/settings) API to get the requirements.
|
|
5594
|
+
* * If the **Require a passcode when scheduling new meetings** account setting is enabled and locked, a passcode will be automatically generated if one is not provided.
|
|
5513
5595
|
*
|
|
5514
5596
|
* @maxLength 10
|
|
5515
5597
|
* @example 123456
|
|
@@ -5969,6 +6051,61 @@ type MeetingUpdateRequestBody = {
|
|
|
5969
6051
|
* @default false
|
|
5970
6052
|
*/
|
|
5971
6053
|
join_before_host?: boolean;
|
|
6054
|
+
/**
|
|
6055
|
+
* [Q&A](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065237) for meeting.
|
|
6056
|
+
*/
|
|
6057
|
+
question_and_answer?: {
|
|
6058
|
+
/**
|
|
6059
|
+
* * `true` - Enable [Q&A](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065237) for meeting.
|
|
6060
|
+
*
|
|
6061
|
+
* * `false` - Disable Q&A for meeting.
|
|
6062
|
+
*
|
|
6063
|
+
* @example true
|
|
6064
|
+
*/
|
|
6065
|
+
enable?: boolean;
|
|
6066
|
+
/**
|
|
6067
|
+
* * `true`: Allow participants to submit questions.
|
|
6068
|
+
*
|
|
6069
|
+
* * `false`: Do not allow submit questions.
|
|
6070
|
+
*
|
|
6071
|
+
* @example true
|
|
6072
|
+
*/
|
|
6073
|
+
allow_submit_questions?: boolean;
|
|
6074
|
+
/**
|
|
6075
|
+
* * `true` - Allow participants to send questions without providing their name to the host, co-host, and panelists..
|
|
6076
|
+
*
|
|
6077
|
+
* * `false` - Do not allow anonymous questions.(Not supported for simulive meeting.)
|
|
6078
|
+
*
|
|
6079
|
+
* @example true
|
|
6080
|
+
*/
|
|
6081
|
+
allow_anonymous_questions?: boolean;
|
|
6082
|
+
/**
|
|
6083
|
+
* Indicate whether you want attendees to be able to view answered questions only or view all questions.
|
|
6084
|
+
*
|
|
6085
|
+
* * `answered` - Attendees are able to view answered questions only.
|
|
6086
|
+
*
|
|
6087
|
+
* * `all` - Attendees are able to view all questions submitted in the Q&A.
|
|
6088
|
+
*
|
|
6089
|
+
* @example all
|
|
6090
|
+
*/
|
|
6091
|
+
question_visibility?: 'answered' | 'all';
|
|
6092
|
+
/**
|
|
6093
|
+
* * `true` - Attendees can answer questions or leave a comment in the question thread.
|
|
6094
|
+
*
|
|
6095
|
+
* * `false` - Attendees can not answer questions or leave a comment in the question thread
|
|
6096
|
+
*
|
|
6097
|
+
* @example true
|
|
6098
|
+
*/
|
|
6099
|
+
attendees_can_comment?: boolean;
|
|
6100
|
+
/**
|
|
6101
|
+
* * `true` - Attendees can click the thumbs up button to bring popular questions to the top of the Q&A window.
|
|
6102
|
+
*
|
|
6103
|
+
* * `false` - Attendees can not click the thumbs up button on questions.
|
|
6104
|
+
*
|
|
6105
|
+
* @example true
|
|
6106
|
+
*/
|
|
6107
|
+
attendees_can_upvote?: boolean;
|
|
6108
|
+
};
|
|
5972
6109
|
/**
|
|
5973
6110
|
* The meeting's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details.
|
|
5974
6111
|
*
|
|
@@ -6289,15 +6426,12 @@ type MeetingUpdateVariables = {
|
|
|
6289
6426
|
queryParams?: MeetingUpdateQueryParams;
|
|
6290
6427
|
} & FetcherExtraProps;
|
|
6291
6428
|
/**
|
|
6292
|
-
*
|
|
6293
|
-
*
|
|
6294
|
-
* **Note**
|
|
6295
|
-
* * 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.
|
|
6296
|
-
* * The `recurrence` object is **required**.
|
|
6297
|
-
* * 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**.
|
|
6298
|
-
*
|
|
6299
|
-
*
|
|
6429
|
+
* Update meeting details.
|
|
6300
6430
|
*
|
|
6431
|
+
* **Prerequisites**
|
|
6432
|
+
* * 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.
|
|
6433
|
+
* * The `recurrence` object is required only when updating the entire series of a recurring meeting with `type=8`.
|
|
6434
|
+
* * 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.
|
|
6301
6435
|
*
|
|
6302
6436
|
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
6303
6437
|
*
|
|
@@ -6770,7 +6904,9 @@ type AddBatchRegistrantsVariables = {
|
|
|
6770
6904
|
*
|
|
6771
6905
|
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
6772
6906
|
*
|
|
6773
|
-
* **
|
|
6907
|
+
* **Granular Scopes:** `meeting:write:batch_registrants`,`meeting:write:batch_registrants:admin`
|
|
6908
|
+
*
|
|
6909
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `HEAVY`
|
|
6774
6910
|
*/
|
|
6775
6911
|
declare const addBatchRegistrants: (variables: AddBatchRegistrantsVariables, signal?: AbortSignal) => Promise<AddBatchRegistrantsResponse>;
|
|
6776
6912
|
type MeetingInvitationPathParams = {
|
|
@@ -6831,6 +6967,8 @@ type MeetingInvitationVariables = {
|
|
|
6831
6967
|
*
|
|
6832
6968
|
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
6833
6969
|
*
|
|
6970
|
+
* **Granular Scopes:** `meeting:read:invitation`,`meeting:read:invitation:admin`
|
|
6971
|
+
*
|
|
6834
6972
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
6835
6973
|
*/
|
|
6836
6974
|
declare const meetingInvitation: (variables: MeetingInvitationVariables, signal?: AbortSignal) => Promise<MeetingInvitationResponse>;
|
|
@@ -6905,7 +7043,9 @@ type MeetingInviteLinksCreateVariables = {
|
|
|
6905
7043
|
*
|
|
6906
7044
|
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
6907
7045
|
*
|
|
6908
|
-
* **
|
|
7046
|
+
* **Granular Scopes:** `meeting:write:invite_links`,`meeting:write:invite_links:admin`
|
|
7047
|
+
*
|
|
7048
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
6909
7049
|
*/
|
|
6910
7050
|
declare const meetingInviteLinksCreate: (variables: MeetingInviteLinksCreateVariables, signal?: AbortSignal) => Promise<MeetingInviteLinksCreateResponse>;
|
|
6911
7051
|
type MeetingLiveStreamingJoinTokenPathParams = {
|
|
@@ -6947,7 +7087,9 @@ type MeetingLiveStreamingJoinTokenVariables = {
|
|
|
6947
7087
|
*
|
|
6948
7088
|
* **Scopes:** `meeting_token:read:admin:live_streaming`,`meeting_token:read:live_streaming`
|
|
6949
7089
|
*
|
|
6950
|
-
* **
|
|
7090
|
+
* **Granular Scopes:** `meeting:read:live_streaming_token`,`meeting:read:live_streaming_token:admin`
|
|
7091
|
+
*
|
|
7092
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
6951
7093
|
*/
|
|
6952
7094
|
declare const meetingLiveStreamingJoinToken: (variables: MeetingLiveStreamingJoinTokenVariables, signal?: AbortSignal) => Promise<MeetingLiveStreamingJoinTokenResponse>;
|
|
6953
7095
|
type MeetingLocalArchivingArchiveTokenPathParams = {
|
|
@@ -6989,7 +7131,9 @@ type MeetingLocalArchivingArchiveTokenVariables = {
|
|
|
6989
7131
|
*
|
|
6990
7132
|
* **Scopes:** `meeting_token:read:admin:local_archiving`
|
|
6991
7133
|
*
|
|
6992
|
-
* **
|
|
7134
|
+
* **Granular Scopes:** `meeting:read:local_archiving_token:admin`
|
|
7135
|
+
*
|
|
7136
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
6993
7137
|
*/
|
|
6994
7138
|
declare const meetingLocalArchivingArchiveToken: (variables: MeetingLocalArchivingArchiveTokenVariables, signal?: AbortSignal) => Promise<MeetingLocalArchivingArchiveTokenResponse>;
|
|
6995
7139
|
type MeetingLocalRecordingJoinTokenPathParams = {
|
|
@@ -7037,7 +7181,7 @@ type MeetingLocalRecordingJoinTokenVariables = {
|
|
|
7037
7181
|
* **Prerequisites:**
|
|
7038
7182
|
* * The **Local recording** user setting enabled in the Zoom web portal.
|
|
7039
7183
|
*
|
|
7040
|
-
* **Scopes:** `meeting_token:read:local_recording`,`meeting_token:read:
|
|
7184
|
+
* **Scopes:** `meeting_token:read:admin:local_recording`,`meeting_token:read:local_recording`
|
|
7041
7185
|
*
|
|
7042
7186
|
* **Granular Scopes:** `meeting:read:local_recording_token`,`meeting:read:local_recording_token:admin`
|
|
7043
7187
|
*
|
|
@@ -7097,7 +7241,9 @@ type GetMeetingLiveStreamDetailsVariables = {
|
|
|
7097
7241
|
*
|
|
7098
7242
|
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
7099
7243
|
*
|
|
7100
|
-
* **
|
|
7244
|
+
* **Granular Scopes:** `meeting:read:livestream`,`meeting:read:livestream:admin`
|
|
7245
|
+
*
|
|
7246
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7101
7247
|
*/
|
|
7102
7248
|
declare const getMeetingLiveStreamDetails: (variables: GetMeetingLiveStreamDetailsVariables, signal?: AbortSignal) => Promise<GetMeetingLiveStreamDetailsResponse>;
|
|
7103
7249
|
type MeetingLiveStreamUpdatePathParams = {
|
|
@@ -7154,7 +7300,9 @@ type MeetingLiveStreamUpdateVariables = {
|
|
|
7154
7300
|
*
|
|
7155
7301
|
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
7156
7302
|
*
|
|
7157
|
-
* **
|
|
7303
|
+
* **Granular Scopes:** `meeting:update:livestream`,`meeting:update:livestream:admin`
|
|
7304
|
+
*
|
|
7305
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
7158
7306
|
*/
|
|
7159
7307
|
declare const meetingLiveStreamUpdate: (variables: MeetingLiveStreamUpdateVariables, signal?: AbortSignal) => Promise<undefined>;
|
|
7160
7308
|
type MeetingLiveStreamStatusUpdatePathParams = {
|
|
@@ -7264,13 +7412,13 @@ type GetameetingsummaryResponse = {
|
|
|
7264
7412
|
*
|
|
7265
7413
|
* Each meeting instance generates its own meeting UUID. After a meeting ends, a new UUID is generated for the next instance of the meeting.
|
|
7266
7414
|
*
|
|
7267
|
-
* Use the [**List past meeting instances**](/docs/api-reference/zoom-api/methods#operation/pastMeetings) API to retrieve a list of UUIDs from past meeting instances. [Double encode](
|
|
7415
|
+
* Use the [**List past meeting instances**](/docs/api-reference/zoom-api/methods#operation/pastMeetings) API to retrieve a list of UUIDs from past meeting instances. [Double encode](/docs/api/rest/using-zoom-apis/#meeting-id-and-uuid) your UUID when using it for API calls if the UUID begins with a `/` or contains `//` in it.
|
|
7268
7416
|
*
|
|
7269
7417
|
* @example aDYlohsHRtCd4ii1uC2+hA==
|
|
7270
7418
|
*/
|
|
7271
7419
|
meeting_uuid?: string;
|
|
7272
7420
|
/**
|
|
7273
|
-
* [
|
|
7421
|
+
* [The meeting ID](https://support.zoom.us/hc/en-us/articles/201362373-What-is-a-Meeting-ID-)
|
|
7274
7422
|
* The meeting's unique identifier in **long** format, represented as int64 data type in JSON. Also known as the meeting number.
|
|
7275
7423
|
*
|
|
7276
7424
|
* @format int64
|
|
@@ -7325,6 +7473,18 @@ type GetameetingsummaryResponse = {
|
|
|
7325
7473
|
* @example 2020-07-15T23:30:19Z
|
|
7326
7474
|
*/
|
|
7327
7475
|
summary_last_modified_time?: string;
|
|
7476
|
+
/**
|
|
7477
|
+
* The user ID of the user who last modified the meeting summary.
|
|
7478
|
+
*
|
|
7479
|
+
* @example Lfi0BlBQTM-bbktE9BRUvA
|
|
7480
|
+
*/
|
|
7481
|
+
summary_last_modified_user_id?: string;
|
|
7482
|
+
/**
|
|
7483
|
+
* The user email of the user who last modified the meeting summary.
|
|
7484
|
+
*
|
|
7485
|
+
* @example user@example.com
|
|
7486
|
+
*/
|
|
7487
|
+
summary_last_modified_user_email?: string;
|
|
7328
7488
|
/**
|
|
7329
7489
|
* The summary title.
|
|
7330
7490
|
*
|
|
@@ -7359,6 +7519,12 @@ type GetameetingsummaryResponse = {
|
|
|
7359
7519
|
*/
|
|
7360
7520
|
next_steps?: string[];
|
|
7361
7521
|
edited_summary?: {
|
|
7522
|
+
/**
|
|
7523
|
+
* The user edited summary overview.
|
|
7524
|
+
*
|
|
7525
|
+
* @example Meeting overview
|
|
7526
|
+
*/
|
|
7527
|
+
summary_overview?: string;
|
|
7362
7528
|
/**
|
|
7363
7529
|
* The user edited summary details.
|
|
7364
7530
|
*
|
|
@@ -7375,11 +7541,11 @@ type GetameetingsummaryVariables = {
|
|
|
7375
7541
|
pathParams: GetameetingsummaryPathParams;
|
|
7376
7542
|
} & FetcherExtraProps;
|
|
7377
7543
|
/**
|
|
7378
|
-
*
|
|
7544
|
+
* Display information about a meeting summary.
|
|
7379
7545
|
*
|
|
7380
7546
|
* **Prerequisites**:
|
|
7381
|
-
* * Host user type must
|
|
7382
|
-
* *
|
|
7547
|
+
* * Host user type must have a Pro or higher plan.
|
|
7548
|
+
* * Enable the Meeting Summary with AI Companion feature in the host's account.
|
|
7383
7549
|
* * E2ee meetings do not have summary feature enabled.
|
|
7384
7550
|
*
|
|
7385
7551
|
* **Scopes:** `meeting_summary:read`,`meeting_summary:read:admin`
|
|
@@ -7495,17 +7661,17 @@ type MeetingPollsResponse = {
|
|
|
7495
7661
|
*/
|
|
7496
7662
|
id?: string;
|
|
7497
7663
|
/**
|
|
7498
|
-
* The status
|
|
7499
|
-
* `notstart` - Poll not started
|
|
7500
|
-
* `started` - Poll started
|
|
7501
|
-
* `ended` - Poll ended
|
|
7502
|
-
* `sharing` - Sharing poll results
|
|
7664
|
+
* The poll's status.
|
|
7665
|
+
* `notstart` - Poll not started.
|
|
7666
|
+
* `started` - Poll started.
|
|
7667
|
+
* `ended` - Poll ended.
|
|
7668
|
+
* `sharing` - Sharing poll results.
|
|
7503
7669
|
*
|
|
7504
7670
|
* @example notstart
|
|
7505
7671
|
*/
|
|
7506
7672
|
status?: 'notstart' | 'started' | 'ended' | 'sharing';
|
|
7507
7673
|
/**
|
|
7508
|
-
* Whether meeting participants answer poll questions anonymously.
|
|
7674
|
+
* Whether meeting participants can answer poll questions anonymously.
|
|
7509
7675
|
*
|
|
7510
7676
|
* This value defaults to `false`.
|
|
7511
7677
|
*
|
|
@@ -7514,10 +7680,10 @@ type MeetingPollsResponse = {
|
|
|
7514
7680
|
*/
|
|
7515
7681
|
anonymous?: boolean;
|
|
7516
7682
|
/**
|
|
7517
|
-
* The type of poll
|
|
7518
|
-
* * `1`
|
|
7519
|
-
* * `2`
|
|
7520
|
-
* * `3`
|
|
7683
|
+
* The type of poll.
|
|
7684
|
+
* * `1` - Poll.
|
|
7685
|
+
* * `2` - Advanced Poll. This feature must be enabled in your Zoom account.
|
|
7686
|
+
* * `3` - Quiz. This feature must be enabled in your Zoom account.
|
|
7521
7687
|
*
|
|
7522
7688
|
* This value defaults to `1`.
|
|
7523
7689
|
*
|
|
@@ -7525,7 +7691,7 @@ type MeetingPollsResponse = {
|
|
|
7525
7691
|
*/
|
|
7526
7692
|
poll_type?: 1 | 2 | 3;
|
|
7527
7693
|
/**
|
|
7528
|
-
*
|
|
7694
|
+
* Information about the poll's questions.
|
|
7529
7695
|
*/
|
|
7530
7696
|
questions?: {
|
|
7531
7697
|
/**
|
|
@@ -7587,7 +7753,7 @@ type MeetingPollsResponse = {
|
|
|
7587
7753
|
*/
|
|
7588
7754
|
name?: string;
|
|
7589
7755
|
/**
|
|
7590
|
-
*
|
|
7756
|
+
* Information about the prompt questions. This field only applies to `matching` and `rank_order` polls. You **must** provide a minimum of two prompts, up to a maximum of 10 prompts.
|
|
7591
7757
|
*/
|
|
7592
7758
|
prompts?: {
|
|
7593
7759
|
/**
|
|
@@ -8120,7 +8286,7 @@ type MeetingPollGetPathParams = {
|
|
|
8120
8286
|
*/
|
|
8121
8287
|
meetingId: number;
|
|
8122
8288
|
/**
|
|
8123
|
-
* The poll ID
|
|
8289
|
+
* The poll ID.
|
|
8124
8290
|
*
|
|
8125
8291
|
* @example QalIoKWLTJehBJ8e1xRrbQ
|
|
8126
8292
|
*/
|
|
@@ -8129,13 +8295,13 @@ type MeetingPollGetPathParams = {
|
|
|
8129
8295
|
type MeetingPollGetError = ErrorWrapper<undefined>;
|
|
8130
8296
|
type MeetingPollGetResponse = {
|
|
8131
8297
|
/**
|
|
8132
|
-
* The meeting poll ID
|
|
8298
|
+
* The meeting poll ID.
|
|
8133
8299
|
*
|
|
8134
8300
|
* @example QalIoKWLTJehBJ8e1xRrbQ
|
|
8135
8301
|
*/
|
|
8136
8302
|
id?: string;
|
|
8137
8303
|
/**
|
|
8138
|
-
* The
|
|
8304
|
+
* The meeting poll's status.
|
|
8139
8305
|
* `notstart` - Poll not started
|
|
8140
8306
|
* `started` - Poll started
|
|
8141
8307
|
* `ended` - Poll ended
|
|
@@ -8154,7 +8320,7 @@ type MeetingPollGetResponse = {
|
|
|
8154
8320
|
*/
|
|
8155
8321
|
anonymous?: boolean;
|
|
8156
8322
|
/**
|
|
8157
|
-
* The type
|
|
8323
|
+
* The poll's type.
|
|
8158
8324
|
* * `1` — Poll.
|
|
8159
8325
|
* * `2` — Advanced Poll. This feature must be enabled in your Zoom account.
|
|
8160
8326
|
* * `3` — Quiz. This feature must be enabled in your Zoom account.
|
|
@@ -8169,7 +8335,7 @@ type MeetingPollGetResponse = {
|
|
|
8169
8335
|
*/
|
|
8170
8336
|
questions?: {
|
|
8171
8337
|
/**
|
|
8172
|
-
* The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls
|
|
8338
|
+
* The allowed maximum number of characters. This field only applies to `short_answer` and `long_answer` polls.
|
|
8173
8339
|
* * For `short_answer` polls, a maximum of 500 characters.
|
|
8174
8340
|
* * For `long_answer` polls, a maximum of 2,000 characters.
|
|
8175
8341
|
*
|
|
@@ -8184,9 +8350,9 @@ type MeetingPollGetResponse = {
|
|
|
8184
8350
|
*/
|
|
8185
8351
|
answer_min_character?: number;
|
|
8186
8352
|
/**
|
|
8187
|
-
* Whether participants must answer the question
|
|
8188
|
-
* * `true`
|
|
8189
|
-
* * `false`
|
|
8353
|
+
* Whether participants must answer the question.
|
|
8354
|
+
* * `true` - The participant must answer the question.
|
|
8355
|
+
* * `false` - The participant does not need to answer the question.
|
|
8190
8356
|
*
|
|
8191
8357
|
* **Note:**
|
|
8192
8358
|
* * When the poll's `type` value is `1` (Poll), this value defaults to `true`.
|
|
@@ -8297,7 +8463,7 @@ type MeetingPollGetResponse = {
|
|
|
8297
8463
|
*/
|
|
8298
8464
|
show_as_dropdown?: boolean;
|
|
8299
8465
|
/**
|
|
8300
|
-
* The poll's question and answer type
|
|
8466
|
+
* The poll's question and answer type.
|
|
8301
8467
|
* * `single` — Single choice.
|
|
8302
8468
|
* * `multiple` — Multiple choice.
|
|
8303
8469
|
* * `matching` — Matching.
|
|
@@ -8323,7 +8489,7 @@ type MeetingPollGetVariables = {
|
|
|
8323
8489
|
pathParams: MeetingPollGetPathParams;
|
|
8324
8490
|
} & FetcherExtraProps;
|
|
8325
8491
|
/**
|
|
8326
|
-
* Polls
|
|
8492
|
+
* Polls let the meeting host survey attendees. It retrieves information about a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).
|
|
8327
8493
|
*
|
|
8328
8494
|
*
|
|
8329
8495
|
*
|
|
@@ -8576,7 +8742,7 @@ type MeetingPollDeleteVariables = {
|
|
|
8576
8742
|
* * Polling feature should be enabled in the host's account.
|
|
8577
8743
|
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
|
|
8578
8744
|
*
|
|
8579
|
-
* **Scopes:** `meeting:write`,`meeting:write
|
|
8745
|
+
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
8580
8746
|
*
|
|
8581
8747
|
* **Granular Scopes:** `meeting:delete:poll`,`meeting:delete:poll:admin`
|
|
8582
8748
|
*
|
|
@@ -8859,7 +9025,9 @@ type MeetingRegistrantsVariables = {
|
|
|
8859
9025
|
*
|
|
8860
9026
|
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
8861
9027
|
*
|
|
8862
|
-
* **
|
|
9028
|
+
* **Granular Scopes:** `meeting:read:list_registrants`,`meeting:read:list_registrants:admin`
|
|
9029
|
+
*
|
|
9030
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
8863
9031
|
*/
|
|
8864
9032
|
declare const meetingRegistrants: (variables: MeetingRegistrantsVariables, signal?: AbortSignal) => Promise<MeetingRegistrantsResponse>;
|
|
8865
9033
|
type MeetingRegistrantCreatePathParams = {
|
|
@@ -9134,7 +9302,9 @@ type MeetingRegistrantCreateVariables = {
|
|
|
9134
9302
|
*
|
|
9135
9303
|
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
9136
9304
|
*
|
|
9137
|
-
* **
|
|
9305
|
+
* **Granular Scopes:** `meeting:write:registrant`,`meeting:write:registrant:admin`
|
|
9306
|
+
*
|
|
9307
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9138
9308
|
*/
|
|
9139
9309
|
declare const meetingRegistrantCreate: (variables: MeetingRegistrantCreateVariables, signal?: AbortSignal) => Promise<MeetingRegistrantCreateResponse>;
|
|
9140
9310
|
type MeetingRegistrantsQuestionsGetPathParams = {
|
|
@@ -9206,7 +9376,9 @@ type MeetingRegistrantsQuestionsGetVariables = {
|
|
|
9206
9376
|
*
|
|
9207
9377
|
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
9208
9378
|
*
|
|
9209
|
-
* **
|
|
9379
|
+
* **Granular Scopes:** `meeting:read:list_registration_questions`,`meeting:read:list_registration_questions:admin`
|
|
9380
|
+
*
|
|
9381
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9210
9382
|
*/
|
|
9211
9383
|
declare const meetingRegistrantsQuestionsGet: (variables: MeetingRegistrantsQuestionsGetVariables, signal?: AbortSignal) => Promise<MeetingRegistrantsQuestionsGetResponse>;
|
|
9212
9384
|
type MeetingRegistrantQuestionUpdatePathParams = {
|
|
@@ -9279,7 +9451,9 @@ type MeetingRegistrantQuestionUpdateVariables = {
|
|
|
9279
9451
|
*
|
|
9280
9452
|
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
9281
9453
|
*
|
|
9282
|
-
* **
|
|
9454
|
+
* **Granular Scopes:** `meeting:update:registration_question`,`meeting:update:registration_question:admin`
|
|
9455
|
+
*
|
|
9456
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9283
9457
|
*/
|
|
9284
9458
|
declare const meetingRegistrantQuestionUpdate: (variables: MeetingRegistrantQuestionUpdateVariables, signal?: AbortSignal) => Promise<undefined>;
|
|
9285
9459
|
type MeetingRegistrantStatusPathParams = {
|
|
@@ -9341,7 +9515,9 @@ type MeetingRegistrantStatusVariables = {
|
|
|
9341
9515
|
*
|
|
9342
9516
|
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
9343
9517
|
*
|
|
9344
|
-
* **
|
|
9518
|
+
* **Granular Scopes:** `meeting:update:registrant_status`,`meeting:update:registrant_status:admin`
|
|
9519
|
+
*
|
|
9520
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
9345
9521
|
*/
|
|
9346
9522
|
declare const meetingRegistrantStatus: (variables: MeetingRegistrantStatusVariables, signal?: AbortSignal) => Promise<undefined>;
|
|
9347
9523
|
type MeetingRegistrantGetPathParams = {
|
|
@@ -9545,7 +9721,9 @@ type MeetingRegistrantGetVariables = {
|
|
|
9545
9721
|
*
|
|
9546
9722
|
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
9547
9723
|
*
|
|
9548
|
-
* **
|
|
9724
|
+
* **Granular Scopes:** `meeting:read:registrant`,`meeting:read:registrant:admin`
|
|
9725
|
+
*
|
|
9726
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9549
9727
|
*/
|
|
9550
9728
|
declare const meetingRegistrantGet: (variables: MeetingRegistrantGetVariables, signal?: AbortSignal) => Promise<MeetingRegistrantGetResponse>;
|
|
9551
9729
|
type MeetingregistrantdeletePathParams = {
|
|
@@ -9583,7 +9761,9 @@ type MeetingregistrantdeleteVariables = {
|
|
|
9583
9761
|
*
|
|
9584
9762
|
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
9585
9763
|
*
|
|
9586
|
-
* **
|
|
9764
|
+
* **Granular Scopes:** `meeting:delete:registrant`,`meeting:delete:registrant:admin`
|
|
9765
|
+
*
|
|
9766
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9587
9767
|
*/
|
|
9588
9768
|
declare const meetingregistrantdelete: (variables: MeetingregistrantdeleteVariables, signal?: AbortSignal) => Promise<undefined>;
|
|
9589
9769
|
type GetSipDialingWithPasscodePathParams = {
|
|
@@ -9683,7 +9863,9 @@ type MeetingStatusVariables = {
|
|
|
9683
9863
|
*
|
|
9684
9864
|
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
9685
9865
|
*
|
|
9686
|
-
* **
|
|
9866
|
+
* **Granular Scopes:** `meeting:update:status`,`meeting:update:status:admin`
|
|
9867
|
+
*
|
|
9868
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9687
9869
|
*/
|
|
9688
9870
|
declare const meetingStatus: (variables: MeetingStatusVariables, signal?: AbortSignal) => Promise<undefined>;
|
|
9689
9871
|
type MeetingSurveyGetPathParams = {
|
|
@@ -9900,6 +10082,8 @@ type MeetingSurveyGetVariables = {
|
|
|
9900
10082
|
*
|
|
9901
10083
|
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
9902
10084
|
*
|
|
10085
|
+
* **Granular Scopes:** `meeting:read:survey`,`meeting:read:survey:admin`
|
|
10086
|
+
*
|
|
9903
10087
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9904
10088
|
*/
|
|
9905
10089
|
declare const meetingSurveyGet: (variables: MeetingSurveyGetVariables, signal?: AbortSignal) => Promise<MeetingSurveyGetResponse>;
|
|
@@ -9928,7 +10112,9 @@ type MeetingSurveyDeleteVariables = {
|
|
|
9928
10112
|
*
|
|
9929
10113
|
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
9930
10114
|
*
|
|
9931
|
-
* **
|
|
10115
|
+
* **Granular Scopes:** `meeting:delete:survey`,`meeting:delete:survey:admin`
|
|
10116
|
+
*
|
|
10117
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
9932
10118
|
*/
|
|
9933
10119
|
declare const meetingSurveyDelete: (variables: MeetingSurveyDeleteVariables, signal?: AbortSignal) => Promise<undefined>;
|
|
9934
10120
|
type MeetingSurveyUpdatePathParams = {
|
|
@@ -10144,7 +10330,9 @@ type MeetingSurveyUpdateVariables = {
|
|
|
10144
10330
|
/**
|
|
10145
10331
|
* 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.
|
|
10146
10332
|
*
|
|
10147
|
-
* **Scopes:** `meeting:write
|
|
10333
|
+
* **Scopes:** `meeting:write`,`meeting:write:admin`
|
|
10334
|
+
*
|
|
10335
|
+
* **Granular Scopes:** `meeting:update:survey`,`meeting:update:survey:admin`
|
|
10148
10336
|
*
|
|
10149
10337
|
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10150
10338
|
*/
|
|
@@ -10205,7 +10393,7 @@ type PastMeetingDetailsPathParams = {
|
|
|
10205
10393
|
* * If you provide a meeting ID, the API will return a response for the latest meeting instance.
|
|
10206
10394
|
* * If you provide a meeting UUID that begins with a `/` character or contains the `//` characters, you **must** [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/#meeting-id-and-uuid) the meeting UUID before making an API request.
|
|
10207
10395
|
*/
|
|
10208
|
-
meetingId:
|
|
10396
|
+
meetingId: string;
|
|
10209
10397
|
};
|
|
10210
10398
|
type PastMeetingDetailsError = ErrorWrapper<undefined>;
|
|
10211
10399
|
type PastMeetingDetailsResponse = {
|
|
@@ -10281,14 +10469,14 @@ type PastMeetingDetailsResponse = {
|
|
|
10281
10469
|
*/
|
|
10282
10470
|
total_minutes?: number;
|
|
10283
10471
|
/**
|
|
10284
|
-
* The meeting type
|
|
10285
|
-
* * `0`
|
|
10286
|
-
* * `1`
|
|
10287
|
-
* * `2`
|
|
10288
|
-
* * `3`
|
|
10289
|
-
* * `4`
|
|
10290
|
-
* * `7`
|
|
10291
|
-
* * `8`
|
|
10472
|
+
* The meeting type.
|
|
10473
|
+
* * `0` - A prescheduled meeting.
|
|
10474
|
+
* * `1` - An instant meeting.
|
|
10475
|
+
* * `2` - A scheduled meeting.
|
|
10476
|
+
* * `3` - A recurring meeting with no fixed time.
|
|
10477
|
+
* * `4` - A [personal meeting room](https://support.zoom.us/hc/en-us/articles/201362843).
|
|
10478
|
+
* * `7` - A [PAC (personal audio conference)](https://support.zoom.us/hc/en-us/articles/205172455-Hosting-a-Personal-Audio-Conference-PAC-meeting) meeting.
|
|
10479
|
+
* * `8` - A recurring meeting with a fixed time.
|
|
10292
10480
|
*
|
|
10293
10481
|
* @example 1
|
|
10294
10482
|
*/
|
|
@@ -10317,7 +10505,9 @@ type PastMeetingDetailsVariables = {
|
|
|
10317
10505
|
*
|
|
10318
10506
|
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
10319
10507
|
*
|
|
10320
|
-
* **
|
|
10508
|
+
* **Granular Scopes:** `meeting:read:past_meeting`,`meeting:read:past_meeting:admin`
|
|
10509
|
+
*
|
|
10510
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `LIGHT`
|
|
10321
10511
|
*/
|
|
10322
10512
|
declare const pastMeetingDetails: (variables: PastMeetingDetailsVariables, signal?: AbortSignal) => Promise<PastMeetingDetailsResponse>;
|
|
10323
10513
|
type PastMeetingsPathParams = {
|
|
@@ -10360,7 +10550,9 @@ type PastMeetingsVariables = {
|
|
|
10360
10550
|
*
|
|
10361
10551
|
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
10362
10552
|
*
|
|
10363
|
-
* **
|
|
10553
|
+
* **Granular Scopes:** `meeting:read:list_past_instances`,`meeting:read:list_past_instances:admin`
|
|
10554
|
+
*
|
|
10555
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
10364
10556
|
*/
|
|
10365
10557
|
declare const pastMeetings: (variables: PastMeetingsVariables, signal?: AbortSignal) => Promise<PastMeetingsResponse>;
|
|
10366
10558
|
type PastMeetingParticipantsPathParams = {
|
|
@@ -10605,7 +10797,9 @@ type ListPastMeetingPollsVariables = {
|
|
|
10605
10797
|
*
|
|
10606
10798
|
* **Scopes:** `meeting:read:admin`,`meeting:read`
|
|
10607
10799
|
*
|
|
10608
|
-
* **
|
|
10800
|
+
* **Granular Scopes:** `meeting:read:list_poll_results`,`meeting:read:list_poll_results:admin`
|
|
10801
|
+
*
|
|
10802
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
10609
10803
|
*/
|
|
10610
10804
|
declare const listPastMeetingPolls: (variables: ListPastMeetingPollsVariables, signal?: AbortSignal) => Promise<ListPastMeetingPollsResponse>;
|
|
10611
10805
|
type ListPastMeetingQAPathParams = {
|
|
@@ -10737,7 +10931,9 @@ type ListMeetingTemplatesVariables = {
|
|
|
10737
10931
|
*
|
|
10738
10932
|
* **Scopes:** `meeting:read`,`meeting:read:admin`
|
|
10739
10933
|
*
|
|
10740
|
-
* **
|
|
10934
|
+
* **Granular Scopes:** `meeting:read:list_templates`,`meeting:read:list_templates:admin`
|
|
10935
|
+
*
|
|
10936
|
+
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`
|
|
10741
10937
|
*/
|
|
10742
10938
|
declare const listMeetingTemplates: (variables: ListMeetingTemplatesVariables, signal?: AbortSignal) => Promise<ListMeetingTemplatesResponse>;
|
|
10743
10939
|
type MeetingTemplateCreatePathParams = {
|
|
@@ -11067,7 +11263,7 @@ type MeetingCreateResponse = {
|
|
|
11067
11263
|
*/
|
|
11068
11264
|
encrypted_password?: string;
|
|
11069
11265
|
/**
|
|
11070
|
-
*
|
|
11266
|
+
* Passcode for participants to join the meeting via [PSTN](https://support.zoom.us/hc/en-us/articles/204517069-Getting-Started-with-Personal-Audio-Conference).
|
|
11071
11267
|
*
|
|
11072
11268
|
* @example 123456
|
|
11073
11269
|
*/
|
|
@@ -11101,7 +11297,7 @@ type MeetingCreateResponse = {
|
|
|
11101
11297
|
*/
|
|
11102
11298
|
duration?: number;
|
|
11103
11299
|
/**
|
|
11104
|
-
* Occurrence ID
|
|
11300
|
+
* Occurrence ID. The unique identifier for an occurrence of a recurring webinar. [Recurring webinars](https://support.zoom.us/hc/en-us/articles/216354763-How-to-Schedule-A-Recurring-Webinar) can have a maximum of 50 occurrences.
|
|
11105
11301
|
*
|
|
11106
11302
|
* @example 1648194360000
|
|
11107
11303
|
*/
|
|
@@ -11584,6 +11780,61 @@ type MeetingCreateResponse = {
|
|
|
11584
11780
|
* @default false
|
|
11585
11781
|
*/
|
|
11586
11782
|
join_before_host?: boolean;
|
|
11783
|
+
/**
|
|
11784
|
+
* [Q&A](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065237) for meeting.
|
|
11785
|
+
*/
|
|
11786
|
+
question_and_answer?: {
|
|
11787
|
+
/**
|
|
11788
|
+
* * `true` - Enable [Q&A](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065237) for meeting.
|
|
11789
|
+
*
|
|
11790
|
+
* * `false` - Disable Q&A for meeting.
|
|
11791
|
+
*
|
|
11792
|
+
* @example true
|
|
11793
|
+
*/
|
|
11794
|
+
enable?: boolean;
|
|
11795
|
+
/**
|
|
11796
|
+
* * `true`: Allow participants to submit questions.
|
|
11797
|
+
*
|
|
11798
|
+
* * `false`: Do not allow submit questions.
|
|
11799
|
+
*
|
|
11800
|
+
* @example true
|
|
11801
|
+
*/
|
|
11802
|
+
allow_submit_questions?: boolean;
|
|
11803
|
+
/**
|
|
11804
|
+
* * `true` - Allow participants to send questions without providing their name to the host, co-host, and panelists..
|
|
11805
|
+
*
|
|
11806
|
+
* * `false` - Do not allow anonymous questions.(Not supported for simulive meeting.)
|
|
11807
|
+
*
|
|
11808
|
+
* @example true
|
|
11809
|
+
*/
|
|
11810
|
+
allow_anonymous_questions?: boolean;
|
|
11811
|
+
/**
|
|
11812
|
+
* Indicate whether you want attendees to be able to view answered questions only or view all questions.
|
|
11813
|
+
*
|
|
11814
|
+
* * `answered` - Attendees are able to view answered questions only.
|
|
11815
|
+
*
|
|
11816
|
+
* * `all` - Attendees are able to view all questions submitted in the Q&A.
|
|
11817
|
+
*
|
|
11818
|
+
* @example all
|
|
11819
|
+
*/
|
|
11820
|
+
question_visibility?: 'answered' | 'all';
|
|
11821
|
+
/**
|
|
11822
|
+
* * `true` - Attendees can answer questions or leave a comment in the question thread.
|
|
11823
|
+
*
|
|
11824
|
+
* * `false` - Attendees can not answer questions or leave a comment in the question thread
|
|
11825
|
+
*
|
|
11826
|
+
* @example true
|
|
11827
|
+
*/
|
|
11828
|
+
attendees_can_comment?: boolean;
|
|
11829
|
+
/**
|
|
11830
|
+
* * `true` - Attendees can click the thumbs up button to bring popular questions to the top of the Q&A window.
|
|
11831
|
+
*
|
|
11832
|
+
* * `false` - Attendees can not click the thumbs up button on questions.
|
|
11833
|
+
*
|
|
11834
|
+
* @example true
|
|
11835
|
+
*/
|
|
11836
|
+
attendees_can_upvote?: boolean;
|
|
11837
|
+
};
|
|
11587
11838
|
/**
|
|
11588
11839
|
* The meeting's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details.
|
|
11589
11840
|
*
|
|
@@ -11962,8 +12213,11 @@ type MeetingCreateRequestBody = {
|
|
|
11962
12213
|
duration?: number;
|
|
11963
12214
|
/**
|
|
11964
12215
|
* The passcode required to join the meeting. By default, a passcode can **only** have a maximum length of 10 characters and only contain alphanumeric characters and the `@`, `-`, `_`, and `*` characters.
|
|
12216
|
+
*
|
|
12217
|
+
* **Note:**
|
|
11965
12218
|
* * If the account owner or administrator has configured [minimum passcode requirement settings](https://support.zoom.us/hc/en-us/articles/360033559832-Meeting-and-webinar-passwords#h_a427384b-e383-4f80-864d-794bf0a37604), the passcode **must** meet those requirements.
|
|
11966
|
-
* * If passcode requirements are enabled, use the [**Get user settings**](https://developers.zoom.us/docs/api
|
|
12219
|
+
* * If passcode requirements are enabled, use the [**Get user settings**](https://developers.zoom.us/docs/api/users/#tag/users/GET/users/{userId}/settings) API or the [**Get account settings**](https://developers.zoom.us/docs/api/accounts/#tag/accounts/GET/accounts/{accountId}/settings) API to get the requirements.
|
|
12220
|
+
* * If the **Require a passcode when scheduling new meetings** account setting is enabled and locked, a passcode will be automatically generated if one is not provided.
|
|
11967
12221
|
*
|
|
11968
12222
|
* @maxLength 10
|
|
11969
12223
|
* @example 123456
|
|
@@ -11998,16 +12252,16 @@ type MeetingCreateRequestBody = {
|
|
|
11998
12252
|
*/
|
|
11999
12253
|
end_times?: number;
|
|
12000
12254
|
/**
|
|
12001
|
-
* Use this field **only if you're scheduling a recurring meeting of type
|
|
12255
|
+
* Use this field **only** if you're scheduling a **recurring meeting of type `3`** to state the day in a month when the meeting should recur. The value range is from `1` to `31`.
|
|
12002
12256
|
*
|
|
12003
|
-
* For the meeting to recur on 23rd of each month, provide `23` as this field's value and `1` as the `repeat_interval` field's value.
|
|
12257
|
+
* For the meeting to recur on 23rd of each month, provide `23` as this field's value and `1` as the `repeat_interval` field's value. To have the meeting recur every three months on 23rd of the month, change the `repeat_interval` field value to `3`.
|
|
12004
12258
|
*
|
|
12005
12259
|
* @example 1
|
|
12006
12260
|
* @default 1
|
|
12007
12261
|
*/
|
|
12008
12262
|
monthly_day?: number;
|
|
12009
12263
|
/**
|
|
12010
|
-
* Use this field **only if you're scheduling a recurring meeting of type
|
|
12264
|
+
* Use this field **only if** you're scheduling a **recurring meeting of type `3`** to state the week of the month when the meeting should recur. If you use this field, you must also use the `monthly_week_day` field to state the day of the week when the meeting should recur.
|
|
12011
12265
|
* `-1` - Last week of the month.
|
|
12012
12266
|
* `1` - First week of the month.
|
|
12013
12267
|
* `2` - Second week of the month.
|
|
@@ -12018,7 +12272,7 @@ type MeetingCreateRequestBody = {
|
|
|
12018
12272
|
*/
|
|
12019
12273
|
monthly_week?: -1 | 1 | 2 | 3 | 4;
|
|
12020
12274
|
/**
|
|
12021
|
-
* Use this field **only if you're scheduling a recurring meeting of type
|
|
12275
|
+
* Use this field **only if** you're scheduling a **recurring meeting of type `3`** to state a specific day in a week when the monthly meeting should recur. To use this field, you must also use the `monthly_week` field.
|
|
12022
12276
|
*
|
|
12023
12277
|
*
|
|
12024
12278
|
* `1` - Sunday.
|
|
@@ -12050,11 +12304,11 @@ type MeetingCreateRequestBody = {
|
|
|
12050
12304
|
*/
|
|
12051
12305
|
type: 1 | 2 | 3;
|
|
12052
12306
|
/**
|
|
12053
|
-
*
|
|
12307
|
+
* **Required** if you're scheduling a recurring meeting of type `2` to state the days of the week when the meeting should repeat.
|
|
12054
12308
|
*
|
|
12055
|
-
*
|
|
12309
|
+
* This field's value could be a number between `1` to `7` in string format. For instance, if the meeting should recur on Sunday, provide `1` as this field's value.
|
|
12056
12310
|
*
|
|
12057
|
-
*
|
|
12311
|
+
* **Note:** To set the meeting to occur on multiple days of a week, provide comma separated values for this field. For instance, if the meeting should recur on Sundays and Tuesdays, provide `1,3` as this field's value.
|
|
12058
12312
|
*
|
|
12059
12313
|
*
|
|
12060
12314
|
* `1` - Sunday.
|
|
@@ -12158,7 +12412,7 @@ type MeetingCreateRequestBody = {
|
|
|
12158
12412
|
*/
|
|
12159
12413
|
audio?: 'both' | 'telephony' | 'voip' | 'thirdParty';
|
|
12160
12414
|
/**
|
|
12161
|
-
* Third party audio conference
|
|
12415
|
+
* Third party audio conference information.
|
|
12162
12416
|
*
|
|
12163
12417
|
* @maxLength 2048
|
|
12164
12418
|
* @example test
|
|
@@ -12171,7 +12425,7 @@ type MeetingCreateRequestBody = {
|
|
|
12171
12425
|
*/
|
|
12172
12426
|
authentication_domains?: string;
|
|
12173
12427
|
/**
|
|
12174
|
-
* A list of participants
|
|
12428
|
+
* A list of participants who can bypass meeting authentication. These participants will receive a unique meeting invite.
|
|
12175
12429
|
*/
|
|
12176
12430
|
authentication_exception?: {
|
|
12177
12431
|
/**
|
|
@@ -12330,6 +12584,61 @@ type MeetingCreateRequestBody = {
|
|
|
12330
12584
|
* @default false
|
|
12331
12585
|
*/
|
|
12332
12586
|
join_before_host?: boolean;
|
|
12587
|
+
/**
|
|
12588
|
+
* [Q&A](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065237) for meeting.
|
|
12589
|
+
*/
|
|
12590
|
+
question_and_answer?: {
|
|
12591
|
+
/**
|
|
12592
|
+
* * `true` - Enable [Q&A](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0065237) for meeting.
|
|
12593
|
+
*
|
|
12594
|
+
* * `false` - Disable Q&A for meeting.
|
|
12595
|
+
*
|
|
12596
|
+
* @example true
|
|
12597
|
+
*/
|
|
12598
|
+
enable?: boolean;
|
|
12599
|
+
/**
|
|
12600
|
+
* * `true` - Allow participants to submit questions.
|
|
12601
|
+
*
|
|
12602
|
+
* * `false` - Don't allow participants to submit questions.
|
|
12603
|
+
*
|
|
12604
|
+
* @example true
|
|
12605
|
+
*/
|
|
12606
|
+
allow_submit_questions?: boolean;
|
|
12607
|
+
/**
|
|
12608
|
+
* * `true` - Allow participants to send questions without providing their name to the host, co-host, and panelists..
|
|
12609
|
+
*
|
|
12610
|
+
* * `false` - Do not allow anonymous questions.(Not supported for simulive meeting.)
|
|
12611
|
+
*
|
|
12612
|
+
* @example true
|
|
12613
|
+
*/
|
|
12614
|
+
allow_anonymous_questions?: boolean;
|
|
12615
|
+
/**
|
|
12616
|
+
* Indicate whether you want to allow attendees to be able to view only answered questions or all questions.
|
|
12617
|
+
*
|
|
12618
|
+
* * `answered` - Attendees are able to view answered questions only.
|
|
12619
|
+
*
|
|
12620
|
+
* * `all` - Attendees are able to view all questions submitted in the Q&A.
|
|
12621
|
+
*
|
|
12622
|
+
* @example all
|
|
12623
|
+
*/
|
|
12624
|
+
question_visibility?: 'answered' | 'all';
|
|
12625
|
+
/**
|
|
12626
|
+
* * `true` - Attendees can answer questions or leave a comment in the question thread.
|
|
12627
|
+
*
|
|
12628
|
+
* * `false` - Attendees can not answer questions or leave a comment in the question thread
|
|
12629
|
+
*
|
|
12630
|
+
* @example true
|
|
12631
|
+
*/
|
|
12632
|
+
attendees_can_comment?: boolean;
|
|
12633
|
+
/**
|
|
12634
|
+
* * `true` - Attendees can select the thumbs up button to bring popular questions to the top of the Q&A window.
|
|
12635
|
+
*
|
|
12636
|
+
* * `false` - Attendees can't select the thumbs up button on questions.
|
|
12637
|
+
*
|
|
12638
|
+
* @example true
|
|
12639
|
+
*/
|
|
12640
|
+
attendees_can_upvote?: boolean;
|
|
12641
|
+
};
|
|
12333
12642
|
/**
|
|
12334
12643
|
* The meeting's [language interpretation settings](https://support.zoom.us/hc/en-us/articles/360034919791-Language-interpretation-in-meetings-and-webinars). Make sure to add the language in the web portal in order to use it in the API. See link for details.
|
|
12335
12644
|
*
|
|
@@ -12669,16 +12978,13 @@ type MeetingCreateVariables = {
|
|
|
12669
12978
|
pathParams: MeetingCreatePathParams;
|
|
12670
12979
|
} & FetcherExtraProps;
|
|
12671
12980
|
/**
|
|
12672
|
-
* [
|
|
12981
|
+
* [Create 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/rest/using-zoom-apis/#the-me-keyword) instead of the `userId` parameter.
|
|
12673
12982
|
*
|
|
12674
|
-
*
|
|
12675
|
-
* *
|
|
12676
|
-
*
|
|
12677
|
-
* **
|
|
12678
|
-
*
|
|
12679
|
-
* For security reasons, the recommended way to programmatically get the updated `start_url` value after expiry is to call the [**Get a meeting**](https://developers.zoom.us/docs/api/meetings/#tag/meetings/GET/meetings/%7BmeetingId%7D) API. Refer to the `start_url` value in the response.
|
|
12680
|
-
*
|
|
12681
|
-
* **100 requests per day**. The rate limit is applied against the `userId` of the **meeting host** used to make the request.
|
|
12983
|
+
* **Prerequisites:**
|
|
12984
|
+
* * 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.
|
|
12985
|
+
* * 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`.
|
|
12986
|
+
* * 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.
|
|
12987
|
+
* * **100 requests per day**. The rate limit is applied against the `userId` of the **meeting host** used to make the request.
|
|
12682
12988
|
*
|
|
12683
12989
|
* **Scopes:** `meeting:write:admin`,`meeting:write`
|
|
12684
12990
|
*
|
|
@@ -13449,7 +13755,7 @@ type ReportMeetingactivitylogsVariables = {
|
|
|
13449
13755
|
queryParams: ReportMeetingactivitylogsQueryParams;
|
|
13450
13756
|
} & FetcherExtraProps;
|
|
13451
13757
|
/**
|
|
13452
|
-
* Retrieve a list of a meeting activity logs.
|
|
13758
|
+
* Retrieve a list of a meeting activity logs. Contact Zoom Support to enable the meeting audit trail log feature on your account.
|
|
13453
13759
|
*
|
|
13454
13760
|
* **Scopes:** `report:read:admin`
|
|
13455
13761
|
*
|