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

调用频率

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

请求信息

请求 URL

GET https://{endpoint}/im/v2.1/chatrooms/{room_id}/messages

请求 URL 中的 {endpoint} 代表服务地址域名，您可以根据用户服务区域选择中国大陆和海外服务地址，并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

请求 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：地理位置；6：文件；10：提示；12：音视频话单；100：自定义。

响应信息

响应头参数

响应 Header 的参数说明请参考 响应 Header。

响应体参数

参数名称	类型	说明	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
has_more	Boolean	是否还有更多数据。	是
next_token	String	分页标识符。	否
- items	Array of objects	返回的聊天室历史消息。	是
sender_id	String	消息发送方账号 ID。	是
message_type	Integer	消息类型。0：文本；1：图片；2：语音；3：视频；4：地址位置；6：文件；10：提示；12：音视频话单；100：自定义。	是
create_time	Long	消息发送时间戳。	是
message_client_id	String	客户端消息 ID。	是
sender_client_type	Integer	消息发送端类型。1：AOS；2：iOS；4：PC；16：Web；32：REST；64：MAC；65：HARMONY。	是
text	String	文本/提示消息内容或多媒体消息的描述文本（该描述信息可用于云端历史消息关键词检索）。	否
attachment	Object	多媒体消息的属性或自定义消息内容。	否
extension	String	消息发送时传入的第三方扩展字段。	否

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
        "has_more": false,
        "items": [
            {
                "text": "api聊天室消息-目标标签={\"tag\":\"class1\"} or {\"tag\":\"class2\"} or {\"tag\": \"中文标签\"}, 2025-07-30T14:32:52.305",
                "message_client_id": "329c***12c79e08a8",
                "sender_id": "yytest12",
                "create_time": 1753857172638,
                "message_type": 0,
                "sender_client_type": 32,
                "extension": "ext-api-2025-07-30T14:32:52"
            },
            {
                "text": "api聊天室消息-目标标签={\"tag\":\"中文标签\"}, 2025-07-30T14:32:51.327",
                "message_client_id": "e8e36***722c9196",
                "sender_id": "yytest12",
                "create_time": 1753857171866,
                "message_type": 0,
                "sender_client_type": 32,
                "extension": "ext-api-2025-07-30T14:32:51"
            }
        ]
    }
}

错误码

本文仅列举部分业务接口错误码，完整列表请参考客户端 API 错误码。

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
102404	用户不存在	account not exist
113404	聊天室不存在	chatroom not exist
113406	聊天室已关闭	chatroom closed
500	服务器内部错误	internal server error