在线调试
查询高级群在线成员列表
更新时间: 2024/09/20 17:40:56
该接口用于查询高级群的所有在线成员,包括在线用户的账号、登录时间以及登录的设备类型。
调用限制
仅 IM 旗舰版及以上套餐 支持使用该接口。
调用频率
单个应用默认最高调用频率请参考 频控说明。
请求
URL
GET https://open.yunxinapi.com/im/v2/teams/:{team_id}/actions/list_online_members
Header
请求 Header 的参数说明请参见请求 Header。
路径参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
team_id |
String | 必选 | 需要查询的高级群 ID,创建群组成功时,云信服务器会自动生成并返回。 |
查询参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
team_type |
Integer | 必选 | 群组类型。目前仅支持 team_type = 1,即仅支持高级群。 |
响应
Header
响应 Header 的参数说明请参见响应 Header。
响应体参数
参数名称 | 类型 | 描述 | 是否必返回 |
---|---|---|---|
code |
Integer | 状态码,200 表示请求成功。 | 是 |
msg |
String | 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。 | 是 |
+
data |
Object | 返回的 JSON 数据对象,请求失败则返回空对象。 | 是 |
响应体示例
json{
"code": 200,
"msg": "success",
"data": {
"items": [
{
"account_id": "accid1",
"online_status": [
{
"login_time": 132316161,
"client_type": 16
},
{
"login_time": 132316161,
"client_type": 8
}
]
}
]
}
}
错误码
错误码 | 错误码描述 | 错误信息示例 |
---|---|---|
200 | 请求成功 | success |
414 | 参数错误 | parameter error |
416 | 频控超出限制 | rate limit exceeded |
108404 | 群组不存在 | team not exist |
500 | 服务端内部错误 | internal server error |
503 | 服务器繁忙 | server busy |
此文档是否对你有帮助?