DelForbidUserRule
GET
https://rtc-api.zego.im/
删除用户封禁规则。当某些用户封禁规则失效、无用或规则总条数超过上限时,可以通过该接口删除用户封禁规则。
删除后,您可以通过 查询用户封禁规则 查看对应的用户封禁规则是否删除成功。
调用频率限制
同一个 AppID 下所有房间:10 次/秒。
注意
每个 RuleType 所支持设置的最大条数限制不同,如果您不需要某些规则,请及时调用本接口进行清理。此外,ZEGO 也会不定期清理数据库中的已失效的封禁规则。
Request
Query Parameters
- 1:通过 IP 地址封禁用户;
- 2:通过 RoomId 封禁用户;
- 3:通过 UserId 封禁用户;
- 4:通过 RoomId 和 UserId 封禁用户。
Action stringrequired
Possible values: [DelForbidUserRule
]
接口原型参数
https://rtc-api.zego.im?Action=DelForbidUserRule
AppId uint32required
💡公共参数。AppId,ZEGO 分配的用户唯一凭证。
SignatureNonce stringrequired
💡公共参数。随机字符串。
Timestamp int64required
💡公共参数。Unix 时间戳,单位为秒。最多允许 10 分钟的误差。
Signature stringrequired
💡公共参数。签名,用于验证请求的合法性。
SignatureVersion stringrequired
Possible values: [2.0
]
Default value: 2.0
💡公共参数。签名版本号。
IsTest string
Possible values: [true
, false
]
Default value: false
💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境,可根据业务需求设置此参数;而之后创建的项目默认是正式环境。
RuleType int32required
Possible values: [1
, 2
, 3
, 4
]
所需删除的封禁规则类型:
IP string
IP 地址。RuleType 为 1 时必填。
RoomId string
房间 ID。RuleType 为 2、4 时必填。
UserId string
用户 ID。RuleType 为 3、4 时必填。
Responses
- 200
操作成功
- application/json
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
RESPONSEClear