You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

获取实时用户列表 GetRoomOnlineUsers

最近更新时间：2024.04.11 11:50:52

首次发布时间：2024.01.03 20:25:19

我的收藏

你可以使用此接口获取指定房间内的实时用户列表。

使用说明

接口行为

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

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构，参看调用方法。

注意事项

请求频率：QPS 不得超过 40。

请求说明

  • 请求方式：GET
  • 请求地址：https://rtc.volcengineapi.com?Action=GetRoomOnlineUsers&Version=2023-11-01

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

Query

参数名称
数据类型
是否必选
示例值
描述
Action
String
是
GetRoomOnlineUsers
接口名称。当前 API 的名称为 GetRoomOnlineUsers。
Version
String
是
2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
AppId
String
是
Your_AppId
你的音视频应用的唯一标志
RoomId
String
是
Your_RoomId
指定房间 ID

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

参数
类型
示例值
描述
RoomExist
Boolean
true

查询的房间是否存在。

  • true：存在。
  • false：不存在。
当 RoomExist 的值为 false 时，不会返回其他字段。
TotalUser
Integer
6
查询到的用户总数
TotalInvisibleUser
Integer
3
查询到的不可见用户总数。不可见用户最多返回 10000 名。
VisibleUserList
String[]
["normal_user_1"]
可见用户列表
InvisibleUserList
String[]
["silent_user_1"]
不可见用户列表

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "GetRoomOnlineUsers",
        "Version": "2023-11-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"
       ]
    }
}

错误码

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