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: report_chat:read:admin
Rate Limit Label: Medium
Prerequisites: * A Pro or higher plan * Report chat permissions
Request Params
| 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":"\u003cdateTime\u003e","files":[{"download_url":"\u003cstring\u003e","file_id":"\u003cstring\u003e","file_name":"\u003cstring\u003e","file_size":"\u003cinteger\u003e"},{"download_url":"\u003cstring\u003e","file_id":"\u003cstring\u003e","file_name":"\u003cstring\u003e","file_size":"\u003cinteger\u003e"}],"id":"\u003cstring\u003e","message":"\u003cstring\u003e","receiver":"\u003cstring\u003e","reply_main_message_id":"\u003cstring\u003e","reply_main_message_timestamp":"\u003clong\u003e","sender":"\u003cstring\u003e","sender_member_id":"\u003cstring\u003e","sender_display_name":"\u003cstring\u003e","timestamp":"\u003clong\u003e"},{"date_time":"\u003cdateTime\u003e","files":[{"download_url":"\u003cstring\u003e","file_id":"\u003cstring\u003e","file_name":"\u003cstring\u003e","file_size":"\u003cinteger\u003e"},{"download_url":"\u003cstring\u003e","file_id":"\u003cstring\u003e","file_name":"\u003cstring\u003e","file_size":"\u003cinteger\u003e"}],"id":"\u003cstring\u003e","message":"\u003cstring\u003e","receiver":"\u003cstring\u003e","reply_main_message_id":"\u003cstring\u003e","reply_main_message_timestamp":"\u003clong\u003e","sender":"\u003cstring\u003e","sender_member_id":"\u003cstring\u003e","sender_display_name":"\u003cstring\u003e","timestamp":"\u003clong\u003e"}],"edited_messages":[{"date_time":"\u003cdateTime\u003e","files":[{"download_url":"\u003cstring\u003e","file_id":"\u003cstring\u003e","file_name":"\u003cstring\u003e","file_size":"\u003cinteger\u003e"},{"download_url":"\u003cstring\u003e","file_id":"\u003cstring\u003e","file_name":"\u003cstring\u003e","file_size":"\u003cinteger\u003e"}],"id":"\u003cstring\u003e","message":"\u003cstring\u003e","receiver":"\u003cstring\u003e","reply_main_message_id":"\u003cstring\u003e","reply_main_message_timestamp":"\u003clong\u003e","sender_member_id":"\u003cstring\u003e","sender":"\u003cstring\u003e","sender_display_name":"\u003cstring\u003e","timestamp":"\u003clong\u003e"},{"date_time":"\u003cdateTime\u003e","files":[{"download_url":"\u003cstring\u003e","file_id":"\u003cstring\u003e","file_name":"\u003cstring\u003e","file_size":"\u003cinteger\u003e"},{"download_url":"\u003cstring\u003e","file_id":"\u003cstring\u003e","file_name":"\u003cstring\u003e","file_size":"\u003cinteger\u003e"}],"id":"\u003cstring\u003e","message":"\u003cstring\u003e","receiver":"\u003cstring\u003e","reply_main_message_id":"\u003cstring\u003e","reply_main_message_timestamp":"\u003clong\u003e","sender_member_id":"\u003cstring\u003e","sender":"\u003cstring\u003e","sender_display_name":"\u003cstring\u003e","timestamp":"\u003clong\u003e"}],"from":"\u003cdate\u003e","messages":[{"date_time":"\u003cdateTime\u003e","files":[{"download_url":"\u003cstring\u003e","file_id":"\u003cstring\u003e","file_name":"\u003cstring\u003e","file_size":"\u003cinteger\u003e"},{"download_url":"\u003cstring\u003e","file_id":"\u003cstring\u003e","file_name":"\u003cstring\u003e","file_size":"\u003cinteger\u003e"}],"id":"\u003cstring\u003e","message":"\u003cstring\u003e","receiver":"\u003cstring\u003e","reply_main_message_id":"\u003cstring\u003e","reply_main_message_timestamp":"\u003clong\u003e","sender":"\u003cstring\u003e","sender_member_id":"\u003cstring\u003e","sender_display_name":"\u003cstring\u003e","timestamp":"\u003clong\u003e","bot_message":{"is_markdown_support":"\u003cboolean\u003e","source":"\u003cstring\u003e","external_sender_email":"\u003cstring\u003e","content":{}}},{"date_time":"\u003cdateTime\u003e","files":[{"download_url":"\u003cstring\u003e","file_id":"\u003cstring\u003e","file_name":"\u003cstring\u003e","file_size":"\u003cinteger\u003e"},{"download_url":"\u003cstring\u003e","file_id":"\u003cstring\u003e","file_name":"\u003cstring\u003e","file_size":"\u003cinteger\u003e"}],"id":"\u003cstring\u003e","message":"\u003cstring\u003e","receiver":"\u003cstring\u003e","reply_main_message_id":"\u003cstring\u003e","reply_main_message_timestamp":"\u003clong\u003e","sender":"\u003cstring\u003e","sender_member_id":"\u003cstring\u003e","sender_display_name":"\u003cstring\u003e","timestamp":"\u003clong\u003e","bot_message":{"is_markdown_support":"\u003cboolean\u003e","source":"\u003cstring\u003e","external_sender_email":"\u003cstring\u003e","content":{}}}],"next_page_token":"\u003cstring\u003e","page_size":30,"to":"\u003cdate\u003e"}