1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369
use crate::Client;
use crate::ClientResult;
pub struct Meetings {
pub client: Client,
}
impl Meetings {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
Meetings { client }
}
/**
* List meetings.
*
* This function performs a `GET` to the `/users/{userId}/meetings` endpoint.
*
* List all the meetings that were scheduled for a user (meeting host). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* This API **only** supports scheduled meetings. This API does not return information about instant meetings.
*
* **Scopes:** `meeting:read:admin`, `meeting:read`</br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
* * `type_: crate::types::MeetingsType` -- The meeting types: <br>`scheduled` - This includes all valid past meetings (unexpired), live meetings and upcoming scheduled meetings. It is equivalent to the combined list of "Previous Meetings" and "Upcoming Meetings" displayed in the user's [Meetings page](https://zoom.us/meeting) on the Zoom Web Portal.<br>`live` - All the ongoing meetings.<br>`upcoming` - All upcoming meetings including live meetings.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `next_page_token: &str` -- The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
* * `page_number: &str` -- The page number of the current page in the returned records.
*/
pub async fn get(
&self,
user_id: &str,
type_: crate::types::MeetingsType,
page_size: i64,
next_page_token: &str,
page_number: &str,
) -> ClientResult<crate::Response<crate::types::Domains>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if !page_number.is_empty() {
query_args.push(("page_number".to_string(), page_number.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !type_.to_string().is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/users/{}/meetings?{}",
crate::progenitor_support::encode_path(user_id),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Create a meeting.
*
* This function performs a `POST` to the `/users/{userId}/meetings` endpoint.
*
* [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](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* This API has a daily rate limit of 100 requests per day. Therefore, only 100 **Create a Meeting** API requests are permitted within a 24 hour window for a user.<br>
*
* <aside>The <code>start_url</code> of a meeting is a URL using which a host or an alternative host can start a meeting. The expiration time for the <code>start_url</code> field is two hours for all regular users.
*
* For custCreate meeting hosts( i.e., users created using the <code>custCreate</code> option via the [Create Users](https://marketplace.zoom.us/docs/api-reference/zoom-api/users/usercreate) API), the expiration time of the <code>start_url</code> field is 90 days from the generation of the <code>start_url</code>.
*
* For security reasons, the recommended way to retrieve the updated value for the <code>start_url</code> field programmatically (after expiry) is by calling the [Retrieve a Meeting API](https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meeting) and referring to the value of the <code>start_url</code> field in the response.</aside><br><br>
* Scopes: `meeting:write:admin` `meeting:write`
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
*/
pub async fn create(
&self,
user_id: &str,
body: &crate::types::MeetingCreate,
) -> ClientResult<crate::Response<crate::types::MeetingCreateResponseAllOf>> {
let url = self.client.url(
&format!(
"/users/{}/meetings",
crate::progenitor_support::encode_path(user_id),
),
None,
);
self.client
.post(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Get a meeting.
*
* This function performs a `GET` to the `/meetings/{meetingId}` endpoint.
*
* Retrieve the details of a meeting.<br><br>
* **Scopes:** `meeting:read:admin` `meeting:read`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
* * `occurrence_id: &str` -- Meeting Occurrence ID. Provide this field to view meeting details of a particular occurrence of the [recurring meeting](https://support.zoom.us/hc/en-us/articles/214973206-Scheduling-Recurring-Meetings).
* * `show_previous_occurrences: bool` -- Enable/disable the option for a sub account to use shared [Virtual Room Connector(s)](https://support.zoom.us/hc/en-us/articles/202134758-Getting-Started-With-Virtual-Room-Connector) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users.
*/
pub async fn meeting(
&self,
meeting_id: i64,
occurrence_id: &str,
show_previous_occurrences: bool,
) -> ClientResult<crate::Response<crate::types::MeetingResponseAllOf>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !occurrence_id.is_empty() {
query_args.push(("occurrence_id".to_string(), occurrence_id.to_string()));
}
if show_previous_occurrences {
query_args.push((
"show_previous_occurrences".to_string(),
show_previous_occurrences.to_string(),
));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/meetings/{}?{}",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Delete a meeting.
*
* This function performs a `DELETE` to the `/meetings/{meetingId}` endpoint.
*
* Delete a meeting.<br><br>
* **Scopes:** `meeting:write:admin` `meeting:write`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
* * `occurrence_id: &str` -- The meeting occurrence ID.
* * `schedule_for_reminder: bool` -- Enable/disable the option for a sub account to use shared [Virtual Room Connector(s)](https://support.zoom.us/hc/en-us/articles/202134758-Getting-Started-With-Virtual-Room-Connector) that are set up by the master account. Virtual Room Connectors can only be used by On-prem users.
* * `cancel_meeting_reminder: &str` -- `true`: Notify registrants about the meeting cancellation via email.
*
* `false`: Do not send any email notification to meeting registrants.
*
* The default value of this field is `false`.
*/
pub async fn delete(
&self,
meeting_id: i64,
occurrence_id: &str,
schedule_for_reminder: bool,
cancel_meeting_reminder: &str,
) -> ClientResult<crate::Response<()>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !cancel_meeting_reminder.is_empty() {
query_args.push((
"cancel_meeting_reminder".to_string(),
cancel_meeting_reminder.to_string(),
));
}
if !occurrence_id.is_empty() {
query_args.push(("occurrence_id".to_string(), occurrence_id.to_string()));
}
if schedule_for_reminder {
query_args.push((
"schedule_for_reminder".to_string(),
schedule_for_reminder.to_string(),
));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/meetings/{}?{}",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
query_
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update a meeting.
*
* This function performs a `PATCH` to the `/meetings/{meetingId}` endpoint.
*
* Update the details of a meeting. This API has a rate limit of 100 requests per day. Because of this, a meeting can only be updated for a maximum of 100 times within a 24 hour period.
*
* **Scopes:** `meeting:write:admin`, `meeting:write`</br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
* * `occurrence_id: &str` -- Meeting occurrence id. Support change of agenda, start_time, duration, settings: {host_video, participant_video, join_before_host, mute_upon_entry, waiting_room, watermark, auto_recording}.
*/
pub async fn update(
&self,
meeting_id: i64,
occurrence_id: &str,
body: &crate::types::MeetingUpdateRequestAllOf,
) -> ClientResult<crate::Response<()>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !occurrence_id.is_empty() {
query_args.push(("occurrence_id".to_string(), occurrence_id.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/meetings/{}?{}",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
query_
),
None,
);
self.client
.patch(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Update meeting status.
*
* This function performs a `PUT` to the `/meetings/{meetingId}/status` endpoint.
*
* Update the status of a meeting.<br><br>
* **Scopes:** `meeting:write:admin` `meeting:write`
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
*/
pub async fn status(
&self,
meeting_id: i64,
body: &crate::types::MeetingStatusRequest,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/meetings/{}/status",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
),
None,
);
self.client
.put(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* List meeting registrants.
*
* This function performs a `GET` to the `/meetings/{meetingId}/registrants` endpoint.
*
* 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). Use this API to list users that have registered for a meeting.<br><br>
* **Scopes**: `meeting:read:admin` `meeting:read`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
* * `occurrence_id: &str` -- The meeting occurrence ID.
* * `status: crate::types::MeetingRegistrantsStatus` -- The registrant status:<br>`pending` - Registrant's status is pending.<br>`approved` - Registrant's status is approved.<br>`denied` - Registrant's status is denied.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `page_number: i64` --
* **Deprecated** - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field.
*
* The page number of the current page in the returned records.
* * `next_page_token: &str` -- The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
*/
pub async fn registrant(
&self,
meeting_id: i64,
occurrence_id: &str,
status: crate::types::MeetingRegistrantsStatus,
page_size: i64,
page_number: i64,
next_page_token: &str,
) -> ClientResult<crate::Response<crate::types::Domains>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if !occurrence_id.is_empty() {
query_args.push(("occurrence_id".to_string(), occurrence_id.to_string()));
}
if page_number > 0 {
query_args.push(("page_number".to_string(), page_number.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !status.to_string().is_empty() {
query_args.push(("status".to_string(), status.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/meetings/{}/registrants?{}",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Add meeting registrant.
*
* This function performs a `POST` to the `/meetings/{meetingId}/registrants` endpoint.
*
* Register a participant for a meeting.<br><br> Note that there is a maximum limit of 4999 registrants per meeting and users will see an error if the capacity has reached.
*
* **Prerequisite:**<br>
* * Host user type must be "Licensed".
*
* **Scopes:** `meeting:write:admin` `meeting:write`
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
* * `occurrence_ids: &str` -- Occurrence IDs. You can find these with the meeting get API. Multiple values separated by comma.
*/
pub async fn registrant_create(
&self,
meeting_id: i64,
occurrence_ids: &str,
) -> ClientResult<crate::Response<crate::types::MeetingRegistrantCreateResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !occurrence_ids.is_empty() {
query_args.push(("occurrence_ids".to_string(), occurrence_ids.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/meetings/{}/registrants?{}",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
query_
),
None,
);
self.client
.post(
&url,
crate::Message {
body: None,
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Delete a meeting registrant.
*
* This function performs a `DELETE` to the `/meetings/{meetingId}/registrants/{registrantId}` endpoint.
*
* Delete a meeting registrant.<br><br>
* **Scopes**: `meeting:write:admin` `meeting:write`<br>
* <br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `occurrence_id: &str` -- The meeting occurence ID.
* * `meeting_id: i64` -- Account seats.
* * `registrant_id: &str` -- The meeting registrant ID.
*/
pub async fn meetingregistrantdelete(
&self,
occurrence_id: &str,
meeting_id: i64,
registrant_id: &str,
) -> ClientResult<crate::Response<()>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !occurrence_id.is_empty() {
query_args.push(("occurrence_id".to_string(), occurrence_id.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/meetings/{}/registrants/{}?{}",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
crate::progenitor_support::encode_path(registrant_id),
query_
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update registrant's status.
*
* This function performs a `PUT` to the `/meetings/{meetingId}/registrants/status` endpoint.
*
* Update a meeting registrant's status by either approving, cancelling or denying a registrant from joining the meeting.<br><br>
* **Scopes:** `meeting:write:admin` `meeting:write`
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
* * `occurrence_id: &str` -- The meeting occurrence ID.
*/
pub async fn registrant_status(
&self,
meeting_id: i64,
occurrence_id: &str,
body: &crate::types::RegistrantStatus,
) -> ClientResult<crate::Response<()>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !occurrence_id.is_empty() {
query_args.push(("occurrence_id".to_string(), occurrence_id.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/meetings/{}/registrants/status?{}",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
query_
),
None,
);
self.client
.put(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Get past meeting details.
*
* This function performs a `GET` to the `/past_meetings/{meetingUUID}` endpoint.
*
* Get details on a past meeting. <br><br>
* **Scopes:** `meeting:read:admin` `meeting:read`
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
* > **Note**: Please double encode your UUID when using this API if the UUID begins with a '/'or contains '//' in it.
*
* **Parameters:**
*
* * `meeting: &str` -- The meeting's universally unique identifier (UUID). Each meeting instance generates a UUID. For example, after a meeting ends, a new UUID is generated for the next meeting instance.
*
* If the meeting UUID begins with a `/` character or contains a `//` character, you **must** double-encode the meeting UUID when using the meeting UUID for other API calls.
*/
pub async fn past_details(
&self,
meeting_uuid: &str,
) -> ClientResult<crate::Response<crate::types::PastMeetingDetailsResponse>> {
let url = self.client.url(
&format!(
"/past_meetings/{}",
crate::progenitor_support::encode_path(meeting_uuid),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get past meeting participants.
*
* This function performs a `GET` to the `/past_meetings/{meetingUUID}/participants` endpoint.
*
* Retrieve information on participants from a past meeting. <br><br>
* **Scopes:** `meeting:read:admin` `meeting:read`
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
* **Prerequisites:**<br>
* * Paid account on a Pro or higher plan.
*
* <br> <br> **Note**: Please double encode your UUID when using this API if the UUID begins with a '/'or contains '//' in it.
*
*
* **Parameters:**
*
* * `meeting: &str` -- The meeting's universally unique identifier (UUID). Each meeting instance generates a UUID. For example, after a meeting ends, a new UUID is generated for the next meeting instance.
*
* If the meeting UUID begins with a `/` character or contains a `//` character, you **must** double-encode the meeting UUID when using the meeting UUID for other API calls.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `next_page_token: &str` -- The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.
*/
pub async fn past_participant(
&self,
meeting_uuid: &str,
page_size: i64,
next_page_token: &str,
) -> ClientResult<crate::Response<crate::types::PastMeetingParticipantsResponseAllOf>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = self.client.url(
&format!(
"/past_meetings/{}/participants?{}",
crate::progenitor_support::encode_path(meeting_uuid),
query_
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* List ended meeting instances.
*
* This function performs a `GET` to the `/past_meetings/{meetingId}/instances` endpoint.
*
* Get a list of ended meeting instances<br><br>
* **Scopes:** `meeting:read:admin` `meeting:read`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
*/
pub async fn past(
&self,
meeting_id: i64,
) -> ClientResult<crate::Response<crate::types::Domains>> {
let url = self.client.url(
&format!(
"/past_meetings/{}/instances",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* List meeting polls.
*
* This function performs a `GET` to the `/meetings/{meetingId}/polls` endpoint.
*
* Polls allow the meeting host to survey attendees. Use this API to list [polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) of a meeting.<br><br>
*
* **Scopes**: `meeting:read:admin` `meeting:read`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`<br>
* **Prerequisites**:<br>
* * Host user type must be **Pro** or higher plan.
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
*/
pub async fn poll(
&self,
meeting_id: i64,
) -> ClientResult<crate::Response<crate::types::Domains>> {
let url = self.client.url(
&format!(
"/meetings/{}/polls",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Create a meeting poll.
*
* This function performs a `POST` to the `/meetings/{meetingId}/polls` endpoint.
*
* Polls allow the meeting host to survey attendees. Use this API to create a [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting.<br><br>
*
* **Scopes**: `meeting:write:admin` `meeting:write`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`<br>
* **Prerequisites**:<br>
* * Host user type must be **Pro** or higher plan.
* * Polling feature must be enabled in the host's account.
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
*/
pub async fn poll_create(
&self,
meeting_id: i64,
body: &crate::types::Poll,
) -> ClientResult<crate::Response<crate::types::MeetingPollGetResponseAllOf>> {
let url = self.client.url(
&format!(
"/meetings/{}/polls",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
),
None,
);
self.client
.post(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Get a meeting poll.
*
* This function performs a `GET` to the `/meetings/{meetingId}/polls/{pollId}` endpoint.
*
* Polls allow the meeting host to survey attendees. Use this API to get information about a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).<br><br>
* **Scopes**: `meeting:read:admin` `meeting:read`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
*
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
* * `poll_id: &str` -- User's first name.
*/
pub async fn poll_get(
&self,
meeting_id: i64,
poll_id: &str,
) -> ClientResult<crate::Response<crate::types::MeetingPollGetResponseAllOf>> {
let url = self.client.url(
&format!(
"/meetings/{}/polls/{}",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
crate::progenitor_support::encode_path(poll_id),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update a meeting poll.
*
* This function performs a `PUT` to the `/meetings/{meetingId}/polls/{pollId}` endpoint.
*
* Polls allow the meeting host to survey attendees. Use this API to update information of a specific meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings)<br><br>
* **Scopes**: `meeting:write:admin` `meeting:write`
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
* * `poll_id: &str` -- User's first name.
*/
pub async fn poll_update(
&self,
meeting_id: i64,
poll_id: &str,
body: &crate::types::Poll,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/meetings/{}/polls/{}",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
crate::progenitor_support::encode_path(poll_id),
),
None,
);
self.client
.put(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Delete a meeting poll.
*
* This function performs a `DELETE` to the `/meetings/{meetingId}/polls/{pollId}` endpoint.
*
* Polls allow the meeting host to survey attendees. Use this API to delete a meeting [poll](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings).<br>
* **Scopes**: `meeting:write:admin` `meeting:write`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` <br>
* **Prerequisites**:<br>
* * Host user type must be **Pro**.
* * Polling feature should be enabled in the host's account.
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
* * `poll_id: &str` -- User's first name.
*/
pub async fn poll_delete(
&self,
meeting_id: i64,
poll_id: &str,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/meetings/{}/polls/{}",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
crate::progenitor_support::encode_path(poll_id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* List registration questions .
*
* This function performs a `GET` to the `/meetings/{meetingId}/registrants/questions` endpoint.
*
* 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).<br>
*
* **Scopes:** `meeting:read`, `meeting:read:admin`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
*/
pub async fn registrants_questions_get(
&self,
meeting_id: i64,
) -> ClientResult<crate::Response<crate::types::MeetingRegistrantQuestionsData>> {
let url = self.client.url(
&format!(
"/meetings/{}/registrants/questions",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update registration questions.
*
* This function performs a `PATCH` to the `/meetings/{meetingId}/registrants/questions` endpoint.
*
* 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).<br><br>
* **Scopes:** `meeting:write`, `meeting:write:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
*
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
*/
pub async fn registrant_question_update(
&self,
meeting_id: i64,
body: &crate::types::MeetingRegistrantQuestionsData,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/meetings/{}/registrants/questions",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
),
None,
);
self.client
.patch(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Get meeting invitation.
*
* This function performs a `GET` to the `/meetings/{meetingId}/invitation` endpoint.
*
* Retrieve the meeting invite note that was sent for a specific meeting.<br><br>
* **Scopes:** `meeting:read:admin` `meeting:read`<br>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
*/
pub async fn invitation(
&self,
meeting_id: i64,
) -> ClientResult<crate::Response<crate::types::MeetingInvitation>> {
let url = self.client.url(
&format!(
"/meetings/{}/invitation",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Get live stream details.
*
* This function performs a `GET` to the `/meetings/{meetingId}/livestream` endpoint.
*
* Zoom allows users to [live stream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to get a meeting's live stream configuration details such as Stream URL, Stream Key and Page URL.<br><br>
* **Prerequisites:**<br>
* * Meeting host must be a licensed user with a Pro or higher plan.<br>
* * 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.<br><br>
* **Scopes:** `meeting:read:admin` `meeting:read`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
*
*
*
* **Parameters:**
*
* * `meeting_id: &str` -- Unique identifier of the meeting.
*/
pub async fn get_live_stream_details(
&self,
meeting_id: &str,
) -> ClientResult<crate::Response<crate::types::GetLiveStreamDetailsResponse>> {
let url = self.client.url(
&format!(
"/meetings/{}/livestream",
crate::progenitor_support::encode_path(meeting_id),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update a live stream.
*
* This function performs a `PATCH` to the `/meetings/{meetingId}/livestream` endpoint.
*
* Use this API to update a meeting's live stream information. Zoom allows users to [live stream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform.
*
* **Scopes:** `meeting:write:admin`, `meeting:write`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Meeting host must have a Pro license.
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
*/
pub async fn live_stream_update(
&self,
meeting_id: &str,
body: &crate::types::MeetingLiveStream,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/meetings/{}/livestream",
crate::progenitor_support::encode_path(meeting_id),
),
None,
);
self.client
.patch(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Update Live Stream Status.
*
* This function performs a `PATCH` to the `/meetings/{meetingId}/livestream/status` endpoint.
*
* Zoom allows users to [live stream a meeting](https://support.zoom.us/hc/en-us/articles/115001777826-Live-Streaming-Meetings-or-Webinars-Using-a-Custom-Service) to a custom platform. Use this API to update the status of a meeting's live stream.<br><br>
* **Prerequisites:**<br>
* * Meeting host must have a Pro license.<br>
* **Scopes:** `meeting:write:admin` `meeting:write`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
*
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
*/
pub async fn live_stream_status_update(
&self,
meeting_id: i64,
body: &crate::types::MeetingLiveStreamStatus,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/meetings/{}/livestream/status",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
),
None,
);
self.client
.patch(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* List past meeting's poll results.
*
* This function performs a `GET` to the `/past_meetings/{meetingId}/polls` endpoint.
*
* [Polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) allow the meeting host to survey attendees. Use this API to list poll results of a meeting.<br><br>
*
* **Scopes**: `meeting:read:admin`, `meeting:read`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` <br>
* **Prerequisites**:<br>
* * Host user type must be **Pro**.
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
*
* **Parameters:**
*
* * `meeting_id: &str` -- The meeting ID or the meeting UUID. If a meeting ID is provided in the request instead of a UUID, the response will be for the latest meeting instance.
*
* If a UUID starts with "/" or contains "//" (example: "/ajXp112QmuoKj4854875==\"), you must **double encode** the UUID before making an API request.
*/
pub async fn list_past_polls(
&self,
meeting_id: &str,
) -> ClientResult<crate::Response<crate::types::ReportMeetingPollsResponse>> {
let url = self.client.url(
&format!(
"/past_meetings/{}/polls",
crate::progenitor_support::encode_path(meeting_id),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Perform batch registration.
*
* This function performs a `POST` to the `/meetings/{meetingId}/batch_registrants` endpoint.
*
* 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). <br>
*
* **Prerequisites:**<br>
* * The meeting host must be a Licensed user.
* * 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.<br><br>
* **Scope:** `meeting:write`, `meeting:write:admin`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>
*
*
*
*
*
*
*
*
*
* **Parameters:**
*
* * `meeting_id: &str` -- Unique identifier of the meeting (Meeting Number).
*/
pub async fn add_batch_registrants(
&self,
meeting_id: &str,
body: &crate::types::AddBatchRegistrantsRequest,
) -> ClientResult<crate::Response<crate::types::AddBatchRegistrantsResponse>> {
let url = self.client.url(
&format!(
"/meetings/{}/batch_registrants",
crate::progenitor_support::encode_path(meeting_id),
),
None,
);
self.client
.post(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Use in-Meeting recording controls.
*
* This function performs a `PATCH` to the `/live_meetings/{meetingId}/events` endpoint.
*
* Use this API to control the [in-meeting](https://support.zoom.us/hc/en-us/articles/360021921032-In-Meeting-Controls) **recording features** such as starting a recording, stopping a recording, pausing a recording, and resuming a recording. This API only works for Cloud Recordings and not for local recordings.
*
*
* **Prerequisite:**
* * The meeting must be a live meeting.
* * Cloud Recording must be enabled.
* * The user using this API must either be the host or alternative host of the meeting.
*
* **Scopes:** `meeting:write`, `meeting:write:admin`, `meeting:master`
*
* **Parameters:**
*
* * `meeting_id: &str` -- Unique identifier of the live meeting.
*/
pub async fn recording_control(
&self,
meeting_id: &str,
body: &crate::types::InMeetingRecordingControlRequest,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/live_meetings/{}/events",
crate::progenitor_support::encode_path(meeting_id),
),
None,
);
self.client
.patch(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Get meeting quality score.
*
* This function performs a `GET` to the `/metrics/quality` endpoint.
*
* Get the quality scores of a meeting.
*/
pub async fn quality_score(&self) -> ClientResult<crate::Response<crate::types::Domains>> {
let url = self.client.url("/metrics/quality", None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Perform batch poll creation.
*
* This function performs a `POST` to the `/meetings/{meetingId}/batch_polls` endpoint.
*
* Polls allow the meeting host to survey attendees. Use this API to create batch [polls](https://support.zoom.us/hc/en-us/articles/213756303-Polling-for-Meetings) for a meeting.<br><br>
*
* **Scopes**: `meeting:write:admin` `meeting:write`<br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`<br>
* **Prerequisites**:<br>
* * Host user type must be **Pro** or higher plan.
* * Polling feature must be enabled in the host's account.
* * Meeting must be a scheduled meeting. Instant meetings do not have polling features enabled.
*
* **Parameters:**
*
* * `meeting_id: &str` -- User's first name.
*/
pub async fn create_batch_polls(
&self,
meeting_id: &str,
body: &crate::types::CreateBatchPollsRequest,
) -> ClientResult<crate::Response<crate::types::CreateBatchPollsResponse>> {
let url = self.client.url(
&format!(
"/meetings/{}/batch_polls",
crate::progenitor_support::encode_path(meeting_id),
),
None,
);
self.client
.post(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* List meeting templates.
*
* This function performs a `GET` to the `/users/{userId}/meeting_templates` endpoint.
*
* Use this API to list [meeting templates](https://support.zoom.us/hc/en-us/articles/360036559151-Meeting-templates) that are available to be used by a user. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* **Scopes:** `meeting:read` or `meeting:read:admin`</br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
*
* **Parameters:**
*
* * `user_id: &str` -- Unique identifier of the user. Retrieve the value of this field by calling the [List users](https://marketplace.zoom.us/docs/api-reference/zoom-api/users/users) API.
*/
pub async fn list_template(
&self,
user_id: &str,
) -> ClientResult<crate::Response<crate::types::ListMeetingTemplatesResponseData>> {
let url = self.client.url(
&format!(
"/users/{}/meeting_templates",
crate::progenitor_support::encode_path(user_id),
),
None,
);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Create meeting's invite links.
*
* This function performs a `POST` to the `/meetings/{meetingId}/invite_links` endpoint.
*
* Use this API to create a batch of invitation links for a meeting.
*
* **Scopes**: `meeting:write:admin`, `meeting:write`</br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Parameters:**
*
* * `meeting_id: i64` -- The meeting ID in **long** format. The data type of this field is "long"(represented as int64 in JSON).
*
* While storing it in your database, store it as a **long** data type and **not as an integer**, as the Meeting IDs can be longer than 10 digits.
*/
pub async fn invite_links_create(
&self,
meeting_id: i64,
body: &crate::types::InviteLink,
) -> ClientResult<crate::Response<crate::types::InviteLinks>> {
let url = self.client.url(
&format!(
"/meetings/{}/invite_links",
crate::progenitor_support::encode_path(&meeting_id.to_string()),
),
None,
);
self.client
.post(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
}