Zoom API
  1. IM Chat
Zoom API
  • Accounts
    • List sub accounts
      GET
    • Create a sub account
      POST
    • Disassociate a sub account
      DELETE
    • Get sub account details
      GET
    • Get locked settings
      GET
    • Update locked settings
      PATCH
    • Get managed domains
      GET
    • Update options
      PATCH
    • Update the account owner
      PUT
    • Get settings
      GET
    • Update settings
      PATCH
    • Delete virtual background files
      DELETE
    • Upload virtual background files
      POST
    • Get trusted domains
      GET
  • Billing
    • Get billing information
      GET
    • Update billing information
      PATCH
    • List billing invoices
      GET
    • Get invoice details
      GET
    • Get plan Information
      GET
    • Subscribe plans
      POST
    • Subscribe additional plan
      POST
    • Update an additional plan
      PUT
    • Cancel additional plans
      PATCH
    • Update a base plan
      PUT
    • Cancel a base plan
      PATCH
    • Get plan usage
      GET
    • Download an invoice file
      GET
  • Phone
    • Update BYOC settings
    • Set up a Zoom Phone account
    • Assign SIP trunks
    • Update SIP trunk details
    • Add BYOC phone numbers
    • Get account's call logs
    • List calling plans
    • Change main company number
    • List phone numbers
    • Get phone number details
    • Update phone number details
    • Get call recordings
    • List setting templates
    • Add a setting template
    • Get setting template details
    • Update a setting template
    • List BYOC SIP trunks
    • List phone users
    • Get user's profile
    • Update user's profile
    • Get user's call logs
    • Delete a user's call log
    • Assign calling plan to a user
    • Unassign user's calling plan
    • Assign phone number to user
    • Unassign phone number
    • Get user's recordings
    • Get user's settings
    • Remove shared access
    • Update shared access
    • Set up shared access
    • Get user's voicemails
    • Delete a voicemail
  • Cloud Recording
    • List recordings of an account
    • List archived files
    • Delete meeting recordings
    • Get meeting recordings
    • List recording registrants
    • Create a recording registrant
    • Get registration questions
    • Update registration questions
    • Update registrant's status
    • Get meeting recording settings
    • Update meeting recording settings
    • Recover meeting recordings
    • Delete a meeting recording file
    • Recover a single recording
    • List all recordings
  • SIP Connected Audio
    • List internal call-out countries
    • Add internal call-out countries
    • Delete internal call-out country
    • List internal numbers
    • Add internal numbers
    • Delete an internal number
    • Delete all numbers
    • Assign numbers
    • Assign SIP trunk configuration
    • List SIP trunks
    • Assign SIP trunks
    • Delete a SIP trunk
    • List SIP trunk numbers
  • Users
    • Switch a user's account
    • List users
    • Create users
    • Check a user email
    • Get user's ZAK
    • Check a user's PM room
    • Delete a user
    • Get a user
    • Update a user
    • Delete user assistants
    • List user assistants
    • Add assistants
    • Delete a user assistant
    • Update a user's email
    • Update a user's password
    • Get user permissions
    • Upload a user's profile picture
    • Update a user's presence status
    • Delete user schedulers
    • List user schedulers
    • Delete a scheduler
    • Get user settings
    • Update user settings
    • Delete virtual background files
    • Upload virtual background files
    • Update user status
    • Revoke a user's SSO token
    • Get a user token
  • Chat Channels
    • Delete a channel
    • Get a channel
    • Update a channel
    • Leave a channel
    • Join a channel
    • Remove a member
    • List user's channels
    • Create a channel
  • Contacts
    • List user's contacts
    • Get user's contact details
    • Search company contacts
  • Chat Channels (Account-level)
    • Delete a channel
    • Get a channel
    • Update a channel
    • List channel members
    • Invite channel members
    • Remove a member
  • Chat Messages
    • List user's chat messages
    • Send a chat message
    • Delete a message
    • Update a message
  • Groups
    • List groups
    • Create a group
    • Delete a group
    • Get a group
    • Update a group
    • Get locked settings
    • Update locked settings
    • List group members
    • Add group members
    • Delete a group member
    • Update a group member
    • Get a group's settings
    • Update a group's settings
    • Delete virtual background files
    • Upload virtual background files
  • Devices
    • List H.323/SIP devices
    • Create a H.323/SIP device
    • Delete a H.323/SIP device
    • Update a H.323/SIP device
  • Chatbot Messages
    • Send chatbot messages
    • Delete a chatbot message
    • Edit a chatbot message
  • IM Chat
    • Get IM chat sessions
      GET
    • Get IM chat messages
      GET
    • Send IM messages
      POST
    • Get user’s IM messages
      GET
  • IM Groups
    • List IM directory groups
    • Create an IM directory group
    • Delete an IM directory group
    • Retrieve an IM directory group
    • Update an IM directory group
    • List IM directory group members
    • Add IM directory group members
    • Delete an IM directory group member
  • Meetings
    • Use in-Meeting recording controls
    • Delete a meeting
    • Get a meeting
    • Update a meeting
    • Perform batch poll creation
    • Get meeting invitation
    • Get live stream details
    • Update a live stream
    • Update Live Stream Status
    • List meeting polls
    • Create a meeting poll
    • Delete a meeting poll
    • Get a meeting poll
    • Update a meeting poll
    • List meeting registrants
    • Add meeting registrant
    • List registration questions
    • Update registration questions
    • Update registrant's status
    • Delete a meeting registrant
    • Update meeting status
    • List ended meeting instances
    • List past meeting's poll results
    • Get past meeting details
    • Get past meeting participants
    • List meeting templates
    • List meetings
    • Create a meeting
  • Dashboards
    • List Zoom meetings client feedback
    • Get zoom meetings client feedback
    • List client meeting satisfaction
    • Get CRC port usage
    • Get IM metrics
    • Get top 25 Zoom Rooms with issues
    • Get issues of Zoom Rooms
    • List meetings
    • Get meeting details
    • List meeting participants
    • List meeting participants QoS
    • Get post meeting feedback
    • Get sharing/recording details
    • Get meeting participant QoS
    • List webinars
    • Get webinar details
    • Get webinar participants
    • List webinar participant QoS
    • Get post webinar feedback
    • Get sharing/recording details
    • Get webinar participant QoS
    • List Zoom Rooms
    • Get top 25 issues of Zoom Rooms
    • Get Zoom Rooms details
    • List call logs
    • Get call QoS
    • Get call details from call log
  • Deprecated API Endpoints
    • List past meeting's files
    • List past webinar files
  • Webinars
    • Get webinar absentees
    • List past webinar instances
    • List webinar participants
    • List past webinar poll results
    • List Q&A of past webinar
    • List webinar templates
    • List webinars
    • Create a webinar
    • Delete a webinar
    • Get a webinar
    • Update a webinar
    • Perform batch registration
    • Remove panelists
    • List panelists
    • Add panelists
    • Remove a panelist
    • List a webinar's polls
    • Create a webinar's poll
    • Delete a webinar poll
    • Get a webinar poll
    • Update a webinar poll
    • List webinar registrants
    • Add a webinar registrant
    • List registration questions
    • Update registration questions
    • Update registrant's status
    • Delete a webinar registrant
    • Get a webinar registrant
    • Update webinar status
    • Get webinar tracking sources
  • Phone Auto Receptionists
    • Add an auto receptionist
    • Update auto receptionist details
    • Unassign all phone numbers
    • Assign phone numbers
    • Unassign a phone number
  • Phone Blocked List
    • List blocked lists
    • Create a blocked list
    • Delete a blocked list
    • Get blocked list details
    • Update a blocked list
  • Phone Call Queues
    • List call queues
    • Create a call queue
    • Delete a call queue
    • Get call queue details
    • Update call queue details
    • Change call queue manager
    • Unassign all members
    • Add members to a call queue
    • Unassign a member
    • Unassign all phone numbers
    • Assign numbers to a call queue
    • Unassign a phone number
    • Get call queue recordings
  • Common Area Phones
    • List common area phones
    • Add a common area phone
    • Delete a common area phone
    • Get common area phone details
    • Update common area phone
  • Phone Devices
    • List devices
    • Add a device
    • Delete a device
    • Get device details
    • Update a device
  • Phone Reports
    • Get operation logs report
  • Phone Shared Line Groups
    • List shared line groups
    • Create a shared line group
    • Delete a shared line group
    • Get a shared line group
    • Update a shared line group
    • Unassign members of a shared line group
    • Add members to a shared line group
    • Unassign a member from a shared line group
    • Assign phone numbers
    • Unassign a phone number
  • Phone Site
    • List phone sites
    • Create a phone site
    • Delete a phone site
    • Get phone site details
    • Update phone site details
  • Reports
    • Get sign In / sign out activity report
    • Get cloud recording usage report
    • Get daily usage report
    • Get meeting detail reports
    • Get meeting participant reports
    • Get meeting poll reports
    • Get operation logs report
    • Get telephone reports
    • Get active/inactive host reports
    • Get meeting reports
    • Get webinar detail reports
    • Get webinar participant reports
    • Get webinar poll reports
    • Get webinar Q&A report
  • Roles
    • List roles
    • Create a role
    • Delete a role
    • Get role information
    • Update role information
    • List members in a role
    • Assign a role
    • Unassign a role
  • Rooms
    • List Zoom Rooms
    • Add a Zoom Room
    • List digital signage contents
    • Update E911 digital signage
    • Check-in or check-out of a Zoom Room
    • Delete a Zoom Room
    • Get Zoom Room profile
    • Update a Zoom Room profile
    • List Zoom Room devices
    • Change a Zoom Room's location
    • Get Zoom Room settings
    • Update Zoom Room settings
  • Rooms Account
    • Get Zoom Room account profile
    • Update Zoom Room account profile
    • Get Zoom Room account settings
    • Update Zoom Room account settings
  • Rooms Location
    • List Zoom Room locations
    • Add a location
    • Get Zoom Room location structure
    • Update Zoom Rooms location structure
    • Get Zoom Room location profile
    • Update Zoom Room location profile
    • Change the assigned parent location
    • Get location settings
    • Update location settings
  • Rooms Devices
    • Change Zoom Rooms' app version
  • SIP Phone
    • List SIP phones
    • Enable SIP phone
    • Delete SIP phone
    • Update SIP phone
  • TrackingField
    • List tracking fields
    • Create a tracking field
    • Delete a tracking field
    • Get a tracking field
    • Update a tracking field
  • TSP
    • Get account's TSP information
    • Update account's TSP information
    • List user's TSP accounts
    • Add a user's TSP account
    • Set global dial-in URL for a TSP user
    • Delete a user's TSP account
    • Get a user's TSP account
    • Update a TSP account
  • PAC
    • List a user's PAC accounts
  • Data Compliance
  • Webhooks
  • master account APIs
  1. IM Chat

