GET /chat/users/{userId}/messages
A Zoom user can have conversations with other Zoom users via chat. Use this API to list the current user's chat messages between the user and an individual contact or a chat channel.
In the query parameter, you must provide either of the following:
to_contact: The email address of the contact with whom the user conversed by sending/receiving messages.to_channel: The channel ID of the channel to/from which the user has sent and/or received messages.
Specify a date in the date query parameter to view messages from that date. If a date is not provided, the default value for the query will be the current date.
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 View or Edit permission for Chat Messages.
Scopes: chat_message:read, chat_message:read:admin
Rate Limit Label: Medium
Servers
- https://api.zoom.us/v2
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
userId |
String | Yes |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
include_deleted_and_edited_message |
String | No |
Optional |
page_size |
Integer | No |
The number of records returned with a single API call. Default value: 10 |
to_channel |
String | No |
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 |
to_contact |
String | No |
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 |
next_page_token |
String | No |
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. |
date |
String | No |
The query date for which you would like to get the chat messages. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.