当你需要解封房间内某个用户的音/视频流时，比如主播/房主/管理员解除指定房间中的被封禁的用户发布音/视频流的限制，使其恢复正常的音/视频流发布，你可以使用 UnbanUserStream 这个 OpenAPI 实现这一功能。

使用说明

接口行为

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

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

调用接口

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

注意事项

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

请求说明

请求方式：POST
请求地址：https://rtc.volcengineapi.com?Action=UnbanUserStream&Version=2020-12-01

请求参数

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

Query

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

Body

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

返回参数

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

参数	类型	示例值	描述
message	String	`success`	仅在请求成功时返回消息 "success", 失败时为空。

请求示例

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

{
    "AppId": "Your_AppId",
    "RoomId": "Your_RoomId",
    "UserId": "Your_UserId",
    "Token": "Your_Token",
    "Video": true,
    "Audio": true
}
json

返回示例

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

错误码

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