Get user’s IM messages

将废弃
GET
/im/users/{userId}/chat/messages
Get IM Chat messages for a specified period of time.

Scopes: imchat:read
Rate Limit Label: Medium
Please see the announcements page related to this deprecation.
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://api.zoom.us/v2/im/users//chat/messages'
响应示例响应示例
{
    "date": "string [date]",
    "messages": [
        {
            "date_time": "string [date-time]",
            "id": "string",
            "message": "string",
            "sender": "string",
            "timstamp": "Long"
        }
    ],
    "next_page_token": "string",
    "page_size": "integer"
}

请求参数

Path 参数
userId
string 
必需
The user ID or email address.
Query 参数
chat_user
string 
可选
Chat user's ID or email address.
channel
string 
可选
IM Channel's ID.
date
string 
可选
IM message's query date time, format as yyyy-MM-dd.
page_size
integer 
可选
The number of records returned within a single API call.
>= 1<= 100
默认值:
30
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 available results exceeds the current page size. The expiration period for this token is 15 minutes.

返回响应

🟢200**HTTP Status Code:** `200`<br> User's IM messages returned.
application/json
Body
date
string <date-time>
可选
Query date time, format as yyyy-mm-dd.
messages
array [object {5}] 
可选
Array of im messages.
date_time
string <date-time>
可选
IM message send time.
id
string <uuid>
可选
IM message UUID.
message
string 
可选
IM message content.
sender
string 
可选
IM message sender.
timstamp
integer 
可选
IM message send timestamp.
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 available results exceeds the current page size. The expiration period for this token is 15 minutes.
page_size
integer 
可选
The number of records returned within a single API call.

【Zoom】API开发者 微信交流群

用微信扫右侧二维码，加入【Zoom】API开发者 交流群，互助沟通

扫码加入交流群
修改于 2024-04-24 09:06:48
上一页
Send IM messages
下一页
List IM directory groups
Built with