查询指定群组的在线成员列表。

API 使用限制

• 单个应用中 1 秒内所有的高级群操作 API 合计最多可调用 100 次，超过后限制调用，会返回 416 错误码。

  除发送群消息 API 外，其他所有高级群 API 都属于高级群操作 API。

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

URL

POST https://api.netease.im/nimserver/team/listOnlineUsers.action  HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

• POST 请求中 Headers 的设置请参考API 调用方式。
• POST 请求中 Body 的设置如下：

参数	类型	必填	说明
tid	Long	是	云信服务器产生，群唯一标识，创建群时会返回，最大长度 64 位长整型

返回参数

参数	类型	说明
code	Integer	状态码
data	String	在线群成员信息

data 中的参数说明

参数	类型	说明
count	Integer	在线群成员数量
status	String	在线成员状态，包含登录时间（loginTime）和在线属性（客户端类型，clientType）

clientType 说明：Android(1)；IOS(2)；PC(4)；WEB(16)；REST(32)；MAC(64)；HARMONY(65)

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9dnk49bk***lw0803mgq3" -H "Nonce: 4tggge**ow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1232' 'https://api.netease.im/nimserver/team/listOnlineUsers.action'

请求成功返回示例

json"Content-Type": "application/json; charset=utf-8"
{
     
    "code": 200,
    "data": {
        "count": 2,
        "status": {
            "acc01": [       //accid   String
                {
                    "loginTime": 1571296813350, 
                    "clientType": 16    
                }
            ],
            "acc02": [
                {
                    "loginTime": 1571296813350,
                    "clientType": 16
                },
                {
                    "loginTime": 1571296813350,
                    "clientType": 16
                }
            ]
        }
    }          
}

请求失败返回示例

"Content-Type": "application/json; charset=utf-8"
{
"code": 414,  // 参数错误
"desc": "xxxx  is empty" 
}

状态码

该接口在 HTTPS Body 中返回请求的状态码，以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。

状态码	说明	处理建议
200	请求成功	-
403	禁止操作	-
414	参数错误	根据提示信息，检查传入参数的格式和限制条件
416	调用频率超出限制	降低访问频率
500	服务出错	-