分页查询聊天室历史消息

请求参数

Path 参数

room_id

string

聊天室 ID

必需

示例值:

1605537145

Query 参数

sender_id

string

必需

发送聊天室消息的账号 ID。

示例值:

yx5

page_token

string

可选

分页标识符，如果为空，则从第一页开始查询。

limit

integer

必需

每页返回的消息数上限，最大为 100。,小于等于 0，或者大于 100，会报 414 错误。

示例值:

100

descending

string

可选

是否按时间正序，true（默认）：按时间正序；false：按时间倒序。

示例值:

false

message_type

string

可选

指定需要查询的消息类型，可指定多个消息类型，类型之间用","分割。不设置该参数则查询全部类型。
例如"0,1,2,3"，其中支持的消息类型如下：0：文本；1：图片；2：语音；3：视频；4：地理位置；5：通知；6：文件；10：提示；11：Robot；100：自定义。

示例值:

0,1,2,3,5

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://open.yunxinapi.com/im/v2/chatrooms/1605537145/messages?sender_id=yx5&limit=100&descending=false&message_type=0,1,2,3,5' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

has_more

boolean

必需

items

array [object {6}]

必需

示例

{
  "code": 200,
  "msg": "success",
  "data": {
    "has_more": false,
    "items": [
      {
        "attachment": {
          "data": {
            "ext": "et ipsum reprehenderit",
            "operator": "yx29"
          },
          "id": 318
        },
        "message_client_id": "cbe48c3c-fcd8-4a86-acb4-7d5bb9bd8220",
        "sender_id": "yx29",
        "create_time": 1709175613496,
        "message_type": 5,
        "sender_client_type": "32"
      },
      {
        "attachment": {
          "data": {
            "ext": "et ipsum reprehenderit",
            "operator": "yx29"
          },
          "id": 319
        },
        "message_client_id": "287682b5-b8e6-46e6-93b7-85486c9a6e0c",
        "sender_id": "yx29",
        "create_time": 1709175277205,
        "message_type": 5,
        "sender_client_type": "32"
      },
      {
        "attachment": {
          "data": {
            "ext": "et ipsum reprehenderit",
            "operator": "yx29"
          },
          "id": 318
        },
        "message_client_id": "f2f01186-da41-47ec-ab30-25b34d040102",
        "sender_id": "yx29",
        "create_time": 1708592514991,
        "message_type": 5,
        "sender_client_type": "32"
      }
    ]
  }
}