You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /实时音视频/服务端 API 参考/房间管理/查询用户状态 GetRoomUsersProperty
查询用户状态 GetRoomUsersProperty
最近更新时间：2025.07.03 18:15:27首次发布时间：2025.06.06 10:44:43
我的收藏
有用
有用
无用
无用

根据房间 ID 和用户 ID 列表，查询房间内单个或多个用户的状态，包括用户是否在房间中、加入房间的时间和是否为可见用户等。

注意事项

请求频率：单账号 QPS 不得超过 10。

请求说明

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

调试

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

请求参数

Query

参数
类型
是否必选
示例值
描述
Action
String
是
GetRoomUsersProperty
接口名称。当前 API 的名称为 GetRoomUsersProperty。
Version
String
是
2023-11-01
接口版本。当前 API 的版本为 2023-11-01。
AppId
String
是
661e****543cf
音视频应用的 ID。如何获取 AppId？
RoomId
String
是
Room1
房间的 ID，是房间的唯一标志。赋值规则参看参数赋值规范
UserIds
[]
是
UserIds=user1&UserIds=user2
要查询的用户 ID，最多同时支持指定 10 个用户 ID。

返回参数

参数
类型
示例值
描述
UserList
Object[]
用户状态信息。
Status
Integer
1

查询的用户是否在房间：

  • 0：不在房间。
  • 1：在房间。

注意

当 Status 为 0 时，除 UserID 外，不会返回其他字段。

UserID
String
user1
用户 ID。
Role
Integer
1

用户类型：

  • 1：可见用户
  • 2：不可见用户
  • 0：未知
LoginTime
Integer
1790222321331
用户加入房间的 Unix 时间戳，单位为毫秒。
DeviceType
String
android

用户终端设备类型：

  • android
  • ios
  • mac
  • windows
  • linux
  • harmony
  • web
PlatformType
Integer
1

SDK 类型：

  • 1：Native
  • 2：Web
  • 4：抖音小程序

注意

仅当 SDK 客户端为 Native 端，且为以下版本时才返回该字段：

  • Native 端 3.60.x：3.60.8.1750 及以上版本。
  • Native 端 3.61.x：3.61.5 及以上版本。
  • Native 端 3.63.0 及以上版本。
MediaProcessingType
Integer
21

后端处理业务类型。

注意

仅当用户为后端处理机器人时，才返回该字段。

取值如下：

  • 11：本地服务端录制

  • 21：单流云端录制

  • 22：合流云端录制

  • 23：合流转推

  • 24：单流转推

  • 25：在线媒体流

  • 27：云录屏

  • 28：视频抽帧

  • 29：音频切片

  • 31：转推 WTN

  • 32：语音识别和翻译服务

  • 34：AIGC Gateway

  • 35：AIGC ToB 一站式

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetRoomUsersProperty",
        "Version": "2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "UserList": [
            {
                "Status": 1,
                "Role": 1,
                "UserID": "user1",
                "LoginTime": 1790222321331,
                "DeviceType": "android",
                "PlatformType": 1,
                "MediaProcessingType": 21
            },
            {
                "Status": 1,
                "Role": 1,
                "UserID": "user2",
                "LoginTime": 1790222321367,
                "DeviceType": "ios",
                "PlatformType": 1,
                "MediaProcessingType": 22
            }
        ]
    }
}

错误码

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

状态码错误码错误信息说明
400MissingParameter.NoAppIdAppId is empty.请求缺失AppId
400MissingParameter.NoRoomIdRoomId is empty.请求参数缺失roomId
400MissingParameter.NoUserIDsUserIDs is empty.请求参数缺失UserIds列表
500InternalErrorInternal request fails.服务端错误