Zoom Public API Documentation
Get chat messages reports
GET {{baseUrl}}/report/chat/sessions/:sessionId?from=<date>&to=<date>&next_page_token=<string>&page_size=30&include_fields=edited_messages,deleted_messages&include_bot_message=false
Gets Zoom Chat message reports for a specified period of time. The monthly date range must be within the last six months. Scopes: Prerequisites:
* A Pro or higher plan
* Report chat permissionsreport_chat:read:admin
Rate Limit Label: Medium
Body
PARAM
| Key | Datatype | Required | Description |
from
|
string | (Required) The start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once. | |
to
|
string | (Required) The end date. | |
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. The expiration period for this token is 15 minutes. | |
page_size
|
number | The number of records returned within a single API call. | |
include_fields
|
string | This field returns all edited and deleted messages. The API only returns this value if the `include_fields` query parameter contains the `edited_messages` and/or the `deleted_messages` values. To include both edited and deleted messages, comma-separate both values. | |
include_bot_message
|
boolean | Whether to return the bot message. If false, the bot_message will not be returned in the response body. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"deleted_messages": [
{
"date_time": "<dateTime>",
"files": [
{
"download_url": "<string>",
"file_id": "<string>",
"file_name": "<string>",
"file_size": "<integer>"
},
{
"download_url": "<string>",
"file_id": "<string>",
"file_name": "<string>",
"file_size": "<integer>"
}
],
"id": "<string>",
"message": "<string>",
"receiver": "<string>",
"reply_main_message_id": "<string>",
"reply_main_message_timestamp": "<long>",
"sender": "<string>",
"sender_member_id": "<string>",
"sender_display_name": "<string>",
"timestamp": "<long>"
},
{
"date_time": "<dateTime>",
"files": [
{
"download_url": "<string>",
"file_id": "<string>",
"file_name": "<string>",
"file_size": "<integer>"
},
{
"download_url": "<string>",
"file_id": "<string>",
"file_name": "<string>",
"file_size": "<integer>"
}
],
"id": "<string>",
"message": "<string>",
"receiver": "<string>",
"reply_main_message_id": "<string>",
"reply_main_message_timestamp": "<long>",
"sender": "<string>",
"sender_member_id": "<string>",
"sender_display_name": "<string>",
"timestamp": "<long>"
}
],
"edited_messages": [
{
"date_time": "<dateTime>",
"files": [
{
"download_url": "<string>",
"file_id": "<string>",
"file_name": "<string>",
"file_size": "<integer>"
},
{
"download_url": "<string>",
"file_id": "<string>",
"file_name": "<string>",
"file_size": "<integer>"
}
],
"id": "<string>",
"message": "<string>",
"receiver": "<string>",
"reply_main_message_id": "<string>",
"reply_main_message_timestamp": "<long>",
"sender_member_id": "<string>",
"sender": "<string>",
"sender_display_name": "<string>",
"timestamp": "<long>"
},
{
"date_time": "<dateTime>",
"files": [
{
"download_url": "<string>",
"file_id": "<string>",
"file_name": "<string>",
"file_size": "<integer>"
},
{
"download_url": "<string>",
"file_id": "<string>",
"file_name": "<string>",
"file_size": "<integer>"
}
],
"id": "<string>",
"message": "<string>",
"receiver": "<string>",
"reply_main_message_id": "<string>",
"reply_main_message_timestamp": "<long>",
"sender_member_id": "<string>",
"sender": "<string>",
"sender_display_name": "<string>",
"timestamp": "<long>"
}
],
"from": "<date>",
"messages": [
{
"date_time": "<dateTime>",
"files": [
{
"download_url": "<string>",
"file_id": "<string>",
"file_name": "<string>",
"file_size": "<integer>"
},
{
"download_url": "<string>",
"file_id": "<string>",
"file_name": "<string>",
"file_size": "<integer>"
}
],
"id": "<string>",
"message": "<string>",
"receiver": "<string>",
"reply_main_message_id": "<string>",
"reply_main_message_timestamp": "<long>",
"sender": "<string>",
"sender_member_id": "<string>",
"sender_display_name": "<string>",
"timestamp": "<long>",
"bot_message": {
"is_markdown_support": "<boolean>",
"source": "<string>",
"external_sender_email": "<string>",
"content": {}
}
},
{
"date_time": "<dateTime>",
"files": [
{
"download_url": "<string>",
"file_id": "<string>",
"file_name": "<string>",
"file_size": "<integer>"
},
{
"download_url": "<string>",
"file_id": "<string>",
"file_name": "<string>",
"file_size": "<integer>"
}
],
"id": "<string>",
"message": "<string>",
"receiver": "<string>",
"reply_main_message_id": "<string>",
"reply_main_message_timestamp": "<long>",
"sender": "<string>",
"sender_member_id": "<string>",
"sender_display_name": "<string>",
"timestamp": "<long>",
"bot_message": {
"is_markdown_support": "<boolean>",
"source": "<string>",
"external_sender_email": "<string>",
"content": {}
}
}
],
"next_page_token": "<string>",
"page_size": 30,
"to": "<date>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/report/chat/sessions/:sessionId?from=<date>&to=<date>&next_page_token=<string>&page_size=30&include_fields=edited_messages,deleted_messages&include_bot_message=false?from=<date>&to=<date>&next_page_token=<string>&page_size=30&include_fields=edited_messages,deleted_messages&include_bot_message=false' -H 'Accept: application/json'
ENDPOINTS