查询房间人员与资源
查询音视频房间信息。包括:
- 音视频房间房间 ID、会话 ID(
sessionId
)与房间创建时间。 - 音视频房间成员列表。
- 房间成员发布的音视频流资源信息。
- 直播房间观众人数与用户 ID。
请求方法
POST: http(s)://api.rong-api.com/rtc/room/query.json
签名规则: 所有请求融云服务端 API 接口的请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文中包含具有以下结构的 JSON 对象:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
roomId | String | 必传 | 要查询的音视频房间 ID |
请求示例
POST /rtc/room/query.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Timestamp: 1585127132438
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Room-Id: room1
Content-Type: application/json
{
"roomId":"room1"
}
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | HTTP 响应正文中的业务码,200 为处理成功。另见状态码。 |
roomId | String | 当前音视频的房间 Id |
sessionId | String | 当前音视频的会话 Id。 会话 ID 也可以通过融云服务端回调获取,详见房间状态同步。 |
createTime | Number | 当前音视频房间的创建时间戳,从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数 |
members | Array | 用户及资源信息。注意:如果房间为直播模式的音视频房间,members 对象中仅包含主播的信息。 |
members[i].userId | String | 用户 ID |
members[i].joinTime | Number | 对应用户加入房间的时间戳,从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数 |
members[i].data | Object | 用户发布的资源信息 |
members[i].data.uris | Array | 用户资源信息列表,详情见下面说明。 |
members[i].data.uris[i].mediaType | Number | 音视频资源的类型。0 : 音频;1 : 视频。 |
members[i].data.uris[i].msid | String | 音视频资源的流 ID(Stream ID)。 |
members[i].data.uris[i].uri | String | 音视频资源的全网唯一 URI。您不需要关心其字符串构成 |
members[i].data.uris[i].tag | String | 客户端在发布资源时指定的标签信息,用于标识不同的流。默认的音视频 Tag 为 RongCloudRTC 。 |
members[i].data.uris[i].state | Number | 音视频资源的状态。0 : 关闭;1 : 开启。 |
total | Number | 直播模式的音视频房间中观众的总数。该字段仅在房间为直播模式时有效。 |
views | Array | 直播模式的音视频房间中观众的用户 ID 列表。该字段仅在房间为直播模式时有效。 |
返回结果示例
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"code":200,
"roomId":"444",
"sessionId":"cRZTAOjBsS8gUZLrTTIO_A",
"createTime":1585043771361,
"members":[
{
"userId":"13811223344_h0fc_web",
"joinTime":1585043771362,
"data":{
"uris":[
{
"mediaType":0,
"msid":"13811223344_h0fc_web_RongCloudRTC",
"uri":"{\"clusterId\":\"rtc-data-dev-rtc40-15-bdcbj.rongcloud.net\",\"serverId\":\"172.24.151.15:9005\",\"resourceId\":\"13811223344_h0fc_web_RongCloudRTC_0\",\"connectionId\":\"AAY2NjM0NjMAFDEzODExMjIzMzQ0X2gwZmNfd2ViAAM0NDQA\",\"ssrc\":2750434140,\"serviceProvider\":\"awsnx\",\"userTimestamp\":1585043802893}",
"tag":"RongCloudRTC",
"state":1
},
{
"mediaType":1,
"msid":"13811223344_h0fc_web_RongCloudRTC",
"uri":"{\"clusterId\":\"rtc-data-dev-rtc40-15-bdcbj.rongcloud.net\",\"serverId\":\"172.24.151.15:9005\",\"resourceId\":\"13811223344_h0fc_web_RongCloudRTC_1\",\"connectionId\":\"AAY2NjM0NjMAFDEzODExMjIzMzQ0X2gwZmNfd2ViAAM0NDQA\",\"ssrc\":1782111418,\"serviceProvider\":\"awsnx\",\"userTimestamp\":1585043802893}",
"tag":"RongCloudRTC",
"state":1
}
]
}
}
]
}