DescribeForbidUserRules
https://rtc-api.zego.im/
Query user prohibition rules.
Calling the DescribeForbidUserRules interface allows you to query both currently active rules and expired rules. Please note that ZEGOCLOUD periodically purges expired prohibition rules from the database, so the list of expired rules returned by this interface may be incomplete.
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: [DescribeForbidUserRules]
Interface prototype parameters
https://rtc-api.zego.im?Action=DescribeForbidUserRules
💡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]
Type of prohibition rule to query:
Responses
- 200
- application/json