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
Contacts
Cloud Recording
Dashboards
Devices
Groups
IM Groups
Meetings
PAC
Reports
Roles
SIP Connected Audio
SIP Phone
Tracking Field
TSP
Users
Webinars
Zoom Rooms
Zoom Rooms Account
Zoom Rooms Location
Zoom Rooms Devices
Deprecated API Endpoints
Account
Audio Library
Auto Receptionists
Blocked List
Call Handling
Call Logs
Call Queues
Carrier Reseller
Common Area Phones
Dashboard
Devices
Directory Backup Routing Rules
Emergency Service Locations
External Contacts
IVR
Monitoring Groups
Phone Numbers
Provider Exchange
Recordings
Reports
Setting Templates
Settings
Shared Access
Shared Line Group
Site
SMS
Users
Voicemails
Zoom Rooms
Cloud Recording
Sessions
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
Video SDK Events
Zoom Room Events
Deprecated API Endpoints
get

/im/chat/sessions/{sessionId}

Retrieve IM chat messages for a specified period of time. This API only supports oauth2.

Scopes: imchat:read

Rate Limit Label: Medium


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.

Deprecated

Avoid using this API operation if possible. It will be removed in a future version.

Authorization

oauth2 - authorizationCode

Request Parameters

1 Path Parameter
4 Query Parameters

Responses

HTTP Status Code: 200
Archived IM chat messages returned.

1 Example
Schema
object

Pagination object.

session_id
string

IM chat session ID.

from
string

Start date.

1 validation
to
string

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.

messages
array[object]

Array of session objects.

Send a Test Request

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