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 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437
use anyhow::Result;
use crate::Client;
pub struct Phone {
pub client: Client,
}
impl Phone {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
Phone { client }
}
/**
* Set up a Zoom Phone account.
*
* This function performs a `POST` to the `/accounts/{accountId}/phone/setup` endpoint.
*
* After assigning a Zoom phone license to an account, an admin or account owner can proceed with the [initial Zoom phone set up](https://support.zoom.us/hc/en-us/articles/360001297663-Getting-started-with-Zoom-Phone-admin-#h_5ae26a3a-290c-4a8d-b3b0-6384ed267b13) using this API.
*
* **Scopes:** `phone:write:admin`, `phone:write`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Paid account
* * A Pro or a higher account plan
* * Master account option enabled
*
* **Parameters:**
*
* * `account_id: &str` -- Unique identifier of the account.
*/
pub async fn set_up_account(
&self,
account_id: &str,
body: &crate::types::SetUpAccountRequest,
) -> Result<()> {
let url = format!(
"/accounts/{}/phone/setup",
crate::progenitor_support::encode_path(account_id),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* List phone numbers.
*
* This function performs a `GET` to the `/phone/numbers` endpoint.
*
* Use this API to list all Zoom Phone numbers in a Zoom account.
*
* **Scopes:** `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Prerequisites:**
* * A Pro or higher account plan
* * A Zoom Phone license
*
* **Parameters:**
*
* * `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.
* * `type_: crate::types::ListAccountPhoneNumbersType` -- Query response by number assignment. The value can be one of the following:
* <br>
* `assigned`: The number has been assigned to either a user, a call queue, an auto-receptionist or a common area phone in an account. <br>`unassigned`: The number is not assigned to anyone.<br>
* `all`: Include both assigned and unassigned numbers in the response.<br>
* `byoc`: Include Bring Your Own Carrier (BYOC) numbers only in the response.
* * `extension_type: crate::types::ExtensionType` -- The type of assignee to whom the number is assigned. The value can be one of the following:<br>
* `user`<br> `callQueue`<br> `autoReceptionist`<br>
* `commonAreaPhone`.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `number_type: crate::types::Type` -- The type of phone number. The value can be either `toll` or `tollfree`.
* * `pending_numbers: 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.
* * `site_id: &str` -- Unique identifier of the site. Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by a specific phone site. See [Managing multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) or [Adding a site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites#h_05c88e35-1593-491f-b1a8-b7139a75dc15) for details.
*/
pub async fn list_account_numbers(
&self,
next_page_token: &str,
type_: crate::types::ListAccountPhoneNumbersType,
extension_type: crate::types::ExtensionType,
page_size: i64,
number_type: crate::types::Type,
pending_numbers: bool,
site_id: &str,
) -> Result<Vec<crate::types::ListAccountPhoneNumbersResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !extension_type.to_string().is_empty() {
query_args.push(("extension_type".to_string(), extension_type.to_string()));
}
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if !number_type.to_string().is_empty() {
query_args.push(("number_type".to_string(), number_type.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if pending_numbers {
query_args.push(("pending_numbers".to_string(), pending_numbers.to_string()));
}
if !site_id.is_empty() {
query_args.push(("site_id".to_string(), site_id.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 = format!("/phone/numbers?{}", query_);
let resp: crate::types::ListAccountPhoneNumbersResponseData =
self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.phone_numbers.to_vec())
}
/**
* List phone numbers.
*
* This function performs a `GET` to the `/phone/numbers` endpoint.
*
* As opposed to `list_account_numbers`, this function returns all the pages of the request at once.
*
* Use this API to list all Zoom Phone numbers in a Zoom account.
*
* **Scopes:** `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Prerequisites:**
* * A Pro or higher account plan
* * A Zoom Phone license
*/
pub async fn list_all_account_numbers(
&self,
type_: crate::types::ListAccountPhoneNumbersType,
extension_type: crate::types::ExtensionType,
number_type: crate::types::Type,
pending_numbers: bool,
site_id: &str,
) -> Result<Vec<crate::types::ListAccountPhoneNumbersResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !extension_type.to_string().is_empty() {
query_args.push(("extension_type".to_string(), extension_type.to_string()));
}
if !number_type.to_string().is_empty() {
query_args.push(("number_type".to_string(), number_type.to_string()));
}
if pending_numbers {
query_args.push(("pending_numbers".to_string(), pending_numbers.to_string()));
}
if !site_id.is_empty() {
query_args.push(("site_id".to_string(), site_id.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 = format!("/phone/numbers?{}", query_);
let mut resp: crate::types::ListAccountPhoneNumbersResponseData =
self.client.get(&url, None).await?;
let mut phone_numbers = resp.phone_numbers;
let mut page = resp.next_page_token;
// Paginate if we should.
while !page.is_empty() {
// Check if we already have URL params and need to concat the token.
if !url.contains('?') {
resp = self
.client
.get(&format!("{}?next_page_token={}", url, page), None)
.await?;
} else {
resp = self
.client
.get(&format!("{}&next_page_token={}", url, page), None)
.await?;
}
phone_numbers.append(&mut resp.phone_numbers);
if !resp.next_page_token.is_empty() && resp.next_page_token != page {
page = resp.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(phone_numbers)
}
/**
* Get user's profile.
*
* This function performs a `GET` to the `/phone/users/{userId}` endpoint.
*
* Use this API to return a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) profile. 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:** `phone:read`, `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*
* **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 user(&self, user_id: &str) -> Result<crate::types::PhoneUserResponse> {
let url = format!(
"/phone/users/{}",
crate::progenitor_support::encode_path(user_id),
);
self.client.get(&url, None).await
}
/**
* Update user's profile.
*
* This function performs a `PATCH` to the `/phone/users/{userId}` endpoint.
*
* Use this API to update a user's [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) profile. 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:** `phone:write`, `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*/
pub async fn update_user_profile(
&self,
user_id: &str,
body: &crate::types::UpdateUserProfileRequest,
) -> Result<()> {
let url = format!(
"/phone/users/{}",
crate::progenitor_support::encode_path(user_id),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Get account's setting.
*
* This function performs a `GET` to the `/phone/settings` endpoint.
*
* Use this API to return an account's settings.
*
* **Scopes:** `phone:read`, `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*/
pub async fn setting(&self, _account_id: &str) -> Result<crate::types::PhoneSettingResponse> {
let url = "/phone/settings".to_string();
self.client.get(&url, None).await
}
/**
* Update BYOC settings.
*
* This function performs a `PATCH` to the `/phone/settings` endpoint.
*
* [Master account owners](https://marketplace.zoom.us/docs/api-reference/master-account-apis) can use this API to enable the BYOC (Bring Your Own Carrier) option for a subaccount.
*
* **Scopes:** `phone:master`
*
* **Prerequisites:**
* * A Business or Enterprise account
*
* **Parameters:**
*
* * `account_id: &str` -- Unique identifier of the sub account.
*/
pub async fn update_settings(
&self,
_account_id: &str,
body: &crate::types::UpdatePhoneSettingsRequest,
) -> Result<()> {
let url = "/phone/settings".to_string();
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Get user's settings.
*
* This function performs a `GET` to the `/phone/users/{userId}/settings` endpoint.
*
* Use this API to get a user's [Zoom Phone profile settings](https://support.zoom.us/hc/en-us/articles/360021325712-Configuring-Settings). 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:** `phone:read`, `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*
* **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 user_settings(
&self,
user_id: &str,
) -> Result<crate::types::PhoneUserSettingsResponse> {
let url = format!(
"/phone/users/{}/settings",
crate::progenitor_support::encode_path(user_id),
);
self.client.get(&url, None).await
}
/**
* List setting templates.
*
* This function performs a `GET` to the `/phone/setting_templates` endpoint.
*
* Use this API to get a list of all the created phone template settings.
*
* **Scopes:** `phone:read:admin` or `phone:read`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*
* **Parameters:**
*
* * `page_size: i64` -- Number of records returns 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.
* * `site_id: &str` -- Unique identifier of the site. This field is required only if multiple sites have been enabled. of the site. Required only when multiple sites are enabled. See [Managing multiple sites](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites) for details. If this is not provided, the response lists the account level setting templates.
*/
pub async fn list_setting_templates(
&self,
page_size: i64,
next_page_token: &str,
site_id: &str,
) -> Result<Vec<crate::types::Templates>> {
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()));
}
if !site_id.is_empty() {
query_args.push(("site_id".to_string(), site_id.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/phone/setting_templates?{}", query_);
let resp: crate::types::ListSettingTemplatesResponse = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.templates.to_vec())
}
/**
* List setting templates.
*
* This function performs a `GET` to the `/phone/setting_templates` endpoint.
*
* As opposed to `list_setting_templates`, this function returns all the pages of the request at once.
*
* Use this API to get a list of all the created phone template settings.
*
* **Scopes:** `phone:read:admin` or `phone:read`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*/
pub async fn list_all_setting_templates(
&self,
site_id: &str,
) -> Result<Vec<crate::types::Templates>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !site_id.is_empty() {
query_args.push(("site_id".to_string(), site_id.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/phone/setting_templates?{}", query_);
let mut resp: crate::types::ListSettingTemplatesResponse =
self.client.get(&url, None).await?;
let mut templates = resp.templates;
let mut page = resp.next_page_token;
// Paginate if we should.
while !page.is_empty() {
// Check if we already have URL params and need to concat the token.
if !url.contains('?') {
resp = self
.client
.get(&format!("{}?next_page_token={}", url, page), None)
.await?;
} else {
resp = self
.client
.get(&format!("{}&next_page_token={}", url, page), None)
.await?;
}
templates.append(&mut resp.templates);
if !resp.next_page_token.is_empty() && resp.next_page_token != page {
page = resp.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(templates)
}
/**
* Add a setting template.
*
* This function performs a `POST` to the `/phone/setting_templates` endpoint.
*
* Use this API to create a Zoom Phone setting template for an account. After creating a phone template, the defined settings will become the default settings for an account.
*
* **Scopes:** `phone:write:admin`, `phone:write`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or enterprise Zoom account
* * A Zoom Phone license
*/
pub async fn add_setting_template(
&self,
body: &crate::types::AddSettingTemplateRequest,
) -> Result<crate::types::AddSettingTemplateResponse> {
let url = "/phone/setting_templates".to_string();
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Batch add emergency service locations.
*
* This function performs a `POST` to the `/phone/batch_locations` endpoint.
*
* Use this API to batch add emergency service locations.
*/
pub async fn batch_add_locations(
&self,
body: &crate::types::BatchAddLocationsRequest,
) -> Result<Vec<crate::types::BatchAddLocationsResponse>> {
let url = "/phone/batch_locations".to_string();
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* List emergency service locations.
*
* This function performs a `GET` to the `/phone/locations` endpoint.
*
* Use this API to list emergency service locations.
*
* **Scopes:** `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
*
* **Parameters:**
*
* * `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_size: i64` -- The number of records returned within a single API call.
*/
pub async fn list_locations(
&self,
next_page_token: &str,
page_size: i64,
) -> Result<Vec<crate::types::ListLocationsResponse>> {
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 = format!("/phone/locations?{}", query_);
let resp: crate::types::ListLocationsResponseData = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.locations.to_vec())
}
/**
* List emergency service locations.
*
* This function performs a `GET` to the `/phone/locations` endpoint.
*
* As opposed to `list_locations`, this function returns all the pages of the request at once.
*
* Use this API to list emergency service locations.
*
* **Scopes:** `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
*/
pub async fn list_all_locations(&self) -> Result<Vec<crate::types::ListLocationsResponse>> {
let url = "/phone/locations".to_string();
let mut resp: crate::types::ListLocationsResponseData = self.client.get(&url, None).await?;
let mut locations = resp.locations;
let mut page = resp.next_page_token;
// Paginate if we should.
while !page.is_empty() {
// Check if we already have URL params and need to concat the token.
if !url.contains('?') {
resp = self
.client
.get(&format!("{}?next_page_token={}", url, page), None)
.await?;
} else {
resp = self
.client
.get(&format!("{}&next_page_token={}", url, page), None)
.await?;
}
locations.append(&mut resp.locations);
if !resp.next_page_token.is_empty() && resp.next_page_token != page {
page = resp.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(locations)
}
/**
* Add emergency service location.
*
* This function performs a `POST` to the `/phone/locations` endpoint.
*
* Use this API to add an emergency service location.
*
* **Scopes:** `phone:write:adminRate`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
*/
pub async fn add_location(
&self,
body: &crate::types::AddLocationRequest,
) -> Result<Vec<crate::types::Site>> {
let url = "/phone/locations".to_string();
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Get emergency service location details.
*
* This function performs a `GET` to the `/phone/locations/{locationId}` endpoint.
*
* Use this API to return an emergency service location's information.
*
* **Scopes:** `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
*
* **Parameters:**
*
* * `location_id: &str` -- The emergency service location's ID.
*/
pub async fn get_location(
&self,
location_id: &str,
) -> Result<crate::types::GetLocationResponse> {
let url = format!(
"/phone/locations/{}",
crate::progenitor_support::encode_path(location_id),
);
self.client.get(&url, None).await
}
/**
* Delete an emergency location.
*
* This function performs a `DELETE` to the `/phone/locations/{locationId}` endpoint.
*
* Use this API to remove an emergency location.
*
* **Scopes:** `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
*
* **Parameters:**
*
* * `location_id: &str` -- The emergency service location's ID.
*/
pub async fn delete_location(&self, location_id: &str) -> Result<()> {
let url = format!(
"/phone/locations/{}",
crate::progenitor_support::encode_path(location_id),
);
self.client.delete(&url, None).await
}
/**
* Update emergency service location.
*
* This function performs a `PATCH` to the `/phone/locations/{locationId}` endpoint.
*
* Use this API to update an emergency location's information.
*
* **Scopes:** `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
*/
pub async fn update_location(
&self,
location_id: &str,
body: &crate::types::UpdateLocationRequest,
) -> Result<()> {
let url = format!(
"/phone/locations/{}",
crate::progenitor_support::encode_path(location_id),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* List SIP groups.
*
* This function performs a `GET` to the `/phone/sip_groups` endpoint.
*
* Use this API to list SIP (Session Initiation Protocol) groups.
*
* **Scopes:** `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
*
* **Parameters:**
*
* * `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_size: i64` -- The number of records returned within a single API call.
*/
pub async fn list_sip_groups(
&self,
next_page_token: &str,
page_size: i64,
) -> Result<Vec<crate::types::SipGroups>> {
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 = format!("/phone/sip_groups?{}", query_);
let resp: crate::types::ListSipGroupsResponse = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.sip_groups.to_vec())
}
/**
* List SIP groups.
*
* This function performs a `GET` to the `/phone/sip_groups` endpoint.
*
* As opposed to `list_sip_groups`, this function returns all the pages of the request at once.
*
* Use this API to list SIP (Session Initiation Protocol) groups.
*
* **Scopes:** `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
*/
pub async fn list_all_sip_groups(&self) -> Result<Vec<crate::types::SipGroups>> {
let url = "/phone/sip_groups".to_string();
let mut resp: crate::types::ListSipGroupsResponse = self.client.get(&url, None).await?;
let mut sip_groups = resp.sip_groups;
let mut page = resp.next_page_token;
// Paginate if we should.
while !page.is_empty() {
// Check if we already have URL params and need to concat the token.
if !url.contains('?') {
resp = self
.client
.get(&format!("{}?next_page_token={}", url, page), None)
.await?;
} else {
resp = self
.client
.get(&format!("{}&next_page_token={}", url, page), None)
.await?;
}
sip_groups.append(&mut resp.sip_groups);
if !resp.next_page_token.is_empty() && resp.next_page_token != page {
page = resp.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(sip_groups)
}
/**
* Get setting template details.
*
* This function performs a `GET` to the `/phone/setting_templates/{templateId}` endpoint.
*
* Use this API to return information about an account's phone template.
*
* **Scopes:** `phone:write:admin` or `phone:write`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*
* **Parameters:**
*
* * `template_id: &str` -- Unique identifier of the template.
* * `custom_query_fields: &str` -- Provide the name of the field to use to filter the response. For example, if you provide "description" as the value of the field, you will get a response similar to the following: {“description”: “template description”}.
*/
pub async fn get_setting_template(
&self,
template_id: &str,
custom_query_fields: &str,
) -> Result<crate::types::GetSettingTemplateResponse> {
let mut query_args: Vec<(String, String)> = Default::default();
if !custom_query_fields.is_empty() {
query_args.push((
"custom_query_fields".to_string(),
custom_query_fields.to_string(),
));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/phone/setting_templates/{}?{}",
crate::progenitor_support::encode_path(template_id),
query_
);
self.client.get(&url, None).await
}
/**
* Update a setting template.
*
* This function performs a `PATCH` to the `/phone/setting_templates/{templateId}` endpoint.
*
* Use this API to update or modify a phone template's settings.
*
* **Scopes:** `phone:write:admin` or `phone:write`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*
* **Parameters:**
*
* * `template_id: &str` -- User's first name.
*/
pub async fn update_setting_template(
&self,
template_id: &str,
body: &crate::types::UpdateSettingTemplateRequest,
) -> Result<()> {
let url = format!(
"/phone/setting_templates/{}",
crate::progenitor_support::encode_path(template_id),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Get user's call logs.
*
* This function performs a `GET` to the `/phone/users/{userId}/call_logs` endpoint.
*
* Use this API to get a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) call logs. 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:** `phone:read`, `phone:read:admin`, `phone_call_log:read`, `phone_call_log:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `from: chrono::NaiveDate` -- Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once.
* * `to: chrono::NaiveDate` -- Start Date.
* * `type_: crate::types::PhoneUserCallLogsType`
* * `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.
* * `phone_number: &str` -- Filter API responses to include call logs of only the phone number defined in this field.
* * `time_type: crate::types::TimeType` -- Enables you to sort call logs by start or end time. Choose the sort time value. Values include `startTime` or `endTime`.
*/
pub async fn user_call_logs(
&self,
user_id: &str,
page_size: i64,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
type_: crate::types::PhoneUserCallLogsType,
next_page_token: &str,
phone_number: &str,
time_type: crate::types::TimeType,
) -> Result<Vec<crate::types::CallLogs>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
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()));
}
if !phone_number.is_empty() {
query_args.push(("phone_number".to_string(), phone_number.to_string()));
}
if !time_type.to_string().is_empty() {
query_args.push(("time_type".to_string(), time_type.to_string()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.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 = format!(
"/phone/users/{}/call_logs?{}",
crate::progenitor_support::encode_path(user_id),
query_
);
let resp: crate::types::PhoneUserCallLogsResponse = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.call_logs.to_vec())
}
/**
* Get user's call logs.
*
* This function performs a `GET` to the `/phone/users/{userId}/call_logs` endpoint.
*
* As opposed to `user_call_logs`, this function returns all the pages of the request at once.
*
* Use this API to get a user's [Zoom phone](https://support.zoom.us/hc/en-us/articles/360001297663-Quickstart-Guide-for-Zoom-Phone-Administrators) call logs. 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:** `phone:read`, `phone:read:admin`, `phone_call_log:read`, `phone_call_log:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*/
pub async fn get_all_user_call_logs(
&self,
user_id: &str,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
type_: crate::types::PhoneUserCallLogsType,
phone_number: &str,
time_type: crate::types::TimeType,
) -> Result<Vec<crate::types::CallLogs>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !phone_number.is_empty() {
query_args.push(("phone_number".to_string(), phone_number.to_string()));
}
if !time_type.to_string().is_empty() {
query_args.push(("time_type".to_string(), time_type.to_string()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.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 = format!(
"/phone/users/{}/call_logs?{}",
crate::progenitor_support::encode_path(user_id),
query_
);
let mut resp: crate::types::PhoneUserCallLogsResponse = self.client.get(&url, None).await?;
let mut call_logs = resp.call_logs;
let mut page = resp.next_page_token;
// Paginate if we should.
while !page.is_empty() {
// Check if we already have URL params and need to concat the token.
if !url.contains('?') {
resp = self
.client
.get(&format!("{}?next_page_token={}", url, page), None)
.await?;
} else {
resp = self
.client
.get(&format!("{}&next_page_token={}", url, page), None)
.await?;
}
call_logs.append(&mut resp.call_logs);
if !resp.next_page_token.is_empty() && resp.next_page_token != page {
page = resp.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(call_logs)
}
/**
* Get user's recordings.
*
* This function performs a `GET` to the `/phone/users/{userId}/recordings` endpoint.
*
* Use this API to get a user's [Zoom Phone recordings](https://support.zoom.us/hc/en-us/articles/360021336671-Viewing-Call-History-and-Recordings). 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:** `phone:read`, `phone:read:admin`, `phone_recording:read`, `phone_recording:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
* * `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.
* * `from: chrono::NaiveDate` -- Start date for the query in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the response includes only one month worth of recording data. The month defined should fall within the last six months.
* * `to: chrono::NaiveDate` -- Start Date.
*/
pub async fn user_recordings(
&self,
user_id: &str,
page_size: i64,
next_page_token: &str,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
) -> Result<Vec<crate::types::Recordings>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
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()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/phone/users/{}/recordings?{}",
crate::progenitor_support::encode_path(user_id),
query_
);
let resp: crate::types::PhoneUserRecordingsResponse = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.recordings.to_vec())
}
/**
* Get user's recordings.
*
* This function performs a `GET` to the `/phone/users/{userId}/recordings` endpoint.
*
* As opposed to `user_recordings`, this function returns all the pages of the request at once.
*
* Use this API to get a user's [Zoom Phone recordings](https://support.zoom.us/hc/en-us/articles/360021336671-Viewing-Call-History-and-Recordings). 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:** `phone:read`, `phone:read:admin`, `phone_recording:read`, `phone_recording:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*/
pub async fn get_all_user_recordings(
&self,
user_id: &str,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
) -> Result<Vec<crate::types::Recordings>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/phone/users/{}/recordings?{}",
crate::progenitor_support::encode_path(user_id),
query_
);
let mut resp: crate::types::PhoneUserRecordingsResponse =
self.client.get(&url, None).await?;
let mut recordings = resp.recordings;
let mut page = resp.next_page_token;
// Paginate if we should.
while !page.is_empty() {
// Check if we already have URL params and need to concat the token.
if !url.contains('?') {
resp = self
.client
.get(&format!("{}?next_page_token={}", url, page), None)
.await?;
} else {
resp = self
.client
.get(&format!("{}&next_page_token={}", url, page), None)
.await?;
}
recordings.append(&mut resp.recordings);
if !resp.next_page_token.is_empty() && resp.next_page_token != page {
page = resp.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(recordings)
}
/**
* Get user's voicemails.
*
* This function performs a `GET` to the `/phone/users/{userId}/voice_mails` endpoint.
*
* Use this API to get a user's Zoom Phone voicemails. 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:** `phone:read`, `phone:read:admin`, `phone_voicemail:read`, `phone_voicemail:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user. For user-level apps, pass `me` as the value for userId.
* * `page_size: i64` -- The number of records returned within a single API call.
* * `status: crate::types::PhoneUserVoiceMailsStatus` -- Status of the voice mail.
* * `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.
* * `from: chrono::NaiveDate` -- Start date for the query in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the response includes only one month worth of voicemail data. The month defined should fall within the last six months.
* * `to: chrono::NaiveDate` -- Start Date.
*/
pub async fn user_voice_mails(
&self,
user_id: &str,
page_size: i64,
status: crate::types::PhoneUserVoiceMailsStatus,
next_page_token: &str,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
) -> Result<Vec<crate::types::VoiceMails>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
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()));
}
if !status.to_string().is_empty() {
query_args.push(("status".to_string(), status.to_string()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/phone/users/{}/voice_mails?{}",
crate::progenitor_support::encode_path(user_id),
query_
);
let resp: crate::types::PhoneUserVoiceMailsResponse = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.voice_mails.to_vec())
}
/**
* Get user's voicemails.
*
* This function performs a `GET` to the `/phone/users/{userId}/voice_mails` endpoint.
*
* As opposed to `user_voice_mails`, this function returns all the pages of the request at once.
*
* Use this API to get a user's Zoom Phone voicemails. 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:** `phone:read`, `phone:read:admin`, `phone_voicemail:read`, `phone_voicemail:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*/
pub async fn get_all_user_voice_mails(
&self,
user_id: &str,
status: crate::types::PhoneUserVoiceMailsStatus,
from: chrono::NaiveDate,
to: chrono::NaiveDate,
) -> Result<Vec<crate::types::VoiceMails>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.to_string().is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !status.to_string().is_empty() {
query_args.push(("status".to_string(), status.to_string()));
}
if !to.to_string().is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/phone/users/{}/voice_mails?{}",
crate::progenitor_support::encode_path(user_id),
query_
);
let mut resp: crate::types::PhoneUserVoiceMailsResponse =
self.client.get(&url, None).await?;
let mut voice_mails = resp.voice_mails;
let mut page = resp.next_page_token;
// Paginate if we should.
while !page.is_empty() {
// Check if we already have URL params and need to concat the token.
if !url.contains('?') {
resp = self
.client
.get(&format!("{}?next_page_token={}", url, page), None)
.await?;
} else {
resp = self
.client
.get(&format!("{}&next_page_token={}", url, page), None)
.await?;
}
voice_mails.append(&mut resp.voice_mails);
if !resp.next_page_token.is_empty() && resp.next_page_token != page {
page = resp.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(voice_mails)
}
/**
* Set up shared access.
*
* This function performs a `POST` to the `/phone/users/{userId}/settings/{settingType}` endpoint.
*
* Use this API to define the voicemail access permissions of 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.
*
* Phone users can access [shared voicemail inboxes](https://support.zoom.us/hc/en-us/articles/360033863991-Sharing-and-controlling-access-to-a-voicemail-inbox) in the Zoom desktop client, web portal, or provisioned desk phone.
*
* To view these settings in the Zoom web portal, navigate to the **Admin >> Phone System Management >> Users & Rooms** interface. Click the **Users** tab and select **User Settings**. Scroll down to **Voicemail & Call Recordings**.
*
* **Scopes:** `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
*
* **Parameters:**
*
* * `user_id: &str` -- Unique identifier of the user.
* * `setting_type: &str` -- Corresponds to the setting item you wish to modify. Allowed values: `voice_mail`.
*/
pub async fn add_user_setting(
&self,
user_id: &str,
setting_type: &str,
body: &crate::types::AddUserSettingRequest,
) -> Result<crate::types::AddUserSettingResponse> {
let url = format!(
"/phone/users/{}/settings/{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(setting_type),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Remove shared access.
*
* This function performs a `DELETE` to the `/phone/users/{userId}/settings/{settingType}` endpoint.
*
* Use this API to remove a user's shared voicemail access settings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* To view these settings in your Zoom web portal, navigate to the **Admin >> Phone System Management >> Users & Rooms** interface. Click the **Users** tab and select **User Settings**. Scroll down to **Voicemail & Call Recordings**.
*
* **Scopes:** `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
*
* **Parameters:**
*
* * `user_id: &str` -- Unique identifier of the user.
* * `setting_type: &str` -- Corresponds to the setting item you wish to remove. Allowed values: `voice_mail`.
* * `shared_id: &str` -- Required only for voicemail setting type.
*/
pub async fn delete_user_setting(
&self,
user_id: &str,
setting_type: &str,
shared_id: &str,
) -> Result<()> {
let mut query_args: Vec<(String, String)> = Default::default();
if !shared_id.is_empty() {
query_args.push(("shared_id".to_string(), shared_id.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/phone/users/{}/settings/{}?{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(setting_type),
query_
);
self.client.delete(&url, None).await
}
/**
* Update shared access.
*
* This function performs a `PATCH` to the `/phone/users/{userId}/settings/{settingType}` endpoint.
*
* Use this API to update the voicemail access permissions of 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.
*
* Phone users can access [shared voicemail inboxes](https://support.zoom.us/hc/en-us/articles/360033863991-Sharing-and-controlling-access-to-a-voicemail-inbox) in the Zoom desktop client, web portal, or provisioned desk phone.
*
* To view these settings in the Zoom web portal, navigate to the **Admin >> Phone System Management >> Users & Rooms** interface. Click the **Users** tab and select **User Settings**. Scroll down to **Voicemail & Call Recordings**.
*
* **Scopes:** `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
*
* **Parameters:**
*
* * `setting_type: &str` -- Corresponds to the setting item you wish to modify. Allowed values: `voice_mail`.
* * `user_id: &str` -- Unique identifier of the user.
*/
pub async fn update_user_setting(
&self,
setting_type: &str,
user_id: &str,
body: &crate::types::UpdateUserSettingRequest,
) -> Result<()> {
let url = format!(
"/phone/users/{}/settings/{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(setting_type),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Get account's call logs.
*
* This function performs a `GET` to the `/phone/call_logs` endpoint.
*
* Use this API to return an account's [call logs](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-Call-Logs).
*
* **Scopes:** `phone:read:admin`, `phone_call_log:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
* * Account owner and a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) with Zoom Phone management
*
* **Parameters:**
*
* * `page_size: i64` -- The number of records returned within a single API call.
* * `from: &str` -- Start date from which you would like to get the call logs. The start date should be within past six months. <br>
*
* The API only returns data pertaining to a month. Thus, the date range(defined using "from" and "to" fields) for which the call logs are to be returned must not exceed a month.
* * `to: &str` -- The end date upto which you would like to get the call logs for. The end date should be within past six months.
* * `type_: &str` -- The type of the call logs. The value can be either "all" or "missed".
* * `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.
* * `path: &str` -- Filter the API response by [path](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs#h_646b46c6-0623-4ab1-8b8b-ea5b8bcef679) of the call. The value of this field can be one of the following: `voiceMail`, `message`, `forward`, `extension`, `callQueue`, `ivrMenu`, `companyDirectory`, `autoReceptionist`, `contactCenter`, `disconnected`, `commonAreaPhone`,
* `pstn`, `transfer`, `sharedLines`, `sharedLineGroup`, `tollFreeBilling`, `meetingService`, `parkPickup`,
* `parkTimeout`, `monitor`, `takeover`, `sipGroup`.
* * `time_type: crate::types::TimeType` -- Enables you to sort call logs by start or end time. Choose the sort time value. Values include `startTime` or `endTime`.
* * `site_id: &str` -- Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-multiple-sites). Use this query parameter if you have enabled multiple sites and would like to filter the response of this API call by call logs of a specific phone site.
*/
pub async fn account_call_logs(
&self,
page_size: i64,
from: &str,
to: &str,
type_: &str,
next_page_token: &str,
path: &str,
time_type: crate::types::TimeType,
site_id: &str,
) -> Result<Vec<crate::types::AccountCallLogsResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
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()));
}
if !path.is_empty() {
query_args.push(("path".to_string(), path.to_string()));
}
if !site_id.is_empty() {
query_args.push(("site_id".to_string(), site_id.to_string()));
}
if !time_type.to_string().is_empty() {
query_args.push(("time_type".to_string(), time_type.to_string()));
}
if !to.is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
if !type_.is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/phone/call_logs?{}", query_);
let resp: crate::types::AccountCallLogsResponseData = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.call_logs.to_vec())
}
/**
* Get account's call logs.
*
* This function performs a `GET` to the `/phone/call_logs` endpoint.
*
* As opposed to `account_call_logs`, this function returns all the pages of the request at once.
*
* Use this API to return an account's [call logs](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-Call-Logs).
*
* **Scopes:** `phone:read:admin`, `phone_call_log:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
* * Account owner and a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Role-Based-Access-Control) with Zoom Phone management
*/
pub async fn get_all_account_call_logs(
&self,
from: &str,
to: &str,
type_: &str,
path: &str,
time_type: crate::types::TimeType,
site_id: &str,
) -> Result<Vec<crate::types::AccountCallLogsResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !path.is_empty() {
query_args.push(("path".to_string(), path.to_string()));
}
if !site_id.is_empty() {
query_args.push(("site_id".to_string(), site_id.to_string()));
}
if !time_type.to_string().is_empty() {
query_args.push(("time_type".to_string(), time_type.to_string()));
}
if !to.is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
if !type_.is_empty() {
query_args.push(("type".to_string(), type_.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/phone/call_logs?{}", query_);
let mut resp: crate::types::AccountCallLogsResponseData =
self.client.get(&url, None).await?;
let mut call_logs = resp.call_logs;
let mut page = resp.next_page_token;
// Paginate if we should.
while !page.is_empty() {
// Check if we already have URL params and need to concat the token.
if !url.contains('?') {
resp = self
.client
.get(&format!("{}?next_page_token={}", url, page), None)
.await?;
} else {
resp = self
.client
.get(&format!("{}&next_page_token={}", url, page), None)
.await?;
}
call_logs.append(&mut resp.call_logs);
if !resp.next_page_token.is_empty() && resp.next_page_token != page {
page = resp.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(call_logs)
}
/**
* Assign phone number to user.
*
* This function performs a `POST` to the `/phone/users/{userId}/phone_numbers` endpoint.
*
* Use this API to assign a [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers) to a user who has already enabled Zoom Phone. 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:** `phone:write`, `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*/
pub async fn assign_number(
&self,
user_id: &str,
body: &crate::types::AddByocNumberResponse,
) -> Result<crate::types::AddByocNumberResponse> {
let url = format!(
"/phone/users/{}/phone_numbers",
crate::progenitor_support::encode_path(user_id),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Unassign phone number.
*
* This function performs a `DELETE` to the `/phone/users/{userId}/phone_numbers/{phoneNumberId}` endpoint.
*
* Use this API to unassign Zoom Phone user's [phone number](https://support.zoom.us/hc/en-us/articles/360020808292-Managing-Phone-Numbers#h_38ba8b01-26e3-4b1b-a9b5-0717c00a7ca6). For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* After assigning a phone number, you can remove it if you do not want it to be assigned to anyone.
*
* **Scopes:** `phone:write`, `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
* * The user must have been previously assigned a Zoom Phone number
*
* **Parameters:**
*
* * `user_id: &str` -- Provide either userId or email address of the user.
* * `phone_number_id: &str` -- Provide either phone number or phoneNumberId of the user. .
*/
pub async fn unassign_number(&self, user_id: &str, phone_number_id: &str) -> Result<()> {
let url = format!(
"/phone/users/{}/phone_numbers/{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(phone_number_id),
);
self.client.delete(&url, None).await
}
/**
* Assign calling plan to a user.
*
* This function performs a `POST` to the `/phone/users/{userId}/calling_plans` endpoint.
*
* Use this API to assign a [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) to a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051-Zoom-Phone) 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:** `phone:write`, `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*/
pub async fn assign_calling_plan(
&self,
user_id: &str,
body: &crate::types::AssignCallingPlanRequest,
) -> Result<()> {
let url = format!(
"/phone/users/{}/calling_plans",
crate::progenitor_support::encode_path(user_id),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Unassign user's calling plan.
*
* This function performs a `DELETE` to the `/phone/users/{userId}/calling_plans/{type}` endpoint.
*
* Use this API to unassign a a [Zoom Phone](https://support.zoom.us/hc/en-us/categories/360001370051) user's [calling plan](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans). 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:** `phone:write`, `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*
* **Parameters:**
*
* * `type_: &str` -- The [type](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans) of the calling plan that was assigned to user. (e.g: The value of type would be "200" for Unlimited US/Canada calling plan.)
* .
*/
pub async fn unassign_calling_plan(&self, user_id: &str, type_: &str) -> Result<()> {
let url = format!(
"/phone/users/{}/calling_plans/{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(type_),
);
self.client.delete(&url, None).await
}
/**
* Get call recordings.
*
* This function performs a `GET` to the `/phone/recordings` endpoint.
*
* Use this API to list an account's [call recordings](https://support.zoom.us/hc/en-us/articles/360038521091-Accessing-and-sharing-call-recordings)
*
* **Scopes:** `phone:read:admin`, `phone:write:admin`,`phone_recording:read:admin`
*
* **Prerequisties:**
* * A Pro or higher account plan
* * A Zoom Phone license
* * Account owner or admin privileges
*
* **Parameters:**
*
* * `page_size: i64` -- The number of records returned within a single API call. The default is **30**, and the maximum is **100**.
* * `next_page_token: &str` -- The current page number of returned records.
* * `from: &str` -- Start date and time in **yyyy-mm-dd** format or **yyyy-MM-dd’T’HH:mm:ss’Z’** format. The date range defined by the from and to parameters should only be one month as the report includes only one month worth of data at once.
* .
* * `to: &str` -- End date and time in **yyyy-mm-dd** format or **yyyy-MM-dd’T’HH:mm:ss’Z’** format, the same formats supported by the `from` parameter.
*
* .
* * `owner_type: &str` -- The owner type. The allowed values are null, `user`, or `callQueue`. The default is null. If null, returns all owner types.
* .
* * `recording_type: &str` -- The recording type. The allowed values are null, `OnDemand`, or `Automatic`. The default is null. If null, returns all recording types.
* .
* * `site_id: &str` -- The site ID. The default is `All sites`.
* * `query_date_type: crate::types::QueryDateType` -- Date types:<br>`start_time` - Query by call start time.<br>`end_time` - Query by call end time.
*/
pub async fn get_recordings(
&self,
page_size: i64,
next_page_token: &str,
from: &str,
to: &str,
owner_type: &str,
recording_type: &str,
site_id: &str,
query_date_type: crate::types::QueryDateType,
) -> Result<Vec<crate::types::GetPhoneRecordingsResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !next_page_token.is_empty() {
query_args.push(("next_page_token".to_string(), next_page_token.to_string()));
}
if !owner_type.is_empty() {
query_args.push(("owner_type".to_string(), owner_type.to_string()));
}
if page_size > 0 {
query_args.push(("page_size".to_string(), page_size.to_string()));
}
if !query_date_type.to_string().is_empty() {
query_args.push(("query_date_type".to_string(), query_date_type.to_string()));
}
if !recording_type.is_empty() {
query_args.push(("recording_type".to_string(), recording_type.to_string()));
}
if !site_id.is_empty() {
query_args.push(("site_id".to_string(), site_id.to_string()));
}
if !to.is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/phone/recordings?{}", query_);
let resp: crate::types::GetPhoneRecordingsResponseData =
self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.recordings.to_vec())
}
/**
* Get call recordings.
*
* This function performs a `GET` to the `/phone/recordings` endpoint.
*
* As opposed to `get_recordings`, this function returns all the pages of the request at once.
*
* Use this API to list an account's [call recordings](https://support.zoom.us/hc/en-us/articles/360038521091-Accessing-and-sharing-call-recordings)
*
* **Scopes:** `phone:read:admin`, `phone:write:admin`,`phone_recording:read:admin`
*
* **Prerequisties:**
* * A Pro or higher account plan
* * A Zoom Phone license
* * Account owner or admin privileges
*/
pub async fn get_all_recordings(
&self,
from: &str,
to: &str,
owner_type: &str,
recording_type: &str,
site_id: &str,
query_date_type: crate::types::QueryDateType,
) -> Result<Vec<crate::types::GetPhoneRecordingsResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !from.is_empty() {
query_args.push(("from".to_string(), from.to_string()));
}
if !owner_type.is_empty() {
query_args.push(("owner_type".to_string(), owner_type.to_string()));
}
if !query_date_type.to_string().is_empty() {
query_args.push(("query_date_type".to_string(), query_date_type.to_string()));
}
if !recording_type.is_empty() {
query_args.push(("recording_type".to_string(), recording_type.to_string()));
}
if !site_id.is_empty() {
query_args.push(("site_id".to_string(), site_id.to_string()));
}
if !to.is_empty() {
query_args.push(("to".to_string(), to.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/phone/recordings?{}", query_);
let mut resp: crate::types::GetPhoneRecordingsResponseData =
self.client.get(&url, None).await?;
let mut recordings = resp.recordings;
let mut page = resp.next_page_token;
// Paginate if we should.
while !page.is_empty() {
// Check if we already have URL params and need to concat the token.
if !url.contains('?') {
resp = self
.client
.get(&format!("{}?next_page_token={}", url, page), None)
.await?;
} else {
resp = self
.client
.get(&format!("{}&next_page_token={}", url, page), None)
.await?;
}
recordings.append(&mut resp.recordings);
if !resp.next_page_token.is_empty() && resp.next_page_token != page {
page = resp.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(recordings)
}
/**
* List BYOC SIP trunks.
*
* This function performs a `GET` to the `/phone/sip_trunk/trunks` endpoint.
*
* Use this API to return a list of an account's assigned [BYOC (Bring Your Own Carrier) SIP (Session Initiation Protocol) trunks](https://zoom.us/docs/doc/Zoom-Bring%20Your%20Own%20Carrier.pdf).
*
* **Scopes:** `phone:write:admin` or `phone:master`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
*
* **Parameters:**
*
* * `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_size: i64` -- The number of records returned within a single API call.
*/
pub async fn list_byocsip_trunk(
&self,
next_page_token: &str,
page_size: i64,
) -> Result<Vec<crate::types::ByocSipTrunk>> {
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 = format!("/phone/sip_trunk/trunks?{}", query_);
let resp: crate::types::ListByocsipTrunkResponse = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.byoc_sip_trunk.to_vec())
}
/**
* List BYOC SIP trunks.
*
* This function performs a `GET` to the `/phone/sip_trunk/trunks` endpoint.
*
* As opposed to `list_byocsip_trunk`, this function returns all the pages of the request at once.
*
* Use this API to return a list of an account's assigned [BYOC (Bring Your Own Carrier) SIP (Session Initiation Protocol) trunks](https://zoom.us/docs/doc/Zoom-Bring%20Your%20Own%20Carrier.pdf).
*
* **Scopes:** `phone:write:admin` or `phone:master`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
*/
pub async fn list_all_byocsip_trunk(&self) -> Result<Vec<crate::types::ByocSipTrunk>> {
let url = "/phone/sip_trunk/trunks".to_string();
let mut resp: crate::types::ListByocsipTrunkResponse = self.client.get(&url, None).await?;
let mut byoc_sip_trunk = resp.byoc_sip_trunk;
let mut page = resp.next_page_token;
// Paginate if we should.
while !page.is_empty() {
// Check if we already have URL params and need to concat the token.
if !url.contains('?') {
resp = self
.client
.get(&format!("{}?next_page_token={}", url, page), None)
.await?;
} else {
resp = self
.client
.get(&format!("{}&next_page_token={}", url, page), None)
.await?;
}
byoc_sip_trunk.append(&mut resp.byoc_sip_trunk);
if !resp.next_page_token.is_empty() && resp.next_page_token != page {
page = resp.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(byoc_sip_trunk)
}
/**
* Assign SIP trunks.
*
* This function performs a `POST` to the `/accounts/{accountId}/phone/sip_trunk/trunks` endpoint.
*
* A [Master account](https://marketplace.zoom.us/docs/api-reference/master-account-apis) owner can use this API to assign SIP (Session Initiation Protocol) trunks to a subaccount.
*
* **Scopes:** `phone:master`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
*
* **Parameters:**
*
* * `account_id: &str` -- Unique identifier of the account.
*/
pub async fn post_sip_trunk(
&self,
account_id: &str,
body: &crate::types::PostPhoneSipTrunkRequest,
) -> Result<crate::types::PostPhoneSipTrunkRequest> {
let url = format!(
"/accounts/{}/phone/sip_trunk/trunks",
crate::progenitor_support::encode_path(account_id),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Update SIP trunk details.
*
* This function performs a `PATCH` to the `/accounts/{accountId}/phone/sip_trunk/trunks/{sipTrunkId}` endpoint.
*
* Use this API to update a subaccount's assigned SIP (Session Initiation Protocol) trunk information.
*
* **Scopes:** `phone:master` <br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise account
*
* **Parameters:**
*
* * `sip_trunk_id: &str` -- Unique identifier of the SIP trunk.
* * `account_id: &str` -- Unique identifier of the sub account.
*/
pub async fn update_sip_trunk(
&self,
sip_trunk_id: &str,
account_id: &str,
body: &crate::types::UpdatePhoneSipTrunkRequest,
) -> Result<()> {
let url = format!(
"/accounts/{}/phone/sip_trunk/trunks/{}",
crate::progenitor_support::encode_path(account_id),
crate::progenitor_support::encode_path(sip_trunk_id),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* List external contacts.
*
* This function performs a `GET` to the `/phone/external_contacts` endpoint.
*
* Use this API to list external contacts.
*
* **Scopes:** `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
*
* **Parameters:**
*
* * `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_size: i64` -- The number of records returned within a single API call.
*/
pub async fn list_external_contacts(
&self,
next_page_token: &str,
page_size: i64,
) -> Result<Vec<crate::types::ExternalContacts>> {
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 = format!("/phone/external_contacts?{}", query_);
let resp: crate::types::ListExternalContactsResponse = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.external_contacts.to_vec())
}
/**
* List external contacts.
*
* This function performs a `GET` to the `/phone/external_contacts` endpoint.
*
* As opposed to `list_external_contacts`, this function returns all the pages of the request at once.
*
* Use this API to list external contacts.
*
* **Scopes:** `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
*/
pub async fn list_all_external_contacts(&self) -> Result<Vec<crate::types::ExternalContacts>> {
let url = "/phone/external_contacts".to_string();
let mut resp: crate::types::ListExternalContactsResponse =
self.client.get(&url, None).await?;
let mut external_contacts = resp.external_contacts;
let mut page = resp.next_page_token;
// Paginate if we should.
while !page.is_empty() {
// Check if we already have URL params and need to concat the token.
if !url.contains('?') {
resp = self
.client
.get(&format!("{}?next_page_token={}", url, page), None)
.await?;
} else {
resp = self
.client
.get(&format!("{}&next_page_token={}", url, page), None)
.await?;
}
external_contacts.append(&mut resp.external_contacts);
if !resp.next_page_token.is_empty() && resp.next_page_token != page {
page = resp.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(external_contacts)
}
/**
* Add an external contact.
*
* This function performs a `POST` to the `/phone/external_contacts` endpoint.
*
* Use this API to add an external contact.
*
* **Scopes:** `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
*/
pub async fn add_external_contact(
&self,
body: &crate::types::AddExternalContactRequest,
) -> Result<()> {
let url = "/phone/external_contacts".to_string();
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Get external contact details.
*
* This function performs a `GET` to the `/phone/external_contacts/{externalContactId}` endpoint.
*
* Use this API to get an external contact's information.
*
* **Scopes:** `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions<br>
*
* **Parameters:**
*
* * `external_contact_id: &str` -- The external contact's ID.
*/
pub async fn get_external_contact(
&self,
external_contact_id: &str,
) -> Result<crate::types::ExternalContacts> {
let url = format!(
"/phone/external_contacts/{}",
crate::progenitor_support::encode_path(external_contact_id),
);
self.client.get(&url, None).await
}
/**
* Delete an external contact.
*
* This function performs a `DELETE` to the `/phone/external_contacts/{externalContactId}` endpoint.
*
* Use this API to remove an external contact.
*
* **Scopes:** `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
*
* **Parameters:**
*
* * `external_contact_id: &str` -- The external contact's ID.
*/
pub async fn delete_external_contact(&self, external_contact_id: &str) -> Result<()> {
let url = format!(
"/phone/external_contacts/{}",
crate::progenitor_support::encode_path(external_contact_id),
);
self.client.delete(&url, None).await
}
/**
* Update external contact.
*
* This function performs a `PATCH` to the `/phone/external_contacts/{externalContactId}` endpoint.
*
* Use this API to update an external contact's information.
*
* **Scopes:** `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * Pro or a higher account with Zoom Phone license
* * Account owner or admin permissions
*
* **Parameters:**
*
* * `external_contact_id: &str` -- User's first name.
*/
pub async fn update_external_contact(
&self,
external_contact_id: &str,
body: &crate::types::UpdateExternalContactRequest,
) -> Result<()> {
let url = format!(
"/phone/external_contacts/{}",
crate::progenitor_support::encode_path(external_contact_id),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Get phone number details.
*
* This function performs a `GET` to the `/phone/numbers/{numberId}` endpoint.
*
* Use this API to get information about an account's Zoom Phone number.
*
* **Scopes:** `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Pro or higher account plan
* * A Zoom phone license
*
* **Parameters:**
*
* * `number_id: &str` -- Unique Identifier of the Phone Number. This can be retrieved from the List Phone Numbers API.
*/
pub async fn get_number_details(
&self,
number_id: &str,
) -> Result<crate::types::GetPhoneNumberDetailsResponse> {
let url = format!(
"/phone/numbers/{}",
crate::progenitor_support::encode_path(number_id),
);
self.client.get(&url, None).await
}
/**
* Update phone number details.
*
* This function performs a `PATCH` to the `/phone/numbers/{numberId}` endpoint.
*
* Use this API to update a Zoom Phone number's information.
*
* **Scopes:** `phone:write`, `phone:write:admin`, `phone:master`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Paid account
*
* **Parameters:**
*
* * `number_id: &str` -- User's first name.
*/
pub async fn update_number_details(
&self,
number_id: &str,
body: &crate::types::UpdatePhoneNumberDetailsRequest,
) -> Result<()> {
let url = format!(
"/phone/numbers/{}",
crate::progenitor_support::encode_path(number_id),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Change main company number.
*
* This function performs a `PUT` to the `/phone/company_number` endpoint.
*
* Use this API to [change an account's main company number](https://support.zoom.us/hc/en-us/articles/360028553691#h_82414c34-9df2-428a-85a4-efcf7f9e0d72).
*
* External users can use the [main company number](https://support.zoom.us/hc/en-us/articles/360028553691) to reach your Zoom Phone users by dialing the main company number and the user's extension. It can also be used by your account's Zoom Phone users as their caller ID when making calls.
*
* **Scopes:** `phone:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Pro or higher account plan
* * Account owner or admin permissions
*/
pub async fn change_main_company_number(
&self,
body: &crate::types::ChangeMainCompanyNumberRequest,
) -> Result<()> {
let url = "/phone/company_number".to_string();
self.client
.put(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* List calling plans.
*
* This function performs a `GET` to the `/phone/calling_plans` endpoint.
*
* Use this API to return all of an account's Zoom Phone [calling plans](https://marketplace.zoom.us/docs/api-reference/other-references/plans#zoom-phone-calling-plans).
*
* **Scopes:** `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Prerequisites:**
* * A Pro or a higher account
* * A Zoom Phone license
*/
pub async fn list_calling_plan(&self) -> Result<crate::types::ListCallingPlansResponseData> {
let url = "/phone/calling_plans".to_string();
self.client.get(&url, None).await
}
/**
* List phone users.
*
* This function performs a `GET` to the `/phone/users` endpoint.
*
* Use this API to return a list of all of an account's users who are assigned a Zoom Phone license.
*
* **Scopes:** `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Pro or higher account plan
* * A Zoom Phone license
*
* **Parameters:**
*
* * `page_size: i64` -- The number of records returned from 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.
* * `site_id: &str` -- Unique Identifier of the site. This can be retrieved from the [List Phone Sites](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone-site/listphonesites) API.
*/
pub async fn list_users(
&self,
page_size: i64,
next_page_token: &str,
site_id: &str,
) -> Result<Vec<crate::types::ListPhoneUsersResponse>> {
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()));
}
if !site_id.is_empty() {
query_args.push(("site_id".to_string(), site_id.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/phone/users?{}", query_);
let resp: crate::types::ListPhoneUsersResponseData = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.users.to_vec())
}
/**
* List phone users.
*
* This function performs a `GET` to the `/phone/users` endpoint.
*
* As opposed to `list_users`, this function returns all the pages of the request at once.
*
* Use this API to return a list of all of an account's users who are assigned a Zoom Phone license.
*
* **Scopes:** `phone:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Pro or higher account plan
* * A Zoom Phone license
*/
pub async fn list_all_users(
&self,
site_id: &str,
) -> Result<Vec<crate::types::ListPhoneUsersResponse>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !site_id.is_empty() {
query_args.push(("site_id".to_string(), site_id.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/phone/users?{}", query_);
let mut resp: crate::types::ListPhoneUsersResponseData =
self.client.get(&url, None).await?;
let mut users = resp.users;
let mut page = resp.next_page_token;
// Paginate if we should.
while !page.is_empty() {
// Check if we already have URL params and need to concat the token.
if !url.contains('?') {
resp = self
.client
.get(&format!("{}?next_page_token={}", url, page), None)
.await?;
} else {
resp = self
.client
.get(&format!("{}&next_page_token={}", url, page), None)
.await?;
}
users.append(&mut resp.users);
if !resp.next_page_token.is_empty() && resp.next_page_token != page {
page = resp.next_page_token.to_string();
} else {
page = "".to_string();
}
}
// Return our response data.
Ok(users)
}
/**
* Get call log details.
*
* This function performs a `GET` to the `/phone/call_logs/{callLogId}` endpoint.
*
* Use this API to return information about a [call log](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs).
*
* **Scopes:** `phone:read`, `phone:read:admin`, `phone_call_log:read`, `phone_call_log:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`
*
* **Prerequisites:**
* * A Business or Enterprise account
* * A Zoom Phone license
*
* **Parameters:**
*
* * `call_log_id: &str` -- Unique identifier of the call log. Both `callLogId` and `callId` can be used as path parameters. The value for this field can be retrieved from [account's call logs](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone/accountcalllogs) or the [user's call logs](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone/phoneusercalllogs).
*/
pub async fn get_call_log_details(
&self,
call_log_id: &str,
) -> Result<crate::types::GetCallLogDetailsResponse> {
let url = format!(
"/phone/call_logs/{}",
crate::progenitor_support::encode_path(call_log_id),
);
self.client.get(&url, None).await
}
/**
* Delete a user's call log.
*
* This function performs a `DELETE` to the `/phone/users/{userId}/call_logs/{callLogId}` endpoint.
*
* Use this API to delete a user's [call log](https://support.zoom.us/hc/en-us/articles/360021114452-Viewing-and-identifying-logs). 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:** `phone:write`, `phone:write:admin`, `phone_call_log:write`, `phone_call_log:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * User must belong to a Business or Enterprise account
* * User must have a Zoom Phone license
*
* **Parameters:**
*
* * `user_id: &str` -- The user ID or email address of the user.
* * `call_log_id: &str` -- Unique identifier of the call log. The value for this field can be retrieved from [account's call logs](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone/accountcalllogs) or [user's call logs](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone/phoneusercalllogs).
*/
pub async fn delete_call_log(&self, user_id: &str, call_log_id: &str) -> Result<()> {
let url = format!(
"/phone/users/{}/call_logs/{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(call_log_id),
);
self.client.delete(&url, None).await
}
/**
* Add BYOC phone numbers.
*
* This function performs a `POST` to the `/phone/byoc_numbers` endpoint.
*
* Use this API to add BYOC (Bring Your Own Carrier) phone numbers to Zoom Phone.
*
* **Scopes:** `phone:write:admin`, `phone:write`, or `phone:master`</br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Business or Enterprise plan
* * A Zoom Phone license
*/
pub async fn add_byoc_number(
&self,
body: &crate::types::AddByocNumberRequest,
) -> Result<crate::types::AddByocNumberResponse> {
let url = "/phone/byoc_numbers".to_string();
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Delete a voicemail.
*
* This function performs a `DELETE` to the `/phone/voice_mails/{voicemailId}` endpoint.
*
* Use this API to delete an account's [voicemail message](https://support.zoom.us/hc/en-us/articles/360021400211-Managing-voicemail-messages).
*
* **Scopes:** `phone:write:admin`, `phone:write`, `phone_voicemail:write`, `phone_voicemail:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`
*
* **Prerequisites:**
* * A Zoom Phone license
*
* **Parameters:**
*
* * `voicemail_id: &str` -- Unique identifier of the voicemail. Retrieve the value for this field by calling the [Get voicemails](https://marketplace.zoom.us/docs/api-reference/zoom-api/phone/phoneuservoicemails) API.
*/
pub async fn delete_voicemail(&self, voicemail_id: &str) -> Result<()> {
let url = format!(
"/phone/voice_mails/{}",
crate::progenitor_support::encode_path(voicemail_id),
);
self.client.delete(&url, None).await
}
}