封禁音视频流 BanUserStream--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

封禁音视频流 BanUserStream

最近更新时间：2024.09.30 10:47:49首次发布时间：2024.01.03 20:25:19

本文档 API 接口为最新版本接口，后续相关功能的新增都会在此更新，推荐使用最新版本接口。旧版接口文档请参考历史版本。

在实时音视频通话场景中，若需对特定用户进行音视频流封禁，你可通过调用此接口实现。

通过指定应用标识、房间 ID、用户 ID 及权限验证 Token，你可选择禁止指定用户的视频或音频流发布权限。此操作后，房间内所有用户将收到相应的回调通知。调用此接口后，接口将返回操作结果，确认封禁操作是否成功。

使用说明

接口行为

房间内指定用户被禁止视频流发送时，房间内所有用户都会收到 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	是	`661e****543cf`	你的音视频应用的唯一标志，参看获取 AppId。
RoomId	String	是	`Room1`	房间的 ID，是房间的唯一标志
UserId	String	是	`User1`	你需要封禁音/视频流的用户的 ID
Video	Boolean	否	`true`	是否解封视频流。 `true`：解封视频流。 `false`：封禁视频流。默认值为 `true`。
Audio	Boolean	否	`true`	是否解封音频流。 `true`：解封音频流。 `false`：封禁音频流。默认值为 `true`。
ForbiddenInterval	Long	否	`0`	封禁时长，取值范围为`{0,[60,259200]}`，单位为秒。若传入值为空或 `0` 表示封禁音视频流至主动调用`unbanroomuser` 接口解封。若传入值大于 `0`，且小于`10`，自动修改为`10`。若传入值大于`259200`，自动修改为`259200`。

返回参数

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

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

请求示例

POST https://rtc.volcengineapi.com?Action=BanUserStream&Version=2023-11-01
{
  "AppId": "661e****543cf",
  "RoomId": "Room1",
  "UserId": "user1",
  "Token": "001661e****543cf80",
  "Video": true,
  "Audio": false
}

返回示例

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

错误码

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