API 参考
圈组

批量获取群组的在线成员数量

更新时间: 2024/09/20 17:37:51

批量查询群组的在线成员数量,一次最多查询 100 个群组。

API 使用限制

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

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

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

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必填说明
tidsString群 ID 列表,JSONArray,每一项表示一个 tid,最多查询 100 个群组,单个 tid 最大长度 64 位长整型

返回参数

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

data 中的参数说明

参数 类型 说明
tid Long 群 ID
onlineUserCount Integer 在线成员数量
offlineUserCount Integer 非在线成员数量

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9dnk49b***803mgq3" -H "Nonce: 4tgggerg**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tids=["1232"]' 'https://api.netease.im/nimserver/team/listOnlineUserCount.action'

请求成功返回示例

json"Content-Type": "application/json; charset=utf-8"
{
     
    "code": 200,
    "data":
    [
        {
            "tid": 123, 
            "onlineUserCount": 67,   
            "offlineUserCount": 222   
        },
        {
            "tid": 234,
            "onlineUserCount": 120,
            "offlineUserCount": 33
        }
    ]         
}

请求失败返回示例

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

状态码

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

状态码 说明 处理建议
200 请求成功 -
403 禁止操作 -
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
416 调用频率超出限制 降低访问频率
500 服务出错 -
此文档是否对你有帮助?
有帮助
去反馈
  • API 使用限制
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例(curl)
  • 请求成功返回示例
  • 请求失败返回示例
  • 状态码