文档中心

实时音视频

请输入

房间管理

封禁音视频流 BanUserStream

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

调用 BanUserStream 接口，禁止指定用户在房间内发布音频或视频流，并支持设置封禁时长，或封禁至主动解封。调用后，房间内其他用户会收到相应通知。

使用说明

接口行为

房间内指定用户被禁止视频流发送时，房间内所有用户都会收到 onVideoStreamBanned 回调。

房间内指定用户被禁止音频流发送时，房间内所有用户都会收到 onAudioStreamBanned 回调。

调用该接口封禁用户音视频流后，依然会产生计费。

注意事项

请求频率：QPS 不得超过 60。

请求说明

请求方式：POST

请求地址：https://rtc.volcengineapi.com?Action=BanUserStream&Version=2023-11-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

Action String 必选示例值：BanUserStream

接口名称。当前 API 的名称为 BanUserStream。

Version String 必选示例值：2023-11-01

接口版本。当前 API 的版本为 2023-11-01。

Body

AppId String 必选示例值：66****3cf

实时音视频应用的 AppId。可在控制台获取。

RoomId String 必选示例值：Room1

业务标识，用于区分不同业务。可在控制台获取。

UserId String 必选示例值：User1

需封禁流的目标用户 ID。

Video Boolean 可选示例值：true

是否封禁视频流。

true：封禁。

false：不封禁。

默认值为 false。

Audio Boolean 可选示例值：true

是否封禁音频流。

true：封禁。

false：不封禁。

默认值为 false。

ForbiddenInterval Long 可选示例值：0

封禁时长，取值范围为 {0,[60,259200]}，单位为秒。

若设为 0 或空：则永久封禁直至主动调用unbanroomuser 接口解封。

若传入值大于 0 且小于10：自动修改为10。

若传入值大于259200，自动修改为259200。

返回参数

下表仅列出本接口特有的返回参数，公共返回参数请参见返回结构。

Message String 示例值：success

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

请求示例

返回示例

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2026.03.13 10:26:43

这个页面对您有帮助吗？

有用

无用