Zoom Team Chat API

Gets Zoom Chat message reports for a specified period of time. The monthly date range must be within the last six months.

Scopes: report_chat:read:admin
Rate Limit Label: Medium

Prerequisites: * A Pro or higher plan * Report chat permissions

Gets Zoom Chat session reports for a specified period of time. The monthly date range must be within the last six months.

Scopes: report_chat:read:admin
Rate Limit Label: Medium

Prerequisites: * A Pro or higher plan * Report chat permissions.

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

Sends chat message to a user.

Rate Limit Label: Medium

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

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

A user under an organization's Zoom account has internal users listed under Company Contacts in the Zoom Client. Use this API to search users that are in the company contacts of a Zoom account. Using the search_key query parameter, provide either first name, last name or the email address of the user that you would like to search for. Optionally, set query_presence_status to true in order to include the presence status of a contact.

Scopes: contact:read:admin, contact:read

Rate Limit Label: Medium

Retrieves a user's chat sessions. 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 a role that has the View or Edit permission for Chat Messages.

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

Marks a chat 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 assigned to a role with the **Edit** permission for Chat Messages.

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

Adds or removes an emoji to a chat message.

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

Deletes a chat message previously sent to a contact or a channel. For user-level apps, pass the me value instead of the userId parameter.

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

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

Edits 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

Sends a file on Zoom to either an individual user in your contact list or a channel of which you are a member.

Note: * The base URL for this API is https://file.zoom.us/v2/. * The rate limit of this API is 20 requests per second per API or 2000 requests per second per IP address. * The caller must support HTTP 30x redirects. * All files are sent as common files except png,jpg,jpeg and gif * Zoom Cloud Storage will store the files sent through this API. If you do not use Zoom Cloud Storage, Zoom Cloud will temporarily store these files for 7 days. * The caller must retain the authorization header when redirected to a different hostname.

For user-level apps, pass the me value instead of the userId parameter.

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

Searches chat messages or shared files between a user and an individual contact or a chat channel. 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 View or Edit permission for Chat Messages.

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

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

Uploads a file to chat.

Note: * The base URL for this API's is https://file.zoom.us/v2/. * The rate limit of this API is 20 requests per second per API or 2000 requests per second per IP address. * The caller must support HTTP 30x redirects. * All files are sent as common files except png,jpg,jpeg and gif * Zoom Cloud Storage will store the files sent through this API. If you do not use Zoom Cloud Storage, Zoom Cloud will temporarily store these files for 7 days. * The caller must retain the authorization header when redirected to a different hostname.

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

Removes a member from a chat channel. A channel can have one or many members. For user-level apps, pass the me value instead of the userId parameter.

Scopes: chat_channel: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 Edit permission for Chat Channels.

Lists all members of a channel. For user-level apps, pass the me value instead of the userId parameter.

Scopes: chat_channel:read: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 View or Edit permission for Chat Channels.

Invites members that are in a user's contact list to a channel. For user-level apps, pass the me value instead of the userId parameter.

Scopes: chat_channel: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 Channels.

Lists all administrators of a channel. For user-level apps, pass the me value instead of the userId parameter.

Scopes: chat_channel:read: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 View or Edit permission for Chat Channels.

Promotes members to administrator role in a channel. For user-level apps, pass the me value instead of the userId parameter.

Scopes: chat_channel: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 Channels.

Demotes administrators in a channel in batch. For user-level apps, pass the me value instead of the userId parameter.

Scopes: chat_channel: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 Channels.

Deletes a specific channel. 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:admin
Rate Limit Label: Medium

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

Gets information about a specific channel. 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: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 View or Edit permission for Chat Channels.

Updates the name and settings of a specific channel owned or administrated by 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 channels.

Scopes: chat_channel: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 Channel.

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

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

A user under an organization's Zoom account has internal users listed under Company Contacts in the Zoom Client. A Zoom user can also add another Zoom user as a contact. Call this API to get information on a specific contact of the Zoom user.

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

Scope: chat_contact:read

Rate Limit Label: Medium

A user under an organization's Zoom account has internal users listed under Company Contacts in the Zoom Client. A Zoom user can also add another Zoom user as a contact. Call this API to list all the contacts of a Zoom user. Zoom contacts are categorized into company contacts and external contacts. You must specify the contact type in the type query parameter. If you do not specify, by default, the type will be set as company contact.

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

Scope: chat_contact:read

Rate Limit Label: Medium

Removes a member from a chat channel. A channel can have one or many members.

Scopes: chat_channel:write
Rate Limit Label: Medium

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

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

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

Scope: chat_channel:write
Rate Limit Label: Medium

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

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

Scope: chat_channel:write
Rate Limit Label: Medium

Batch removes multiple members from a chat channel. A channel can have one or many members.

Scopes: chat_channel:write
Rate Limit Label: Medium

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

Lists all members of a channel.

Scopes: chat_channel:read
Rate Limit Label: Medium

Invites members that are in a user's contact list to a channel. A channel can have one or multiple members. The maximum number of members that can be added at once with this API is 5.

Scope: chat_channel:write
Note: This API only supports user-managed OAuth app

Rate Limit Label: Medium

Deletes a specific channel. Zoom chat channels allow users to communicate via chat in private or public groups.

Scope: chat_channel:write
Rate Limit Label: Medium

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

Gets information about a specific channel. Zoom chat channels allow users to communicate via chat in private or public groups.

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 Get a channel API to retrieve the channel information of other account users.

Updates the name and settings of a specific channel owned or administrated by you. Zoom chat channels allow users to communicate via chat in private or public channels.

Scope: chat_channel:write
Rate Limit Label: Medium

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

Lists public chat channels created by an account's users.

Note: This API only supports account-level apps. The user calling this API must have a role that has the View or Edit permission for the Chat Channels feature.

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