在线调试
查询高级群在线成员列表
更新时间: 2025/08/21 17:27:49
该接口用于查询 高级群 的所有在线成员,包括在线用户的账号、登录时间以及登录的设备类型。
调用限制
-
仅 IM 旗舰版及以上套餐 支持使用该接口。
-
单个应用默认最高调用频率请参考 频控说明。
请求信息
请求 URL
GET https://{endpoint}/im/v2/teams/{team_id}/actions/list_online_members
请求 URL 中的 {endpoint}
代表服务地址域名,您可以根据用户服务区域选择中国大陆和海外服务地址,并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。
请求头参数
请求 Header 的参数说明请参考 请求 Header。
路径参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
team_id |
Long | 是 | 需要查询的高级群 ID,创建群组成功时,网易云信服务器会自动生成并返回。 |
查询参数
参数名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
team_type |
Integer | 是 | 群组类型。目前仅支持 team_type = 1,即仅支持高级群。 |
响应信息
响应头参数
响应 Header 的参数说明请参考 响应 Header。
响应体参数
参数名称 | 类型 | 说明 | 是否必返回 |
---|---|---|---|
code |
Integer | 状态码,200 表示请求成功。 | 是 |
msg |
String | 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。 | 是 |
-
data |
Object | 返回的 JSON 数据对象,请求失败则返回空对象。 | 是 |
-
items |
Array of objects | 在线群成员列表。 | 否 |
account_id |
String | IM 账号 ID。 | 否 |
-
online_status |
Array of objects | 登录信息。 | 否 |
login_time |
Long | 登录时间,Unix 时间戳(毫秒)。 | 否 |
client_type |
Integer | 登录的设备类型。 0:UNSET;1:Android;2:IOS;4:PC;8:WINPHONE;16:WEB;32:REST;64:MAC。 |
否 |
响应体示例
JSON{
"code": 200,
"msg": "success",
"data": {
"items": [
{
"account_id": "test1",
"online_status": [
{
"login_time": 1752568359847,
"client_type": 1
}
]
},
{
"account_id": "test",
"online_status": [
{
"login_time": 1752568359719,
"client_type": 1
}
]
}
]
}
}
错误码
本文仅列举部分业务接口错误码,完整列表请参考客户端 API 错误码。
错误码 | 错误码描述 | 错误信息示例 |
---|---|---|
200 | 请求成功 | success |
414 | 参数错误 | parameter error |
416 | 频控超出限制 | rate limit exceeded |
108404 | 群组不存在 | team not exist |
500 | 服务端内部错误 | internal server error |
503 | 服务器繁忙 | server busy |
此文档是否对你有帮助?