pub struct ImChat {
pub client: Client,
}Fields§
§client: ClientImplementations§
Source§impl ImChat
impl ImChat
Sourcepub async fn session(
&self,
from: NaiveDate,
to: NaiveDate,
page_size: i64,
next_page_token: &str,
) -> Result<Response<ImChatSessionsResponseAllOf>, ClientError>
pub async fn session( &self, from: NaiveDate, to: NaiveDate, page_size: i64, next_page_token: &str, ) -> Result<Response<ImChatSessionsResponseAllOf>, ClientError>
Get IM chat sessions.
This function performs a GET to the /im/chat/sessions endpoint.
Retrieve IM Chat sessions for a specified period of time. This API only supports Oauth2.
Scopes: imchat:read, imchat:read:admin
Rate Limit Label: Heavy
Deprecated: By end of 2021, Zoom is deprecating this API in favor of a consolidated set of APIs. The API will still be available for you to use, though Zoom will no longer provide support for it. For further information, see Announcements: IM APIs Deprecation.
Parameters:
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.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.
Sourcepub async fn message(
&self,
session_id: &str,
from: NaiveDate,
to: NaiveDate,
page_size: i64,
next_page_token: &str,
) -> Result<Response<ImChatMessagesResponseAllOf>, ClientError>
pub async fn message( &self, session_id: &str, from: NaiveDate, to: NaiveDate, page_size: i64, next_page_token: &str, ) -> Result<Response<ImChatMessagesResponseAllOf>, ClientError>
Get IM chat messages.
This function performs a GET to the /im/chat/sessions/{sessionId} endpoint.
Retrieve IM chat messages for a specified period of time. This API only supports oauth2.
Scopes: imchat:read
Rate Limit Label: Medium
Deprecated: By end of 2021, Zoom is deprecating this API in favor of a consolidated set of APIs. The API will still be available for you to use, though Zoom will no longer provide support for it. For further information, see Announcements: IM APIs Deprecation.
Parameters:
session_id: &str– User’s first name.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.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.
Sourcepub async fn list_im_messages(
&self,
user_id: &str,
chat_user: &str,
channel: &str,
date: &str,
page_size: i64,
next_page_token: &str,
) -> Result<Response<Vec<ListimmessagesResponseMessages>>, ClientError>
pub async fn list_im_messages( &self, user_id: &str, chat_user: &str, channel: &str, date: &str, page_size: i64, next_page_token: &str, ) -> Result<Response<Vec<ListimmessagesResponseMessages>>, ClientError>
Get user’s IM messages.
This function performs a GET to the /im/users/{userId}/chat/messages endpoint.
Get IM Chat messages for a specified period of time. This API only supports Oauth2.
Scopes: imchat:read
Rate Limit Label: Medium
Deprecated: By end of 2021, Zoom is deprecating this API in favor of a consolidated set of APIs. The API will still be available for you to use, though Zoom will no longer provide support for it. For further information, see Announcements: IM APIs Deprecation.
Parameters:
user_id: &str– The user ID or email address.chat_user: &str– Chat user’s ID or email address.channel: &str– User’s first name.date: &str– IM message’s query date time, format as yyyy-MM-dd.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.
Sourcepub async fn list_all_im_messages(
&self,
user_id: &str,
chat_user: &str,
channel: &str,
date: &str,
) -> Result<Response<Vec<ListimmessagesResponseMessages>>, ClientError>
pub async fn list_all_im_messages( &self, user_id: &str, chat_user: &str, channel: &str, date: &str, ) -> Result<Response<Vec<ListimmessagesResponseMessages>>, ClientError>
Get user’s IM messages.
This function performs a GET to the /im/users/{userId}/chat/messages endpoint.
As opposed to list_im_messages, this function returns all the pages of the request at once.
Get IM Chat messages for a specified period of time. This API only supports Oauth2.
Scopes: imchat:read
Rate Limit Label: Medium
Deprecated: By end of 2021, Zoom is deprecating this API in favor of a consolidated set of APIs. The API will still be available for you to use, though Zoom will no longer provide support for it. For further information, see Announcements: IM APIs Deprecation.
Sourcepub async fn send_im_messages(
&self,
chat_user: &str,
body: &SendimmessagesRequest,
) -> Result<Response<Groups>, ClientError>
pub async fn send_im_messages( &self, chat_user: &str, body: &SendimmessagesRequest, ) -> Result<Response<Groups>, ClientError>
Send IM messages.
This function performs a POST to the /im/users/me/chat/messages endpoint.
Send chat message to a user.
Scope: imchat:write
Rate Limit Label: Medium
Parameters:
chat_user: &str– The email address (registered with Zoom) or the userId of the chat user.