房间管理

编辑文档更新于 2025-01-16 07:59:52

描述

调用本接口获取房间内用户列表

接口请求地址

请求方式：GET/JSON
传输协议：HTTPS
调用频次限制：10 次/秒(同一个 AppId 下的所有房间)、5 次/秒(同一个 Room 下)
请求 URL：

https://brtc-api.baijiayun.com/vrs/rtc/room/user/list

API鉴权

参见 Restful API 基本认证

请求参数

参数	类型	是否必选	描述
app_id	string	是	BRTC 给开发者分配的 appId，唯一标识一个应用
room_id	string	是	房间 id
mode	int	否	用户登录房间的时间顺序 0(默认值): 正序 1: 倒序
page	int	否	页数, 用户数量过多时, 可以分多页来获取, 每页取 page_size 条, 默认值为 1
page_size	int	否	每页获取的条数, 最大值不能超过 200, 默认值 100

请求示例

请求包体内容：

https://brtc-api.baijiayun.com/vrs/rtc/room/user/list
?app_id=LIeyehe7XXaYGoAB5ZJJ9Bd2EdkpbXUY
&room_id=123
&mode=1
&page=1
&page_size=50

响应参数

参数	类型	描述
code	int	错误码
data	json	响应对象
msg	string	描述

响应示例

响应包体内容：

{
  "code": 200,
  "msg": "success",
  "data": {
    "totals": 1,
    "users": [
      {
        "user_id": "11110",
        "join_time": 1653623085
      }
    ]
  }
}