Zoom Public API Documentation
Get chat sessions reports
GET {{baseUrl}}/report/chat/sessions?from=<date>&to=<date>&page_size=30&next_page_token=<string>
Gets Zoom Chat session 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 permissions.report_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. | |
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. The expiration period for this token is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"from": "<date>",
"next_page_token": "<string>",
"page_size": 30,
"sessions": [
{
"id": "<string>",
"last_message_sent_time": "<dateTime>",
"name": "<string>",
"type": "Group",
"channel_id": "<string>"
},
{
"id": "<string>",
"last_message_sent_time": "<dateTime>",
"name": "<string>",
"type": "1:1",
"channel_id": "<string>"
}
],
"to": "<date>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/report/chat/sessions?from=<date>&to=<date>&page_size=30&next_page_token=<string>?from=<date>&to=<date>&page_size=30&next_page_token=<string>' -H 'Accept: application/json'
ENDPOINTS