用户封禁规则

---

1 描述

ZEGO 服务端提供了一套 用户封禁规则 接口，当开发者需要从业务后台直接管理用户的登录、推流等权限时，可以通过设置相关的封禁规则（例如通过用户的 IP 地址、UserId 等信息），直接封禁对应的用户，从而实现违规用户不能登录某些房间、或登录房间后不能开麦等功能。

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

2 接口原型

3 使用步骤

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

3.1 设置用户封禁规则

当开发者需要封禁某些用户时，需要先通过 SetForbidUserRule 设置对应的用户封禁规则。

3.1.1 请求参数及请求示例

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

参数配置举例：

• 假设需要封禁的用户是 user1，未登录房间 room1：

  • RuleType 取值为 1、DisabledPrivilege[] 取值为 1 时，表示该 IP 地址对应的用户无法登录任何房间。
  • RuleType 取值为 2、DisabledPrivilege[] 取值为 1 时，表示任何用户都无法登录 room1。
  • RuleType 取值为 3、DisabledPrivilege[] 取值为 2 时，表示 user1 可以正常登录到任何房间，但无法在任何房间内推流。
  • RuleType 取值为 4、DisabledPrivilege[] 取值为 2 时，表示 user1 可以正常登录到 room1，但无法在 room1 内推流。

• 假设需要封禁的用户是 user1，且已登录房间 room1，无论 RuleType 取值如何：

  • DisabledPrivilege[] 取值为 1 或 1&2 时，user1 仍在 room1 内、但无法正常推流，需要调用 踢出房间用户 接口踢出用户。
  • DisabledPrivilege[] 取值为 2 时，user1 无法在 room1 内推流。

https://rtc-api.zego.im/?Action=SetForbidUserRule
&RuleType=2
&RoomId=room1
&DisabledPrivilege[]=1&DisabledPrivilege[]=2
&EffectiveTime=1800
&<公共请求参数>

3.1.2 响应参数及响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "TestRequestId1675674022729915000",
    "Data": {
        "ExpireTime": 1704282648
    }
}

3.2 查询用户封禁规则

设置规则成功后，通过 DescribeForbidUserRules 了解当前已存在的用户封禁规则。

3.2.1 请求参数及请求示例

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

https://rtc-api.zego.im/?Action=DescribeForbidUserRules
&RuleType=2
&<公共请求参数>

3.2.2 响应参数及响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "TestRequestId1675674022729915000",
    "Data": {
        "RuleList": [
            {
                "RuleType": 2,
                "IP": "",
                "RoomId": "room1",
                "UserId": "",
                "DisabledPrivilegeList": [
                    1,
                    2
                ],
                "ExpireTime": 1704282648
            },
            {
                "RuleType": 2,
                "IP": "",
                "RoomId": "room2",
                "UserId": "",
                "DisabledPrivilegeList": [
                    1
                ],
                "ExpireTime": 1704282648
            }
        ]
    }
}

3.3 删除用户封禁规则

当某些用户封禁规则失效、无用或规则总条数超过上限时，可以通过 DelForbidUserRule 删除用户封禁规则。

3.3.1 请求参数及请求示例

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

https://rtc-api.zego.im/?Action=DelForbidUserRule
&RuleType=2
&RoomId=room1
&<公共请求参数>

3.3.2 响应参数及响应示例

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

4 返回码

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