查询房间中用户列表
更新时间：2024-06-05
接口描述
用户根据appId和roomName查询当前房间中用户列表。
请求（Request）
请求URI
GET /v1/room/users?appId={appId}&roomName={roomName} HTTP/1.1| 参数名 | 类型 | 是否必需 | 描述 |
|---|---|---|---|
| appId | String | 是 | 应用ID |
| roomName | String | 是 | 房间名称 |
请求头域
除公共头域外，无其它特殊头域。
请求体
无
响应（Response）
响应头域
除公共头域外，无其它特殊头域。
响应体
| 参数名 | 类型 | 描述 |
|---|---|---|
| appId | String | 应用ID |
| roomName | String | 房间名 |
| roomId | Long | 房间ID |
| startTime | Long | 会话开始时间，为毫秒级别 Unix 时间戳 |
| users | List | user 列表 |
| +clientUserId | Long | 客户端用户ID |
| +display | String | 客户端用户名（publisher身份） |
| +isPublishing | Boolean | 客户端用户是否正在推流 |
示例
请求示例
GET /v1/room/users?appId=testapp&roomName=6543211234 HTTP/1.1
host: rtc.baidubce.com
content-type: application/json
authorization: {bce-authorization-string}
x-bce-request-id: {bce-request-id}响应示例
HTTP/1.1 200 OK
x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
date: Mon, 05 Sep 2022 03:25:43 GMT
transfer-encoding: chunked
content-type: application/json;charset=UTF-8
cache-control: no-cache
{
"appId": "testapp",
"roomName": "6543211234",
"roomId": 883809059995648,
"startTime": 1663818337808,
"users": [
{
"clientUserId": 8891,
"publishing": false
},
{
"clientUserId": 69009,
"display": "Z9zY3sfaTcph",
"publishing": false
},
{
"clientUserId": 42276,
"display": "3WeTiZKThp5H",
"publishing": true
}
]
}