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

调用限制

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

调用频率

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

请求

URL

GET https://open.yunxinapi.com/im/v2/teams/actions/online_members_count

Header

请求 Header 的参数说明请参见 请求 Header。

查询参数

参数名称	类型	是否必选	描述
team_ids	Array of strings	必选	需要查询的高级群 ID 列表。一次最多查询 100 个高级群。
team_type	Integer	必选	群组类型。目前仅支持 team_type = 1，即仅支持高级群。

响应

Header

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

响应体参数

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

响应体示例

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

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
416	频控超出限制	rate limit exceeded
108316	获取在线人数功能未开启	query online status disabled
500	服务端内部错误	internal server error
503	服务器繁忙	server busy