You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /
  • 实时音视频

封禁音视频流 BanUserStream

最近更新时间：2024.04.11 11:50:52

首次发布时间：2024.01.03 20:25:19

我的收藏

进行音视频通话时，你可能会需要封禁房间内某个用户的音/视频流，比如主播/房主/管理员禁止指定房间中的指定用户发布音/视频流。你可以使用 BanUserStream 这个 OpenAPI 实现这一功能。

使用说明

接口行为

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

  • 房间内指定用户被禁止视频流发送时，房间内所有用户都会收到 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
是
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=BanUserStream&Version=2023-11-01
{
  "AppId": "Your_AppId",
  "RoomId": "Your_RoomId",
  "UserId": "Your_UserId",
  "Token": "Your_Token",
  "Video": true,
  "Audio": false
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "BanUserStream",
        "Version": "2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "Message": "success"
    }
}

错误码

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