DelForbidUserRule
https://rtc-api.zego.im/
Delete prohibition rules for users entering the Room. When certain user prohibition rules become invalid, are no longer needed, or the total number of rules exceeds the limit, you can delete user prohibition rules through this interface.
After deletion, you can use Query User Prohibition Rules to verify whether the corresponding user prohibition rules have been successfully deleted.
The maximum number of rules supported varies by RuleType. If you no longer need certain rules, please call this interface to clean them up in a timely manner. Additionally, ZEGOCLOUD will periodically clean up invalid prohibition rules in the database.
Request
Query Parameters
- 1: Prohibit users by IP address;
- 2: Prohibit users by RoomId;
- 3: Prohibit users by UserId;
- 4: Prohibit users by both RoomId and UserId.
Possible values: [DelForbidUserRule]
API prototype parameters
https://rtc-api.zego.im?Action=DelForbidUserRule
💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.
💡Common parameter. A 16-character hexadecimal random string (hex-encoded 8-byte random number). For the generation algorithm, refer to the signature example.
💡Common parameter. Current Unix timestamp in seconds. For the generation algorithm, refer to the signature example. A maximum deviation of 10 minutes is allowed.
💡Common parameter. Signature used to verify the legitimacy of the request. Please refer to the signature mechanism to generate it.
Possible values: [2.0]
Default value: 2.0
💡Public parameter. Signature version number.
Possible values: [1, 2, 3, 4]
The type of prohibition rule to delete:
IP address. Required when RuleType is 1.
Room ID. Required when RuleType is 2 or 4.
User ID. Required when RuleType is 3 or 4.
Responses
- 200
- application/json