文档中心

WebRTC 传输网络

管理 WTN 流

BanWTNStream 封禁 WTN 流

调用 BanWTNStream 接口，封禁一个指定的 WTN 流。封禁生效后，已存在的推流会被中断。

注意事项

请求频率：单 AppId 下，QPS 不得超过 20。

请求说明

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	BanWTNStream	接口名称。当前 API 的名称为 BanWTNStream。
Version	String	是	2023-11-01	接口版本。当前 API 的版本为 2023-11-01。

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	661****543cf	应用 ID。在 WTN 控制台上获取。
StreamId	String	是	stream1	要封禁的 WTN 流 ID。
BusinessId	String	否	chatroom	业务 ID，用于区分不同业务。在 WTN 控制台创建并获取。
ForbiddenInterval	Integer	否	60	封禁时长，单位为秒，取值范围为 [10, 604800]。若设为 0 或为空：流会中断，但可立即重新推送该流。若传入值大于 0 且小于 10，自动修改为 10。若传入值大于 604800，自动修改为 604800。

返回参数

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

参数	类型	示例值	描述
Message	String	success	仅在请求成功时返回 success ；失败时为空，具体失败原因请查看公共参数 ResponseMetadata.Error。

请求示例

返回示例

错误码

状态码	错误码	错误信息	说明
400	UnknownAction	The specified action is not valid	请求的 Action 名称不存在或拼写有误，请核对接口文档中的 Action 值。
400	UnknownVersion	The specified version is not valid	请求的 Version 不存在或不受支持，请核对接口文档中的 Version 值。
400	MissingParameter.NoAppId	The required parameter AppId is missing	必填参数 AppId 缺失，请在请求 Body 中补充 AppId。
400	MissingParameter	The required parameter is missing	必填参数缺失（如 StreamId），请检查请求 Body 中是否包含全部必填参数。
429	QPSOverLimit	The request QPS exceeds the limit	请求 QPS 超过 TOP 网关账号维度 20 QPS 的限流阈值，请降低调用频率后重试。
500	InternalError	An internal error occurred	服务内部错误导致执行失败，请稍后重试；如持续出现请携带 RequestId 联系技术支持。

最近更新时间：2026.07.27 16:54:34

这个页面对您有帮助吗？

有用

无用