在线调试

批量查询会话信息

更新时间: 2025/12/05 15:17:58

该接口用于批量查询指定会话列表的信息。

每调用一次,只能查询某一账号的多个会话信息,不支持多个用户的会话信息混合批量查询。

调用频率

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

请求信息

请求 URL

GET https://{endpoint}/im/v2.1/conversations/actions/conversation_ids

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

请求头参数

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

查询参数

参数名称 类型 是否必选 说明 示例
conversation_ids String 需要查询的会话 ID 列表。该值是由多个经过 URL 编码后的会话 ID 组成,以逗号分隔,一次最多查询 100 个会话。
如果提供的会话列表中某个会话 ID 不存在,则返回查询成功的会话信息以及查询失败的会话 ID 列表。
account_id1|1|account_id2,account_id1|2|team_id,account_id1|3|team_id

响应信息

响应头参数

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

响应体参数

参数名称 类型 说明 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
- data Object 返回的 JSON 数据对象,请求失败则返回空对象。
- success_list 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_state 为 1 时返回。
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 会话最近已读时间(毫秒)。
- failed_list Array of objects 查询失败的会话 ID 列表。
conversation_id String 会话 ID。
error_code Integer 查询失败的错误码。
error_msg String 查询失败的提示信息。

响应体示例

JSON{
  "code": 200,
  "msg": "success",
  "data": {
    "success_list": [
      {
        "type": 1,
        "conversation_id": "qaz|1|wm202",
        "sender_id": "qaz",
        "receiver_id": "wm202",
        "server_extension": "",
        "group_ids": [],
        "last_message": {
            "text": "{\"msg\":\"2025-07-31T18:35:07.888文本消息测试-单聊-检索检索jin\"}",
            "extension": "ext",
            "message_server_id": 158844561857183746,
            "sender_id": "yytest3",
            "message_client_id": "902da5***22578b8",
            "conversation_type": 2,
            "receiver_id": "2366968421",
            "create_time": 1753958108323,
            "message_type": 0,
            "sender_client_type": 32
        },
        "message_state": 0,
        "unread_count": 0,
        "stick_top": false,
        "sort_order": 1753087560612,
        "create_time": 1753087482083,
        "update_time": 1753262035450,
        "last_read_time": 1749025321070
      }
    ]
  }
}

错误码

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

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