You need to enable JavaScript to run this app.
导航

获取实时用户列表 GetRoomOnlineUsers

最近更新时间2024.01.12 17:07:37

首次发布时间2023.09.21 10:30:51

使用说明

接口行为

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

调用接口

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

注意事项

请求频率:QPS 不得超过 40

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringGetRoomOnlineUsers接口名称。当前 API 的名称为 GetRoomOnlineUsers
VersionString2023-08-01接口版本。当前 API 的版本为 2023-08-01
AppIdStringYour_AppId你的音视频应用的唯一标志
RoomIdStringYour_RoomId指定房间 ID

返回参数

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

参数类型示例值描述

RoomExist

Boolean

true

查询的房间是否存在。

  • true:存在。
  • false:不存在。
    RoomExist 的值为 false 时,不会返回其他字段。
TotalUserInteger6查询到的用户总数
TotalInvisibleUserInteger3查询到的不可见用户总数。不可见用户最多返回 10000 名。
VisibleUserListArray of String["normal_user_1"]可见用户列表
InvisibleUserListArray of String["silent_user_1"]不可见用户列表

请求示例

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

返回示例

{
    "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"
       ]
    }
}

错误码

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