Struct zoom_api::chat_channels::ChatChannels

pub struct ChatChannels { /* fields omitted */ }

Implementations

impl ChatChannels

pub async fn get_channels(
    &self,
    user_id: &str,
    page_size: i64,
    next_page_token: &str
) -> Result<Vec<Channels>>

List user’s channels.

This function performs a GET to the /chat/users/{userId}/channels endpoint.

Use this API to list a user’s chat channels. For user-level apps, pass the me value instead of the userId parameter.

Zoom chat channels allow users to communicate via chat in private or public groups.

Scopes: chat_channel:read or chat_channel:read:admin
Rate Limit Label: Medium

Note: This API supports both user-managed apps and account-level apps. However, in an account-level OAuth app, to list channels of another user in the same Zoom account, the user calling this API must have a role that has the View or Edit permission for the Chat channels feature.

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. The expiration period for this token is 15 minutes.
• user_id: &str – Unique identifier of the user.

pub async fn get_all_channels(&self, user_id: &str) -> Result<Vec<Channels>>

List user’s channels.

This function performs a GET to the /chat/users/{userId}/channels endpoint.

As opposed to get_channels, this function returns all the pages of the request at once.

Use this API to list a user’s chat channels. For user-level apps, pass the me value instead of the userId parameter.

Zoom chat channels allow users to communicate via chat in private or public groups.

Scopes: chat_channel:read or chat_channel:read:admin
Rate Limit Label: Medium

Note: This API supports both user-managed apps and account-level apps. However, in an account-level OAuth app, to list channels of another user in the same Zoom account, the user calling this API must have a role that has the View or Edit permission for the Chat channels feature.

pub async fn create_channel(
    &self,
    user_id: &str,
    body: &CreateChannelRequest
) -> Result<CreateChannelResponse>

Create a channel.

This function performs a POST to the /chat/users/{userId}/channels endpoint.

Use this API to create a channel for a user. For user-level apps, pass the me value instead of the userId parameter.

Zoom chat channels allow users to communicate via chat in private or public groups.

Scopes: chat_channel:write or chat_channel:write:admin
Rate Limit Label: Medium

Note: This API supports both user-managed apps and account-level apps. However, in an account-level OAuth app, to create a channel on behalf of another user in the same Zoom account, the user calling this API must have a role that has the Edit permission for the Chat channels feature.

Parameters:

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

pub async fn get_user_level_channel(&self, channel_id: &str) -> Result<Channel>

Get a channel.

This function performs a GET to the /chat/channels/{channelId} endpoint.

Zoom chat channels allow users to communicate via chat in private or public groups. Use this API to get information about a specific channel.

Scope: chat_channel:read
Rate Limit Label: Medium

Note: This API supports only user-managed OAuth apps. If you use an Account-Level OAuth Access token, you can only retrieve the channel information for the authorized user. You can't retrieve the channel information of other account users. Use the Account-Level Get Channel Info API to retrieve the channel information of other account users.

Parameters:

• channel_id: &str – Channel ID: Unique Identifier of a channel.

pub async fn delete_user_level_channel(&self, channel_id: &str) -> Result<()>

Delete a channel.

This function performs a DELETE to the /chat/channels/{channelId} endpoint.

Zoom chat channels allow users to communicate via chat in private or public groups. Use this API to delete a specific channel.

Scope: chat_channel:write
Rate Limit Label: Medium

Note: This API only supports user-managed OAuth app.

Parameters:

• channel_id: &str – Channel ID: Unique Identifier of a channel.

pub async fn update_user_level_channel(
    &self,
    channel_id: &str,
    body: &Attendees
) -> Result<()>

Update a channel.

This function performs a PATCH to the /chat/channels/{channelId} endpoint.

Zoom chat channels allow users to communicate via chat in private or public channels. Use this API to update the name of a specific channel that you created.

Scope: chat_channel:write
Rate Limit Label: Medium

Note: This API only supports user-managed OAuth app.

Parameters:

• channel_id: &str – User’s first name.

pub async fn remove_a_user_level_channel_member(
    &self,
    channel_id: &str,
    member_id: &str
) -> Result<()>

Remove a member.

This function performs a DELETE to the /chat/channels/{channelId}/members/{memberId} endpoint.

A channel can have one or multiple members. Use this API to remove a member from a chat channel.

Scopes: chat_channel:write
Rate Limit Label: Medium

Note: This API only supports user-managed OAuth app.

Parameters:

• channel_id: &str – Unique Identifier of the Channel from where you would like to remove a member. This can be retrieved from the List Channels API.
• member_id: &str – Email address of the member whom you would like to be remove from the channel.

pub async fn join_channel(
    &self,
    channel_id: &str
) -> Result<JoinChannelResponse>

Join a channel.

This function performs a POST to the /chat/channels/{channelId}/members/me endpoint.

A channel can have one or multiple members. Use this API to join a channel that is open for anyone in the same organization to join. You cannot use this API to join private channels that only allows invited members to be a part of it.

Note: This API only supports user-managed OAuth app.

Scope: chat_channel:write
Rate Limit Label: Medium

Parameters:

• channel_id: &str – User’s first name.

pub async fn leave_channel(&self, channel_id: &str) -> Result<()>

Leave a channel.

This function performs a DELETE to the /chat/channels/{channelId}/members/me endpoint.

If you’re no longer interested in being a member of an existing channel, you can leave the channel at any time. Use this API to leave a specific channel. After leaving the channel, you can no longer access information from that channel.

Note: This API only supports user-managed OAuth app.

Scope: chat_channel:write
Rate Limit Label: Medium

Parameters:

• channel_id: &str – Channel ID: Unique Identifier of a channel.