Introduction
Using Zoom APIs
Pagination
Error Definitions
Rate Limits
Testing Zoom APIs with Postman
Accounts
Archiving
Billing
Chat Channels
Chat Channels (Account-level)
Chat Messages
Chatbot Messages
Contacts
Cloud Recording
Dashboards
Devices
Groups
IM Chat
IM Groups
Meetings
PAC
Phone
Phone Auto Receptionists
Phone Blocked List
Phone Call Queues
Phone Devices
Phone Reports
Phone Shared Line Groups
Phone Site
Common Area Phones
Roles
Rooms
Rooms Account
Rooms Location
SIP Phone
TrackingField
TSP
Users
Webinars
Rooms Devices
SIP Connected Audio
Deprecated API Endpoints
Archiving Events
Account Events
App Events
Billing Events
Chat Message Events
Chat Channel Events
Chatbot Events
Meeting Events
Phone Events
Recording Events
TSP Events
User Events
Webinar Events
Zoom Room Events
Deprecated API Endpoints
get

/report/chat/sessions

Use this API to get Zoom Chat session 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: Heavy

Prerequisites:

  • A Pro or higher plan
  • Report chat permissions.

Authorization

oauth2 - authorizationCode

Request Parameters

4 Query Parameters

Responses

HTTP Status Code: 200
Archived chat sessions returned.

1 Example
Schema
object
from
string

The query’s start date.

1 validation
to
string

The query’s end date.

1 validation
page_size
integer

The amount of records returns within a single API call.

2 validations
next_page_token
string

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of the available result list exceeds the page size. The expiration period is 15 minutes.

sessions
array[object]

Information about the chat session.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
oauth_access_token