Zoom Public API Documentation
Get user's IM messages
GET {{baseUrl}}/im/users/:userId/chat/messages?chat_user=<email>&channel=<string>&date=<date>&page_size=30&next_page_token=<string>
Gets IM Chat messages for a specified period of time. This API only supports Oauth2. 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.
Scopes: imchat:read
Rate Limit Label: Medium
Body
PARAM
| Key | Datatype | Required | Description |
chat_user
|
string | The chat user's ID or email address. | |
channel
|
string | The IM Channel's ID. | |
date
|
string | The IM message's query date format as yyyy-MM-dd. | |
page_size
|
number | The number of records returned within a single API call. | |
next_page_token
|
string | 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. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"date": "<string>",
"messages": [
{
"date_time": "<dateTime>",
"id": "<uuid>",
"message": "<string>",
"sender": "<string>",
"timestamp": "<integer>"
},
{
"date_time": "<dateTime>",
"id": "<uuid>",
"message": "<string>",
"sender": "<string>",
"timestamp": "<integer>"
}
],
"next_page_token": "<string>",
"page_size": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/im/users/:userId/chat/messages?chat_user=<email>&channel=<string>&date=<date>&page_size=30&next_page_token=<string>?chat_user=<email>&channel=<string>&date=<date>&page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS