API 参考
在线调试

分页查询聊天室历史消息

更新时间: 2024/07/17 16:53:41

该接口可以分页查询指定账号在聊天室中的历史消息。

调用频率

单个应用默认最高调用频率请参考 频控说明

请求

URL

GET https://open.yunxinapi.com/im/v2/chatrooms/:{room_id}/messages

请求 Header 的参数说明请参见请求 Header

路径参数

参数名称 类型 是否必选 描述
room_id Long 必选 聊天室 ID。

查询参数

参数名称 类型 是否必选 描述
sender_id String 必选 发送聊天室消息的账号 ID。
page_token String 可选 分页标识符,如果为空,则从第一页开始查询。
limit Integer 必选 每页返回的消息数上限,最大为 100。,小于等于 0,或者大于 100,会报 414 错误。
descending Boolean 可选 是否按时间正序,true(默认):按时间正序;false:按时间倒序。
message_type String 可选 指定需要查询的消息类型,可指定多个消息类型,类型之间用","分割。不设置该参数则查询全部类型。
例如"0,1,2,3",其中支持的消息类型如下:0:文本;1:图片;2:语音;3:视频;4:地理位置;5:通知;6:文件;10:提示;11:Robot;100:自定义。

响应

Header

响应 Header 的参数说明请参见响应 Header

响应体参数

参数名称 类型 描述 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
data Object 返回的 JSON 数据对象,请求失败则返回空对象。

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "has_more": true,
        "next_token": "xs9oS5VowsDoSrQcSR==",
        "items": [
            {
                "text": "ygytest",
                "message_client_id": "c5a31b22-49e8-453e-b565-589f1438af01",
                "sender_id": "yx2",
                "create_time": 1697799996887,
                "message_type": 0,
                "sender_client_type": "32",
                "extension": "ext-2023-10-20T19:06:36"
            },
            {
                "text": "ygytest",
                "message_client_id": "7ba599d3-1c6e-4bd9-aaed-f128d84da3d4",
                "sender_id": "yx2",
                "create_time": 1697790140696,
                "message_type": 0,
                "sender_client_type": "32",
                "extension": "ext-2023-10-20T16:22:20"
            }
        ]
    }
}

错误码

错误码 错误码描述 错误信息示例
200 请求成功 success
414 参数错误 parameter error
102404 用户不存在 account not exist
113404 聊天室不存在 chatroom not exist
113406 聊天室已关闭 chatroom closed
500 服务器内部错误 internal server error
此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求
  • URL
  • Header
  • 路径参数
  • 查询参数
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码