在线调试

批量查询高级群的在线成员数

更新时间: 2025/11/28 10:24:27

该接口用于批量查询 高级群 的在线成员数量,一次最多查询 100 个群组。

调用限制

  • IM 旗舰版及以上套餐 支持使用该接口。

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

请求信息

请求 URL

GET https://{endpoint}/im/v2/teams/actions/online_members_count

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

请求头参数

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

请求查询参数

参数名称 类型 是否必选 示例 说明
team_ids Array of longs 12345678998,12345678999 需要查询的群组 ID 列表。一次最多查询 100 个群组。
team_type Integer 1 群组类型。
目前仅支持 team_type = 1,即仅支持高级群。

响应信息

响应头参数

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

响应体参数

参数名称 类型 说明 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"
- data Object 返回的 JSON 数据对象,请求失败则返回空对象。
- success_list Array of objects 查询成功的高级群列表。
team_id Long 高级群 ID。
online_count Integer 在线群成员数量。
offline_count Integer 离线群成员数量。
- failed_list Array of objects 查询失败的高级群列表。
team_id Long 高级群 ID。
error_code Integer 操作失败的错误码。
error_msg String 操作失败的错误信息。

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
        "success_list": [
            {
                "team_id": 44075881325,
                "online_count": 111,
                "offline_count": 2222
            }
        ],
        "failed_list": [
            {
                "team_id": 44075881326,
                "error_code": 108404,
                "error_msg": "team does not exist"
            }
        ]
    }
}

错误码

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

错误码 错误码描述 错误信息示例
200 请求成功 success
414 参数错误 parameter error
416 频控超出限制 rate limit exceeded
108316 获取在线人数功能未开启 query online status disabled
500 服务端内部错误 internal server error
503 服务器繁忙 server busy
此文档是否对你有帮助?
有帮助
去反馈
  • 调用限制
  • 请求信息
  • 请求 URL
  • 请求头参数
  • 请求查询参数
  • 响应信息
  • 响应头参数
  • 响应体参数
  • 响应体示例
  • 错误码