分页查询指定账号的指定会话分组的会话列表

更新时间: 2026/02/10 14:08:04

该接口可以分页查询指定账号的指定会话分组中的会话列表。

  • 会话分组中最多 1000 个会话,建议分页获取,每页最多可查询 100 条会话。
  • 根据会话的 sort_order 属性排序,置顶会话排在最前,若有多条置顶会话,则根据会话的最后一条消息时间进行排序。

调用频率

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

请求信息

请求 URL

GET https://{endpoint}/im/v2/conversation_groups/{group_id}/conversations

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

请求头参数

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

路径参数

参数名称 类型 是否必选 描述
group_id Long 会话分组 ID。

查询参数

参数名称 类型 是否必选 描述
account_id String 需要查询的 IM 账号。
descending Boolean 是否按照 sort_order(会话属性) 降序排列。默认为 false。
page_token String 分页标识符(标识查询位置索引的字符串值),如果为空,则默认从第一条记录开始查询。后续传入上一次查询返回的 next_token 值。
limit Integer 每页返回的会话数,最大为 100。若传入小于等于 0 的数,默认为 100。

响应信息

响应头参数

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

响应体参数

参数名称 类型 说明 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
- data Object 返回的 JSON 数据对象,请求失败则返回空对象。
has_more Boolean 是否还有更多数据。
next_token String 分页标识符,下一次拉取数据的偏移量。
- items Array of objects 返回的会话信息。
conversation_id String 会话 ID。
sender_id String 会话消息发送者的账号 ID。
receiver_id String 接收会话消息的账号 ID 或群组 ID。
type Integer 会话类型
  • 1:单聊会话
  • 2:高级群会话
  • 3:超大群会话
stick_top Boolean 是否为置顶会话。
group_ids Array of longs 会话所属分组列表。
server_extension String 服务端扩展字段。
message_state Integer 会话列表里的消息类型
  • 0:表示普通消息
  • 1:表示被撤回的消息
- last_message Object 会话中的最后一条消息。如果是撤回消息,该字段为空,具体内容参考 revoke_notification
message_server_id Long 服务端消息ID。
message_client_id String 客户端消息 ID。若不传入,则会自动生成。
sender_id String 消息发送者ID。
conversation_type Integer 会话类型,1:单聊会话;2:高级群会话;3:超大群会话。
receiver_id String 消息接收者ID。
team_id Long 群组 ID。team_id 与 receiver_id 只会返回其一。
message_type Integer 消息类型,0:文本;1:图片;2:语音;3:视频;4:地址位置;6:文件;10:提示;12:音视频话单,100:自定义。
sub_type Integer 消息子类型。用于对消息进行二级分类,取值范围为大于 0 的正整数。推荐自定义消息类型使用此字段区分不同业务场景,其他消息类型可根据实际需求选择性使用。
create_time Long 消息创建时间(毫秒)。
text String 消息文本内容。
attachment Object 多媒体消息的属性或自定义消息内容。
extension String 消息扩展字段。
sender_client_type Integer 发送者客户端类型。1:AOS;2:iOS;4:PC;16:WEB;32:REST;64:MAC;65:HARMONY。
- revoke_notification Object 消息撤回通知。message_state1 时返回。
server_id Long 被撤回的消息 ID。
attach String 被撤回的消息的附件信息。
revoke_id String 消息撤回者的账号 ID。
custom_info String 服务端撤回填入的自定义信息。
revoke_type Integer 消息撤回类型
  • 0:未定义
  • 1:单聊双向撤回
  • 2:群聊双向撤回
  • 3:单聊单向撤回
  • 4:群聊单向撤回
unread_count Integer 会话消息未读数。
sort_order Long 会话排序字段,默认将置顶会话排首位,如有多条置顶会话,则按其创建时间进行排序。
create_time Long 会话创建时间(毫秒)。
update_time Long 会话更新时间(毫秒)。
last_read_time Long 会话最近已读时间(毫秒)。

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
        "items": [
            {
                "type": 1,
                "conversation_id": "yx10|1|yx12",
                "sender_id": "yx10",
                "receiver_id": "yx12",
                "server_extension": "server_extension-wcg7v",
                "group_ids": [
                    2331452
                ],
                "last_message": {
                    "text": "2026-01-19T17:02:20.441 文本消息测试-ycb5ki0low",
                    "attachment": "{\"title\":\"浙江省 杭州市 滨江区 网商路599号\",\"lng\":120.1908686708565,\"lat\":30.18704515647036,\"search\":\"消息检索\"}",
                    "extension": "ext-sdk-p2p",
                    "message_server_id": 547935111,
                    "sender_id": "yx10",
                    "message_client_id": "4f494374***b22cba383",
                    "conversation_type": 1,
                    "receiver_id": "yx12",
                    "create_time": 1768813340526,
                    "message_type": 4,
                    "sender_client_type": 4
                },
                "message_state": 0,
                "unread_count": 0,
                "stick_top": false,
                "sort_order": 1768813340526,
                "create_time": 1768810692614,
                "update_time": 1769075327788,
                "last_read_time": 0
            },
            {
                "type": 1,
                "conversation_id": "yx10|1|yx14",
                "sender_id": "yx10",
                "receiver_id": "yx14",
                "server_extension": "",
                "group_ids": [
                    2331452
                ],
                "revoke_notification": {
                    "attach": "attach-sdk协议P2P撤回消息-2026-01-19T16:55:42",
                    "server_id": 547935017,
                    "revoke_id": "yx14",
                    "custom_info": "sdk协议P2P撤回消息2026-01-19T16:55:42",
                    "revoke_type": 1
                },
                "message_state": 1,
                "unread_count": 1,
                "stick_top": false,
                "sort_order": 1768812935120,
                "create_time": 1765965933633,
                "update_time": 1769075327417,
                "last_read_time": 0
            }
        ],
        "has_more": true,
        "next_token": "xsV8wKQBxrD**8xsOBSrVRwn=="
    }
}

错误码

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

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