获取实时用户列表 GetRoomOnlineUsers--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

获取实时用户列表 GetRoomOnlineUsers

最近更新时间：2024.07.16 15:31:22首次发布时间：2024.01.03 20:25:19

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

在实时音视频通话场景中，若需要获取指定房间内的实时用户列表，你可以通过调用此接口实现。

通过指定应用标识和房间 ID，你可以查询到该房间中存在的用户总数以及不可见用户总数。此外，接口还返回可见用户和不可见用户的具体列表，以及房间是否存在的状态信息。

注意事项

请求频率：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	是	`661e****543cf`	你的音视频应用的唯一标志
RoomId	String	是	`Your_RoomId`	指定房间 ID

返回参数

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

参数	类型	示例值	描述
TotalUser	Integer	`6`	查询到的用户总数
TotalInvisibleUser	Integer	`3`	查询到的不可见用户总数。不可见用户最多返回 10000 名。
VisibleUserList	String[]	`["normal_user_1"]`	可见用户列表
InvisibleUserList	String[]	`["silent_user_1"]`	不可见用户列表
RoomExists	Boolean	`true`	查询的房间是否存在。 true：存在。 false：不存在。当 `RoomExists` 的值为 `false` 时，不会返回其他字段。

请求示例

GET https://rtc.volcengineapi.com?Action=GetRoomOnlineUsers&Version=2023-11-01&AppId=661e****543cf&RoomId=Room1

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetRoomOnlineUsers",
        "Version": "2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "TotalUser": 6,
        "TotalInvisibleUser": 3,
        "VisibleUserList": [
            "normal_user_1"
        ],
        "InvisibleUserList": [
            "silent_user_1"
        ],
        "RoomExists": true
    }
}

错误码

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