查询用户在线状态 QueryOnlineStatus--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

查询用户在线状态 QueryOnlineStatus

最近更新时间：2024.01.30 16:36:08首次发布时间：2023.05.25 18:20:26

你可以使用此接口查询用户的在线状态。

使用说明

接口行为

你可以通过QueryOnlineStatus接口，指定 AppId 和 UserId，查询指定用户的在线状态。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

注意事项

QPS 不得超过 100。

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=QueryOnlineStatus&Version=2020-12-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`QueryOnlineStatus`	接口名称。当前 API 的名称为 `QueryOnlineStatus`。
Version	String	是	`2020-12-01`	接口版本。当前 API 的版本为 `2020-12-01`。

Body

参数	类型	是否必选	示例值	描述
AppId	Integer	是	`000000`	应用的唯一标志
UserIds	Array of Long	是	`[10001]`	查询用户的 UserId。一次最多查询 100 个成员。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
AppId	Integer	`123`	应用的唯一标志
QueryOnlineResults	JSON Map	`-`	用户在线状态，`key` 为在线用户的 `UserId`，`value` 为在线用户的具体状态，具体参看QueryOnlineResults

QueryOnlineResults

参数	类型	示例值	描述
ClientVersion	Long	`100`	客户端版本号
ConnId	String	`ConnID_1`	连接的唯一标识
DeviceId	Long	`10001`	设备 ID
Platform	String	`Android`	设备平台，目前支持 `Android`、`iOS`和 `Web`。
UserId	Long	`10001`	用户的 UserId

请求示例

POST https://rtc.volcengineapi.com?Action=QueryOnlineStatus&Version=2020-12-01

{
    "AppId":000000,
    "UserIds":[10001]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "Your_RequestId",
    "Action": "QueryOnlineStatus",
    "Version": "2020-12-01",
    "Service": "rtc",
    "Region": "cn-beijing"
  },
  "Result": {
    "AppId": 123,
    "QueryOnlineResults": {
      "10001": [
        {
          "ConnId": "ConnID_1",
          "UserId": 10001,
          "DeviceId": 10001,
          "ClientVersion": 1,
          "Platform": "Android"
        }
      ]
    }
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。