You need to enable JavaScript to run this app.
导航

解封音视频流 UnbanUserStream

最近更新时间2024.01.12 16:39:43

首次发布时间2022.01.17 11:43:53

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

使用说明

接口行为

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

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

调用接口

关于调用接口的请求结构、公共参数、签名算法和返回结构,参看调用方法

注意事项

请求频率:QPS 不得超过 60

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
AppIdStringYour_AppId你的音视频应用的唯一标志
RoomIdStringYour_RoomId房间的 ID,是房间的唯一标志
UserIdStringYour_UserId需要被解封音/视频流的用户的 ID
TokenStringYour_Token用于校验当前账号是否具有解封权限的 Token,生成方式与加入房间时的Token生成方式一致
VideoBooleantrue是否解封视频流,置为 true 时,表示解封视频流
AudioBooleantrue是否解封音频流,置为 true 时,表示解封音频流

返回参数

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

参数类型示例值描述
messageStringsuccess

请求示例

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
}

返回示例

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

错误码

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