进行音视频通话时，你可能会需要封禁房间内某个用户的音/视频流，比如主播/房主/管理员禁止指定房间中的指定用户发布音/视频流。你可以使用 BanUserStream 这个 OpenAPI 实现这一功能。

接口行为

你可以调用 BanUserStream 接口，指定你所属的 AppId，封禁指定 roomId 房间中指定 userId 的用户音/视频流发布。

房间内指定用户被禁止视频流发送时，房间内所有用户都会收到 onVideoStreamBanned 回调。
房间内指定用户被禁止音频流发送时，房间内所有用户都会收到 onAudioStreamBanned 回调。
调用该接口封禁用户音视频流后，依然会产生计费。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。

接口限制

QPS 不得超过 60。

请求方式

使用 Post 方式发起请求。

请求参数

以下是接口特有的请求参数。关于其他公共请求参数，参看请求参数。

Query

参数名	类型	必填	示例值	描述
Action	String	是	`BanUserStream`	接口名称
Version	String	是	`2020-12-01`	OpenAPI 版本

Body

参数名	类型	必填	示例值	描述
AppId	String	是	`Your_AppId`	你的音视频应用的唯一标志
RoomId	String	是	`Your_RoomId`	房间的 ID，是房间的唯一标志
UserId	String	是	`Your_UserId`	你希望封禁音/视频流的用户的 ID
Token	String	是	`Your_Token`	用于校验当前账号是否具有封禁权限的 Token，生成方式与加入房间时的 Token 生成方式一致
Video	Bool	否	`true`	是否封禁视频流，置为 true 时，表示封禁视频流
Audio	Bool	否	`true`	是否封禁音频流，置为 true 时，表示封禁音频流

请求示例代码

Query

https://rtc.volcengineapi.com?Action=BanUserStream&Version=2020-12-01
postscript

Body

{
    "AppId": "Your_appid",
    "RoomId": "Your_roomid",
    "UserId": "Your_userid",
    "Token": "Your_token",
    "Video": true,
    "Audio": false
}
json

返回调用结果

返回值 Result 仅在请求成功时返回消息 "success", 失败时为空。

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "",
        "Action": "BanUserStream",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "message": "success"
    }
}
json