SetForbidStreamRule
https://rtc-api.zego.im/
Set the Stream publishing prohibition rule.
After setting successfully, you can query Stream publishing prohibition rules or delete Stream publishing prohibition rules.
Usage of DisableAudio and DisableVideo parameters:
- At least one parameter must be set to 1, otherwise calling this interface will result in an error.
- For the same Stream ID, if this interface is called multiple times to set different prohibition rules (with different DisableAudio and DisableVideo parameter values each time), the settings from the last call will prevail.
Request
Query Parameters
Possible values: [SetForbidStreamRule]
API Prototype Parameter
https://rtc-api.zego.im?Action=SetForbidStreamRule
💡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.
Room ID.
Possible values: <= 256 characters
Stream ID, maximum length not exceeding 256 bytes.
Possible values: [0, 1]
Default value: 0
Whether to prohibit audio. 0: Do not prohibit (default); 1: Prohibit.
Possible values: [0, 1]
Default value: 0
Whether to prohibit video. 0: Do not prohibit (default); 1: Prohibit.
Possible values: >= 1 and <= 86400
Default value: 21600
Effective duration of the prohibition rule, in seconds. Default 21600. Range 1 ~ 86400 (values exceeding 24 hours will be automatically adjusted to 24 hours).
Responses
- 200
- application/json