SetForbidUserRule
GET
https://rtc-api.zego.im/
设置用户封禁规则以封禁某些用户。设置成功后，您可以 查询用户封禁规则 或 删除用户封禁规则。
设置用户封禁规则不会中断用户当前正在进行的推流，仅会对用户的下一次推流请求生效。若需立即封禁用户当前正在进行的推流，需单独使用设置音视频流封禁规则，而非用户封禁规则。
调用频率限制
同一个 AppID 下所有房间：10 次/秒。
-
假设需要封禁的用户是 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 内推流。
Request
Query Parameters
- 1：通过 IP 地址封禁用户，最多可设置 100 条；
- 2：通过 RoomId 封禁用户，最多可设置 200 条；
- 3：通过 UserId 封禁用户，最多可设置 200 条；
- 4：通过 RoomId 和 UserId 封禁用户，最多可设置 200 条。
Action string必填
可选值: [SetForbidUserRule]
接口原型参数
https://rtc-api.zego.im?Action=SetForbidUserRule
AppId uint32必填
💡公共参数。AppId，ZEGO 分配的用户唯一凭证。
SignatureNonce string必填
💡公共参数。随机字符串。
Timestamp int64必填
💡公共参数。Unix 时间戳，单位为秒。最多允许 10 分钟的误差。
Signature string必填
💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。
SignatureVersion string必填
可选值: [2.0]
默认值: 2.0
💡公共参数。签名版本号。
RuleType int32必填
可选值: [1, 2, 3, 4]
封禁规则类型：
其中，最多可设置的规则条数，指同时在有效期内的规则条数，不包含已失效的规则。
如果您不需要某些规则，请及时调用 删除用户封禁规则 接口进行清理。
IP string
IP 地址。RuleType 为 1 时必填。
RoomId string
房间 ID。RuleType 为 2、4 时必填。
UserId string
用户 ID。RuleType 为 3、4 时必填。
DisabledPrivilege int32[]必填
可选值: [1, 2], >= 1
封禁用户所能使用的功能。1：登录。2：推流。
EffectiveTime int64必填
可选值: >= 1 and <= 86400
封禁规则有效时长，单位：秒，取值范围 1 ～ 86400（1 天）。
Responses
- 200
操作成功
- application/json
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
RESPONSE清除
点击上方 “发送” 按钮，在此处查看响应。