房间音视频流封禁规则

---

1 描述

当开发者需要从业务后台直接管理用户在某些房间的发言权限时，可以通过 ZEGO 服务端的 房间音视频流封禁规则 接口，指定该用户在对应房间的某条流 ID 的权限，直接封禁对应的音频或视频，实现直播间主播直接将房间内的某些违规用户闭麦等操作。

开发者还可以查询已存在的封禁规则、删除过期或不适用的封禁规则，更好地维护业务秩序，保护用户权益，提升产品体验。

2 接口原型

3 使用步骤

下文详细介绍 音视频流封禁规则 接口的请求参数配置、响应参数说明。

3.1 设置音视频流封禁规则

当开发者需要封禁某条流的音频或视频时，需要先通过 SetForbidStreamRule 设置对应的音视频流封禁规则。

3.1.1 请求参数及请求示例

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考 调用方式 中的 “2.1 公共请求参数”。

https://rtc-api.zego.im/?Action=SetForbidStreamRule
&RoomId=room1
&StreamId=streamId1
&DisableAudio=1
&DisableVideo=1
&EffectiveTime=3600
&<公共请求参数>

3.1.2 响应参数及响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "TestRequestId167562222222915000"
}

3.2 查询音视频流封禁规则

设置规则成功后，通过 DescribeForbidStreamRules 了解当前已存在的音视频流封禁规则。

3.2.1 请求参数及请求示例

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考 调用方式 中的 “2.1 公共请求参数”。

https://rtc-api.zego.im/?Action=DescribeForbidStreamRules
&RoomId=room1
&StreamId[]=streamId1
&StreamId[]=streamId2
&<公共请求参数>

3.2.2 响应参数及响应示例

{
    "Code": 0,
    "Data": {
        "RoomId": "room1",
        "ForbidStreamRuleList": [
            {
                "StreamId": "streamId1",
                "DisableAudio": 1,
                "DisableVideo": 1,
                "CreateTime": 1343313411,
                "EffectiveTime": 3600
            }，
            {
                "StreamId": "streamId2",
                "DisableAudio": 0,
                "DisableVideo": 0,
                "CreateTime": 0,
                "EffectiveTime": 0
            }
        ]
    },
    "Message": "success",
    "RequestId": "TestRequestId1710224543000"
}

3.3 删除音视频流封禁规则

当某些音视频流封禁规则失效或无用时，可以通过 DelForbidStreamRule 删除音视频流封禁规则。

3.3.1 请求参数及请求示例

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考 调用方式 中的 “2.1 公共请求参数”。

https://rtc-api.zego.im/?Action=DelForbidStreamRule
&RoomId=roomm1
&StreamId=stream1
&<公共请求参数>

3.3.2 响应参数及响应示例

{
    "Code":0,
    "Message":"success",
    "RequestId":"4443515903622222208307334"
}

4 返回码

以下仅列出了常见的接口业务逻辑相关的返回码，完整返回码请参考 全局返回码。