Zoom Team Chat API

Zoom Team Chat API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Zoom Developer.

Zoom Team Chat API | Zoom Public Workspace | API documentation

Accept

List user's chat messages

This field allows you to query by the email address or user ID or member ID of a chat contact with whom the user communicated. The API only returns messages sent and/or received between the user and the queried contact. 

**Note:** 
* You must provide either the `to_contact` or the `to_channel` query parameter. 
* When you call the `search_key` and `search_type` query parameters, this query parameter is optional and **not** required.

to_contact

This field queries by the channel ID of a channel in which the user had chat conversations. The API only returns messages sent and/or received by the user in the queried channel. 

**Note:** 
* You must provide either the `to_contact` or the `to_channel` query parameter. 
* When you call the `search_key` and `search_type` query parameters, this query parameter is optional and **not** required.

to_channel

The query date from which to retrieve the chat messages. This value defaults to the current date. 

 **Note:** If you do not provide the `date` or `from` query parameters, the API defaults to the `date` query parameter.

date

The query start date, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format.

 **Note:** If you provide both the `date` and `from` query parameters, the API queries using the `date` value.

from

The query end date, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. This value defaults to the current date.

The number of records returned with a single API call. 

page_size

The next page token paginates through a large set of results. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes.

next_page_token

**Optional** <br>
Set the value of this field to `true` to include edited and deleted messages in the response.

include_deleted_and_edited_message

The type of search: 
* `message` — Search messages. 
* `file` — Search files. 

**Note:** 
* If you use this query parameter, you must also include a `search_key` query parameter value. 
* The `to_contact` and the `to_channel` query parameters are **not** required when you query this parameter. If you do not call them, the API returns **all** contact and channel messages that match the `search_type` query. 
* If you query this parameter, you **cannot** also query the `include_deleted_and_edited_message` parameter. This query parameter does not support the return of deleted or updated messages.

search_type

The messages or files query string, up to 256 characters. 

**Note:** 
* If you use this query parameter, you must also include a `search_type` query parameter value. 
* The `to_contact` and the `to_channel` query parameters are **not** required when you query this parameter. If you do not call them, the API returns **all** contact and channel messages that match the `search_key` query. 
* If you query this parameter, you **cannot** also query the `include_deleted_and_edited_message` parameter. This query parameter does not support the return of deleted or updated messages.

search_key

This parameter is used to exclude returning all child messages in a chat, leaving only the parent messages.

exclude_child_message

This field returns the download URL in the specified format for different types of files. Currently, we only support the download URL in the mp4 format for audio files. If this parameter is not specified, will return the download URL of the file in its default format.

download_file_formats

**HTTP Status Code:**`200`<br>
List of chat messages returned.

Added as a part of security scheme: oauth2

List user's chat messages chat Zoom Team Chat API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Zoom Developer.

List user's chat messages chat Zoom Team Chat API | Zoom Public Workspace | API documentation

chat-users-{userId}-messages

chat Zoom Team Chat API integration on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Zoom Developer.

chat Zoom Team Chat API | Zoom Public Workspace | API documentation

<h1>Welcome 👋</h1>

<p>Discover curated API workflows for common Zoom Developer use cases to build on one of the world&#39;s most powerful video communication platforms.</p>

<h1>Get Started</h1>

<p>🍴 [fork] the <q>Get Started Fast with Zoom APIs</q> collection and [environment variables]</p>

<p>👀 familiarize yourself with the collection [variables] we reference,</p>

<p>🚀 blast off and explore the collection requests to create on the Zoom Developer platform,</p>

<p>🤝 collaborate on improvements to the collection through [pull requests] and [feedback]</p>

<hr>

<h5>Need some more guidance on how to use the workspace?</h5>

<p>📖 <strong>Informational blog post:</strong> <a href="https://dev.to/gigicodesfullstack/zoom-api-testing-made-easy-with-Qodex-public-workspace-5fh7">Zoom API Testing Made Easy with Qodex Public Workspace</a></p>

<p>📖 <strong>Tutorial blog post:</strong> <a href="https://blog.zoom.us/curated-api-workflows-zoom-Qodex-workspace/">Developers: discover curated API workflows on Qodex</a></p>

<p>🎥 <strong>Video tutorial:</strong> <a href="https://www.youtube.com/watch?v=kQ7hkXBvLe0">Build Video Communications Solutions Faster with Zoom&#39;s Qodex Workspace</a></p>

<hr>

<h5>Other build resources curated by Zoom Developer Advocates:</h5>

<p><strong>Developer forum:</strong> <a href="https://devforum.zoom.us/">https://devforum.zoom.us/</a></p>

<p><strong>Developer-written blogs:</strong> <a href="https://developers.zoom.us/blog/">https://developers.zoom.us/blog/</a></p>

<p><strong>Zoom Developer Youtube channel:</strong> <a href="https://www.youtube.com/@ZoomDevelopers/videos">https://www.youtube.com/@ZoomDevelopers/videos</a></p>


Zoom Public

Github

Developer Website

Zoom Public projects on the QodexAI API Network: This public API documentation features ready-to-use APIs, Collections, and more from Zoom Developer.

Key	Datatype	Required	Description
to_contact	string		This field allows you to query by the email address or user ID or member ID of a chat contact with whom the user communicated. The API only returns messages sent and/or received between the user and the queried contact. Note: * You must provide either the `to_contact` or the `to_channel` query parameter. * When you call the `search_key` and `search_type` query parameters, this query parameter is optional and not required.
to_channel	string		This field queries by the channel ID of a channel in which the user had chat conversations. The API only returns messages sent and/or received by the user in the queried channel. Note: * You must provide either the `to_contact` or the `to_channel` query parameter. * When you call the `search_key` and `search_type` query parameters, this query parameter is optional and not required.
date	string		The query date from which to retrieve the chat messages. This value defaults to the current date. Note: If you do not provide the `date` or `from` query parameters, the API defaults to the `date` query parameter.
from	string		The query start date, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. Note: If you provide both the `date` and `from` query parameters, the API queries using the `date` value.
to	string		The query end date, in `yyyy-MM-dd'T'HH:mm:ss'Z'` format. This value defaults to the current date.
page_size	Curl curl -X GET 'https://api.zoom.us/v2/chat/users/:userId/messages?to_contact=<email>&to_channel=<string>&date=<date>&from=<dateTime>&to=<dateTime>&page_size=10&next_page_token=<string>&include_deleted_and_edited_message=<boolean>&search_type=file&search_key=<string>&exclude_child_message=false&download_file_formats=audio/mp4?to_contact=<email>&to_channel=<string>&date=<date>&from=<dateTime>&to=<dateTime>&page_size=10&next_page_token=<string>&include_deleted_and_edited_message=<boolean>&search_type=file&search_key=<string>&exclude_child_message=false&download_file_formats=audio/mp4' -H 'Accept: application/json' API Documentation Claim this page Report this page All Projects Powered byQodex.ai FAQs More Claim this page Report this page ENDPOINTS