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
use anyhow::Result;
use crate::Client;
pub struct ChatMessages {
pub client: Client,
}
impl ChatMessages {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
ChatMessages { client }
}
/**
* List user's chat messages.
*
* This function performs a `GET` to the `/chat/users/{userId}/messages` endpoint.
*
* Use this API to list the current user's chat messages between the user and an individual contact or a chat channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* In the query parameter, you must provide one of the following:
*
* * `to_contact`: The email address of the contact with whom the user conversed by sending or receiving messages.
* * `to_channel`: The channel ID of the channel to or from which the user has sent and/or received messages.
*
* <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note:</b> For an <b>account-level</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>, this API can only be used on behalf of a user who is assigned with a <a href="https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.">role</a> that has the <b>View</b> or <b>Edit</b> permission for <b>Chat Messages</b>.</p>
*
* **Scopes:** `chat_message:read`, `chat_message:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `to_contact: &str` -- The email address of a chat contact with whom the current user chatted. Messages that were sent and/or received between the user and the contact is displayed.
*
* Note: You must provide either `contact` or `channel` as a query parameter to retrieve messages either from an individual or a chat channel. .
* * `to_channel: &str` -- The channel Id of a channel inside which the current user had chat conversations. Messages that were sent and/or received between the user and the channel is displayed.
*
* Note: You must provide either `contact` or `channel` as a query parameter to retrieve messages either from an individual or a chat channel. .
* * `date: chrono::NaiveDate` -- The query date for which you would like to get the chat messages. This value defaults to the current date.
* * `page_size: i64` -- The number of records returned with 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.
* * `include_deleted_and_edited_message: &str` -- **Optional** <br>
* Set the value of this field to `true` to include edited and deleted messages in the response.
*/
pub async fn get_page(
&self,
user_id: &str,
to_contact: &str,
to_channel: &str,
date: chrono::NaiveDate,
page_size: i64,
next_page_token: &str,
include_deleted_and_edited_message: &str,
) -> Result<Vec<crate::types::Messages>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !date.to_string().is_empty() {
query_args.push(("date".to_string(), date.to_string()));
}
if !include_deleted_and_edited_message.is_empty() {
query_args.push((
"include_deleted_and_edited_message".to_string(),
include_deleted_and_edited_message.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_channel.is_empty() {
query_args.push(("to_channel".to_string(), to_channel.to_string()));
}
if !to_contact.is_empty() {
query_args.push(("to_contact".to_string(), to_contact.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/chat/users/{}/messages?{}",
crate::progenitor_support::encode_path(user_id),
query_
);
let resp: crate::types::GetChatMessagesResponse = self.client.get(&url, None).await?;
// Return our response data.
Ok(resp.messages)
}
/**
* List user's chat messages.
*
* This function performs a `GET` to the `/chat/users/{userId}/messages` endpoint.
*
* As opposed to `get`, this function returns all the pages of the request at once.
*
* Use this API to list the current user's chat messages between the user and an individual contact or a chat channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* In the query parameter, you must provide one of the following:
*
* * `to_contact`: The email address of the contact with whom the user conversed by sending or receiving messages.
* * `to_channel`: The channel ID of the channel to or from which the user has sent and/or received messages.
*
* <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note:</b> For an <b>account-level</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>, this API can only be used on behalf of a user who is assigned with a <a href="https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.">role</a> that has the <b>View</b> or <b>Edit</b> permission for <b>Chat Messages</b>.</p>
*
* **Scopes:** `chat_message:read`, `chat_message:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*/
pub async fn get_all(
&self,
user_id: &str,
to_contact: &str,
to_channel: &str,
date: chrono::NaiveDate,
include_deleted_and_edited_message: &str,
) -> Result<Vec<crate::types::Messages>> {
let mut query_args: Vec<(String, String)> = Default::default();
if !date.to_string().is_empty() {
query_args.push(("date".to_string(), date.to_string()));
}
if !include_deleted_and_edited_message.is_empty() {
query_args.push((
"include_deleted_and_edited_message".to_string(),
include_deleted_and_edited_message.to_string(),
));
}
if !to_channel.is_empty() {
query_args.push(("to_channel".to_string(), to_channel.to_string()));
}
if !to_contact.is_empty() {
query_args.push(("to_contact".to_string(), to_contact.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/chat/users/{}/messages?{}",
crate::progenitor_support::encode_path(user_id),
query_
);
let mut resp: crate::types::GetChatMessagesResponse = self.client.get(&url, None).await?;
let mut messages = resp.messages;
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?;
}
messages.append(&mut resp.messages);
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(messages)
}
/**
* Send a chat message.
*
* This function performs a `POST` to the `/chat/users/{userId}/messages` endpoint.
*
* Send chat messages on Zoom to either an individual user who is in your contact list or to a [channel](https://support.zoom.us/hc/en-us/articles/200912909-Getting-Started-With-Channels-Group-Messaging-) of which you are a member. 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 send a message to a contact, provide the contact's email address in the `to_contact` field. To send a message to a channel, provide the channel's ID in `to_channel` parameter
*
* **Scopes:** `chat_message:write`, `chat_message:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note:</b> For an <b>account-level</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>, this API can only be used on behalf of a user who is assigned with a <a href="https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit."> role</a> that has the <b>Edit</b> permission for <b>Chat Messages</b>.</p>
*/
pub async fn senda(
&self,
user_id: &str,
body: &crate::types::SendaChatMessageRequest,
) -> Result<crate::types::Groups> {
let url = format!(
"/chat/users/{}/messages",
crate::progenitor_support::encode_path(user_id),
);
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Mark message read or unread.
*
* This function performs a `PATCH` to the `/chat/users/{userId}/messages/{messageId}/status` endpoint.
*
* Mark a message as read or unread. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note:</b> For an <b>account-level</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>, this API can only be used on behalf of a user who is assigned with a <a href="https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.">role</a> that has the <b>Edit</b> permission for <b>Chat Messages</b>.</p>
*
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `user_id: &str` -- Unique identifier of the user.
* * `message_id: &str` -- Unique identifier of the message.
*/
pub async fn mark_message(
&self,
user_id: &str,
message_id: &str,
body: &crate::types::MarkMessageRequest,
) -> Result<()> {
let url = format!(
"/chat/users/{}/messages/{}/status",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(message_id),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* React to a chat message.
*
* This function performs a `PATCH` to the `/chat/users/{userId}/messages/{messageId}/emoji_reactions` endpoint.
*
* Use this API to react (add or remove) to a chat message with an emoji.
*
* For an **account-level** [OAuth app](https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app), this API can only be used on behalf of a user who is assigned with a [role](https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.) that has the **Edit** permission for **Chat Messages**.
*
* **Scopes:** `chat_message:write`, `chat_message:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `user_id: &str` -- The user's unique ID.
* * `message_id: &str` -- The message's unique ID.
*/
pub async fn react_message(
&self,
user_id: &str,
message_id: &str,
body: &crate::types::ReactMessageRequest,
) -> Result<()> {
let url = format!(
"/chat/users/{}/messages/{}/emoji_reactions",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(message_id),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Get a message.
*
* This function performs a `GET` to the `/chat/users/{userId}/messages/{messageId}` endpoint.
*
* Get a chat message previously sent to a contact or a channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* You must provide one of the following query parameters:<br>
* * `to_contact` — The email address of the Zoom contact to whom you sent the message.
* * `to_channel` — The ID of the Zoom channel where you sent the message.
*
* **Scopes:** `chat_message:read`, `chat_message:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note:</b> For an <b>account-level</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>, you can only use this API for a user assigned <a href="https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit.">the <b>Edit</b> permission for the <b>Chat message</b> role setting</a>.</p>
*
* **Parameters:**
*
* * `message_id: &str` -- User's first name.
* * `to_contact: &str` -- The `userId` or email address of a Zoom Chat contact to whom you sent the message.\n\n**Note:** You must use this query parameter to delete a message sent to a Zoom Chat contact. .
* * `to_channel: &str` -- The `channelId` of the Zoom Chat channel where sent the message.\n\n**Note:** You must use this query parameter to delete a message sent to Zoom Chat channel.
*/
pub async fn get(
&self,
user_id: &str,
message_id: &str,
to_contact: &str,
to_channel: &str,
) -> Result<crate::types::GetChatMessageResponse> {
let mut query_args: Vec<(String, String)> = Default::default();
if !to_channel.is_empty() {
query_args.push(("to_channel".to_string(), to_channel.to_string()));
}
if !to_contact.is_empty() {
query_args.push(("to_contact".to_string(), to_contact.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/chat/users/{}/messages/{}?{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(message_id),
query_
);
self.client.get(&url, None).await
}
/**
* Update a message.
*
* This function performs a `PUT` to the `/chat/users/{userId}/messages/{messageId}` endpoint.
*
* Use this API to edit a chat message that you previously sent to either a contact or a channel in Zoom by providing the ID of the message as the value of the `messageId` parameter. You can get the ID from the **List User's Chat Messages** API. Additionally, as a query parameter, you must provide either the contact's **email address** of the contact or the **Channel ID** of the channel where the message was sent.
*
* For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note:</b> For an <b>account-level</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>, this API can only be used on behalf of a user who is assigned with a <a href="https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit."> role</a> that has the <b>Edit</b> permission for <b>Chat Messages</b>.</p>
*
* **Scope:** `chat_message:write`,`chat_message:write:admin` <br>
* **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* **Parameters:**
*
* * `message_id: &str` -- Message ID: Unique Identifier of the message.
*/
pub async fn edit_message(
&self,
user_id: &str,
message_id: &str,
body: &crate::types::EditMessageRequest,
) -> Result<()> {
let url = format!(
"/chat/users/{}/messages/{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(message_id),
);
self.client
.put(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Delete a message.
*
* This function performs a `DELETE` to the `/chat/users/{userId}/messages/{messageId}` endpoint.
*
* Delete a chat message that you previously sent to a contact or a channel. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.
*
* In the query parameter, you must provide either of the following:
*
* * `to_contact`: The email address of the contact to whom you sent the message. Use this parameter to delete a message sent to an individual contact in Zoom.
* * `to_channel`: The channel ID of the channel where you sent the message. Use this parameter to delete a message sent to a channel in Zoom.
*
*
*
* **Scopes:** `chat_message:write`, `chat_message:write:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`
*
* <p style="background-color:#e1f5fe; color:#01579b; padding:8px"> <b>Note:</b> For an <b>account-level</b> <a href="https://marketplace.zoom.us/docs/guides/getting-started/app-types/create-oauth-app">OAuth app</a>, this API can only be used on behalf of a user who is assigned with a <a href="https://support.zoom.us/hc/en-us/articles/115001078646-Using-role-management#:~:text=Each%20user%20in%20a%20Zoom,owner%2C%20administrator%2C%20or%20member.&text=Role%2Dbased%20access%20control%20enables,needs%20to%20view%20or%20edit."> role</a> that has the <b>Edit</b> permission for <b>Chat Messages</b>.</p>
*
* **Parameters:**
*
* * `message_id: &str` -- User's first name.
* * `to_contact: &str` -- The userId or email address of a chat contact to whom you previously sent the message.
*
* Note: You must provide either `to_contact` or `to_channel` as a query parameter to delete a message that was previously sent to either an individual or a chat channel respectively. .
* * `to_channel: &str` -- The channel Id of the channel where you would like to send the message.
*
* You must provide either `to_contact` or `to_channel` as a query parameter to delete a message that was previously sent to either an individual or a chat channel .
*/
pub async fn delete(
&self,
user_id: &str,
message_id: &str,
to_contact: &str,
to_channel: &str,
) -> Result<()> {
let mut query_args: Vec<(String, String)> = Default::default();
if !to_channel.is_empty() {
query_args.push(("to_channel".to_string(), to_channel.to_string()));
}
if !to_contact.is_empty() {
query_args.push(("to_contact".to_string(), to_contact.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/chat/users/{}/messages/{}?{}",
crate::progenitor_support::encode_path(user_id),
crate::progenitor_support::encode_path(message_id),
query_
);
self.client.delete(&url, None).await
}
}