List user's chat messages

GET

/chat/users/{userId}/messages

Chat Messages

A Zoom user can have conversations with other Zoom users via chat. Use this API to list the current user's chat messages between the user and an individual contact or a chat channel.
In the query parameter, you must provide either of the following:

to_contact: The email address of the contact with whom the user conversed by sending/receiving messages.

to_channel: The channel ID of the channel to/from which the user has sent and/or received messages.

Specify a date in the date query parameter to view messages from that date. If a date is not provided, the default value for the query will be the current date.

Note: For an account-level OAuth app, this API can only be used on behalf of a user who is assigned with a role that has View or Edit permission for Chat Messages.

Scopes: chat_message:read, chat_message:read:admin

Rate Limit Label: Medium

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/chat/users//messages'

响应示例

200 - response

{
  "date": "2019-09-17",
  "messages": [
    {
      "date_time": "2019-09-17T20:25:21Z",
      "id": "F3CbafdljsfjkdfgBA7",
      "message": "And you?",
      "sender": "myemail@someemailaddr.com",
      "timestamp": 1568751921626
    },
    {
      "date_time": "2019-09-17T20:25:17Z",
      "id": "B0DbfdgdfhAAfgf237000",
      "message": "I am good",
      "sender": "myemail@someemailaddr.com",
      "timestamp": 1568751917976
    },
    {
      "date_time": "2019-09-17T20:24:13Z",
      "id": "C9Bbdfgd4sad301",
      "message": "How are you",
      "sender": "myfriendsemail@someemailaddr.us",
      "timestamp": 1568751853297
    },
    {
      "date_time": "2019-09-17T20:22:26Z",
      "id": "769fgdgdfgfd4566F7B96665",
      "message": "hello",
      "sender": "myfriendsemail@someemailaddr.us",
      "timestamp": 1568751746769
    }
  ],
  "next_page_token": "",
  "page_size": 10
}

请求参数

Path 参数

userId

string

必需

Query 参数

to_contact

string

可选

The email address of a chat contact with whom the current user chatted. Messages that were sent and/or received between the user and the contact is displayed.

Note: You must provide either contact or channel as a query parameter to retrieve messages either from an individual or a chat channel.

to_channel

string

可选

The channel Id of a channel inside which the current user had chat conversations. Messages that were sent and/or received between the user and the channel is displayed.

Note: You must provide either contact or channel as a query parameter to retrieve messages either from an individual or a chat channel.

date

string <date>

可选

The query date for which you would like to get the chat messages.

page_size

integer

可选

The number of records returned with a single API call.

<= 50

默认值:

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.

include_deleted_and_edited_message

string

可选

Optional

Set the value of this field to true to include edited and deleted messages in the response.

返回响应

🟢200**HTTP Status Code:**`200` List of chat messages returned.

application/json

Body

Chat message object.

date

string <date>

可选

The date provided in the query parameter. If a date is not provided, the default value is the current date.

messages

array [object {8}]

可选

List of message(s).

date_time

string

可选

The date-time at which the message was sent.

string

可选

Message ID: Unique Identifier of the message.

message

string

可选

The message content.

reply_main_message_id

string

可选

Unique identifier of a reply. This field will only be returned if the message is a reply message.

reply_main_message_timestamp

integer <int64>

可选

Timestamp of when the reply message was sent. This field will only be returned if the message is a reply message.

The value of this field will be in long format(int64).

sender

string

可选

The email address of the sender of the message.

status

enum<string>

可选

This field indicates whether a message is an original message(unedited), an edited message or a deleted message.

This field is only returned if you set the value of for include_deleted_and_edited_message query parameter to true.

枚举值:

DeletedEditedNormal

timestamp

integer <int64>

可选

The timestamp of the message in microseconds.

next_page_token

string

可选

page_size

integer

可选

The number of records returned with a single API call.

默认值:

🟠400**HTTP Status Code:** `400` Bad request. **Error Code:** `200` Unauthorized request. You do not have permission to access this user's chat messages. **Error Code:** `300` The next page token is invalid or expired. **Error Code:** `3

🟠404**HTTP Status Code:** `404` **Error Code**: `1001` User does not exist: $to_contact. **Error Code**: `4130` Channel does not exist: $to_channel.

修改于 2024-04-24 09:06:48

Remove a member

Send a chat message