查询房间媒体流状态
更新时间: 2024/03/25 11:00:44
查询房间中各用户的媒体流状态,包括是否已静音等信息。例如,通过将获取到的媒体流状态与业务侧用户麦位状态进行对比,可以找出不应该推流的用户。该接口适用于“防漏麦”和“防炸麦”场景。
URL
-
请求方法:GET
-
URL:
GET https://logic-dev.netease.im/v2/api/rooms/{cid}/streams GET https://logic-dev.netease.im/v3/api/rooms/streams?cname={cname}
接口请求频率
默认上限为 5 次/秒,若请求频率超出限制,可能会返回 429 错误码。
若您需要上调上限,请参考如何处理调用服务端 RESTful API 超出频率限制。
路径参数
参数名称 | 类型 | 是否必选 | 示例 | 描述 |
---|---|---|---|---|
cid | Number | v2必选 | 6207760637435905 | 房间 ID。该 ID 为 创建房间 接口调用成功后返回的房间 ID。 仅在调用 V2 接口时需要设置。 |
cname | String | v3必选 | abc | 房间名称。仅在调用 V3 接口时需要设置。 |
请求参数
-
请求中 Header 的设置请参考请求结构描述。
-
该 API 的 Body 中无需指定任何请求参数。
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Number | 业务错误码,200表示请求成功。 |
errmsg | String | 错误信息。 |
requestId | String | 请求ID。 若使用过程中遇到问题,请提供该 ID ,以便技术支持进行排查。 |
+ streamStatusInfo | Object | 媒体流信息。 |
示例
请求示例
GET https://logic-dev.netease.im/v2/api/rooms/6207760637435905/streams
正常返回示例
json{
"code": 200,
"requestId": "510b678906104b058e08ec6a2becc09f",
"streamStatusInfo": [
{
"uid": 9269,
"mediaType": "audio",
"subStream": false,
"mute": false
},
{
"uid": 9269,
"mediaType": "video",
"subStream": false,
"mute": false
}
]
}
错误码
状态码 | 说明 |
---|---|
200 | API 调用成功。 |
400 | 请求参数错误,可能原因是:cid非法。 |
401 | 接口鉴权失败。请检查请求 header 中的 CheckSum 字段是否正确。 |
404 | cid 对应的房间不存在。 |
429 | 请求个数超过频控限制。 |
500 | 调用失败,可能原因是房间已关闭。 |
此文档是否对你有帮助?