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
use anyhow::Result; use crate::Client; pub struct SipPhone { client: Client, } impl SipPhone { #[doc(hidden)] pub fn new(client: Client) -> Self { SipPhone { client } } /** * List SIP phones. * * This function performs a `GET` to the `/sip_phones` endpoint. * * Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to list SIP phones on an account.<br><br> * **Prerequisites**: * * Currently only supported on Cisco and Avaya PBX systems. * * User must enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.<br> **Scope:** `sip_phone:read:admin`<br> * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br> * * * **Parameters:** * * * `page_number: i64` -- * **Deprecated** - This field has been deprecated and we will stop supporting it completely in a future release. Please use "next_page_token" for pagination instead of this field. * * The page number of the current page in the returned records. * * `search_key: &str` -- User name or email address of a user. If this parameter is provided, only the SIP phone system integration enabled for that specific user will be returned. Otherwise, all SIP phones on an account will be returned. * * `page_size: i64` -- The number of records returned within a single API call. * * `next_page_token: &str` -- The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. */ pub async fn list( &self, page_number: i64, search_key: &str, page_size: i64, next_page_token: &str, ) -> Result<Vec<crate::types::Phones>> { let mut query = String::new(); let mut query_args: Vec<String> = Default::default(); if !next_page_token.is_empty() { query_args.push(format!("next_page_token={}", next_page_token)); } if page_number > 0 { query_args.push(format!("page_number={}", page_number)); } if page_size > 0 { query_args.push(format!("page_size={}", page_size)); } if !search_key.is_empty() { query_args.push(format!("search_key={}", search_key)); } for (i, n) in query_args.iter().enumerate() { if i > 0 { query.push('&'); } query.push_str(n); } let url = format!("/sip_phones?{}", query); let resp: crate::types::ListSipPhonesResponse = self.client.get(&url, None).await.unwrap(); // Return our response data. Ok(resp.phones) } /** * List SIP phones. * * This function performs a `GET` to the `/sip_phones` endpoint. * * As opposed to `list`, this function returns all the pages of the request at once. * * Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to list SIP phones on an account.<br><br> * **Prerequisites**: * * Currently only supported on Cisco and Avaya PBX systems. * * User must enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.<br> **Scope:** `sip_phone:read:admin`<br> * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br> * */ pub async fn list_all(&self, search_key: &str) -> Result<Vec<crate::types::Phones>> { let mut query = String::new(); let mut query_args: Vec<String> = Default::default(); if !search_key.is_empty() { query_args.push(format!("search_key={}", search_key)); } for (i, n) in query_args.iter().enumerate() { if i > 0 { query.push('&'); } query.push_str(n); } let url = format!("/sip_phones?{}", query); let mut resp: crate::types::ListSipPhonesResponse = self.client.get(&url, None).await.unwrap(); let mut phones = resp.phones; 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 .unwrap(); } else { resp = self .client .get(&format!("{}&next_page_token={}", url, page), None) .await .unwrap(); } phones.append(&mut resp.phones); 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(phones) } /** * Enable SIP phone. * * This function performs a `POST` to the `/sip_phones` endpoint. * * Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to enable a user to use SIP phone.<br><br> * **Prerequisites**: * * Currently only supported on Cisco and Avaya PBX systems. * * The account owner or account admin must first enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.<br> **Scope:** `sip_phone:write:admin` * <br> * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` * * */ pub async fn create(&self, body: &crate::types::CreateSipPhoneRequest) -> Result<()> { let url = "/sip_phones".to_string(); self.client .post( &url, Some(reqwest::Body::from(serde_json::to_vec(body).unwrap())), ) .await } /** * Delete SIP phone. * * This function performs a `DELETE` to the `/sip_phones/{phoneId}` endpoint. * * Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to delete a specific SIP phone on a Zoom account.<br><br> * **Prerequisites**: * * Currently only supported on Cisco and Avaya PBX systems. * * User must enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.<br> **Scope:** `sip_phone:read:admin` * <br> * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` * * **Parameters:** * * * `phone_id: &str` -- Unique Identifier of the SIP Phone. It can be retrieved from the List SIP Phones API. */ pub async fn delete(&self, phone_id: &str) -> Result<()> { let url = format!( "/sip_phones/{}", crate::progenitor_support::encode_path(&phone_id.to_string()), ); self.client.delete(&url, None).await } /** * Update SIP phone. * * This function performs a `PATCH` to the `/sip_phones/{phoneId}` endpoint. * * Zoom’s Phone System Integration (PSI), also referred as SIP phones, enables an organization to leverage the Zoom client to complete a softphone registration to supported premise based PBX system. End users will have the ability to have softphone functionality within a single client while maintaining a comparable interface to Zoom Phone. Use this API to update information of a specific SIP Phone on a Zoom account.<br><br> * **Prerequisites**: * * Currently only supported on Cisco and Avaya PBX systems. * * The account owner or account admin must first enable SIP Phone Integration by contacting the [Sales](https://zoom.us/contactsales) team.<br> **Scope:** `sip_phone:write:admin` * <br> * **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` * * **Parameters:** * * * `phone_id: &str` -- Unique Identifier of the SIP Phone. This can be retrieved from the List SIP Phones API. */ pub async fn update( &self, phone_id: &str, body: &crate::types::UpdateSipPhoneRequest, ) -> Result<()> { let url = format!( "/sip_phones/{}", crate::progenitor_support::encode_path(&phone_id.to_string()), ); self.client .patch( &url, Some(reqwest::Body::from(serde_json::to_vec(body).unwrap())), ) .await } }