当你需要解封房间内某个用户的音/视频流时,比如主播/房主/管理员解除指定房间中的被封禁的用户发布音/视频流的限制,使其恢复正常的音/视频流发布,你可以使用 UnbanUserStream 这个 OpenAPI 实现这一功能。
你可以调用 UnbanUserStream 接口,指定你所属的 AppId,解封指定 roomId 房间中被封禁的 userId 的用户音/视频流发布。
onVideoStreamBanned 回调。onAudioStreamBanned 回调。关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。
QPS 不得超过 20
使用 Post 方式发起请求。
以下是接口特有的请求参数。关于其他公共请求参数,参看请求参数。
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | UnbanUserStream | 接口名称 |
| Version | String | 是 | 2020-12-01 | OpenAPI 版本 |
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| 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 时,表示解封音频流 |
https://rtc.volcengineapi.com?Action=UnbanUserStream&Version=2020-12-01
postscript{
"AppId": "Your_appid",
"RoomId": "Your_roomid",
"UserId": "Your_userid",
"Token": "Your_token",
"Video": true,
"Audio": true
}
json返回值 Result 仅在请求成功时返回消息 "success", 失败时为空。
{
"ResponseMetadata": {
"RequestId": "",
"Action": "UnbanUserStream",
"Version": "2020-12-01",
"Service": "rtc",
"Region": "cn-north-1"
},
"Result": {
"message": "success"
}
}
json