服务端
API 参考
圈组

批量查询账号在线状态

更新时间: 2024/03/15 14:27:33

云信支持批量查询账号的在线状态,一次最多可查询 100 个账号。

API 使用限制

单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API调用方式

  • POST 请求中 Body 的设置如下:

参数名称 类型 必填 描述
accids Array of strings 需要查询的用户帐号 ID 列表,一次最多查询 100 个账号。
例如:["id1", "id2", "id3"],格式错误会返回 414 参数错误。

返回参数

参数名称 类型 描述
code Integer 状态码,200 表示调用成功。
data Object 查询的数据结果。

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9dnk49bk****0803mgq3" -H "Nonce: 4tgggerg**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b***55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accids=%5B%22user1%22%2C%22user2%22%5D' 'http://api.netease.im/nimserver/user/userOnlineStatus.action'

请求成功返回示例

json"Content-Type": "application/json; charset=utf-8"
{
  "code": 200,
  "data": {
    "invalidAccids": [
      "user2"
    ],
    "status": {
      "user1": [
        {
          "loginTime": 1571296813350,
          "clientType": 16
        }
      ]
    }
  }
}

请求失败返回示例

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

状态码

该 API 在 HTTPS Body 中返回请求的状态码,状态码详情请参见状态码

此文档是否对你有帮助?
有帮助
去反馈
  • API 使用限制
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例(curl)
  • 请求成功返回示例
  • 请求失败返回示例
  • 状态码