Zoom Public API Documentation
Get IM chat sessions
GET {{baseUrl}}/im/chat/sessions?from=<date>&to=<date>&page_size=30&next_page_token=<string>
Retrieves IM Chat sessions for a specified period of time. This API only supports Oauth2. Scopes: 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.imchat:read, imchat:read:admin
Rate Limit Label: Heavy
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>",
"to": "<date>",
"next_page_token": "<string>",
"page_size": 30,
"sessions": [
{
"last_message_sent_time": "<dateTime>",
"name": "<string>",
"session_id": "<string>",
"type": "1:1"
},
{
"last_message_sent_time": "<dateTime>",
"name": "<string>",
"session_id": "<string>",
"type": "Group"
}
]
} |
Curl
curl -X GET 'https://api.zoom.us/v2/im/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