Struct ChatMessages

pub struct ChatMessages {
    pub client: Client,
}

Fields

client: Client

Implementations

impl ChatMessages

pub async fn get_page( &self, user_id: &str, to_contact: &str, to_channel: &str, date: NaiveDate, page_size: i64, next_page_token: &str, include_deleted_and_edited_message: &str, ) -> Result<Response<Vec<Messages>>, ClientError>

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 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.

Note: For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the View or Edit permission for Chat Messages.

Scopes: chat_message:read, chat_message:read:admin
Rate Limit Label: 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
  Set the value of this field to true to include edited and deleted messages in the response.

pub async fn get_all( &self, user_id: &str, to_contact: &str, to_channel: &str, date: NaiveDate, include_deleted_and_edited_message: &str, ) -> Result<Response<Vec<Messages>>, ClientError>

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 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.

Note: For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the View or Edit permission for Chat Messages.

Scopes: chat_message:read, chat_message:read:admin
Rate Limit Label: Medium

pub async fn senda( &self, user_id: &str, body: &SendaChatMessageRequest, ) -> Result<Response<Groups>, ClientError>

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 of which you are a member. For user-level apps, pass the me value 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
Rate Limit Label: Medium

Note: For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the Edit permission for Chat Messages.

pub async fn mark_message( &self, user_id: &str, message_id: &str, body: &MarkMessageRequest, ) -> Result<Response<()>, ClientError>

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 instead of the userId parameter.

Note: For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the Edit permission for Chat Messages.

Rate Limit Label: Medium

Parameters:

• user_id: &str – Unique identifier of the user.
• message_id: &str – Unique identifier of the message.

pub async fn react_message( &self, user_id: &str, message_id: &str, body: &ReactMessageRequest, ) -> Result<Response<()>, ClientError>

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, this API can only be used on behalf of a user who is assigned with a role that has the Edit permission for Chat Messages.

Scopes: chat_message:write, chat_message:write:admin
Rate Limit Label: Medium

Parameters:

• user_id: &str – The user’s unique ID.
• message_id: &str – The message’s unique ID.

pub async fn get( &self, user_id: &str, message_id: &str, to_contact: &str, to_channel: &str, ) -> Result<Response<GetChatMessageResponse>, ClientError>

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 instead of the userId parameter.

You must provide one of the following query parameters:

• 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
Rate Limit Label: Medium

Note: For an account-level OAuth app, you can only use this API for a user assigned the Edit permission for the Chat message role setting.

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\nNote: 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\nNote: You must use this query parameter to delete a message sent to Zoom Chat channel.

pub async fn edit_message( &self, user_id: &str, message_id: &str, body: &EditMessageRequest, ) -> Result<Response<()>, ClientError>

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 instead of the userId parameter.

Note: For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the Edit permission for Chat Messages.

Scope: chat_message:write,chat_message:write:admin
Rate Limit Label: Medium

Parameters:

• message_id: &str – Message ID: Unique Identifier of the message.

pub async fn delete( &self, user_id: &str, message_id: &str, to_contact: &str, to_channel: &str, ) -> Result<Response<()>, ClientError>

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 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
Rate Limit Label: Medium

Note: For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has the Edit permission for Chat Messages.

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 .