接口行为

你可以使用此接口，指定你所属的 AppId和RoomId，获取指定房间的实时用户列表。

调用接口

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

接口限制

QPS 不得超过 40。

请求方式

使用 GET 方式发起请求。

请求参数

Query

参数名	类型	必填	示例值	描述
Action	String	是	`GetRoomOnlineUsers`	接口名称，本接口取值：`GetRoomOnlineUsers`
Version	String	是	`2023-08-01`	接口版本，本接口取值：`2023-08-01`
AppId	String	是	`Your_AppId`	你的音视频应用的唯一标志
RoomId	String	是	`Your_RoomId`	指定房间 ID

请求示例代码

Query

https://rtc.volcengineapi.com?Action=GetRoomOnlineUsers&Version=2023-08-01&AppId=Your_AppId&RoomId=Your_RoomId
postscript

返回调用结果

返回参数说明

返回结果参看 BaseResponse。其中 Result 的结构如下：

参数名	类型	描述
RoomExist	Bool	查询的房间是否存在。 true：存在。 false：不存在。当 `RoomExist` 的值为 `false` 时，不会返回其他字段。
TotalUser	Int	查询到的用户总数
TotalInvisibleUser	Int	查询到的不可见用户总数。不可见用户最多返回 10000 名。
VisibleUserList	Array of String	可见用户列表
InvisibleUserList	Array of String	不可见用户列表

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "GetRoomOnlineUsers",
        "Version": "2023-08-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
       "RoomExist": true,
       "TotalUser": 6,
       "TotalInvisibleUser": 3,
       "VisibleUserList": {
           "normal_user_1",
           "normal_user_2",
           "normal_user_3"
       },
       "InvisibleUserList": {
           "silent_user_1",
           "silent_user_2",
           "silent_user_3"
       }
    }
}
json