在线调试

获取会话总未读数

更新时间: 2025/08/21 17:27:49

该接口用于查询某账号的所有会话消息未读数。

调用频率

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

请求信息

请求 URL

GET https://{endpoint}/im/v2/conversation_overviews/{account_id}

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

请求头参数

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

路径参数

参数名称 类型 是否必选 描述
account_id String IM 账号 ID。

响应信息

响应头参数

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

响应体参数

参数名称 类型 说明 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
- data Object 返回的 JSON 数据对象,请求失败则返回空对象。
account_id String IM 账号 ID。
unread_count Integer 所有会话消息未读数。

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
        "account_id": "Accid1",
        "unread_count": 0
    }
}

错误码

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

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