Documentation
Server APIs v2
Streaming control
Forbid a stream on ZEGO RTC Server

Forbid a stream on ZEGOCLOUD RTC Server

Last updated：2025-01-24 17:55

1 Description

Forbids a specified live stream to be published to ZEGOCLOUD's RTC server.

When a stream is forbidden on ZEGOCLOUD's RTC server, the app client that is publishing the stream and the app clients that are playing the stream will be notified of the event through the following callbacks:

The client receives the notification of the publishing stream being prohibited by the server using the ZEGOCLOUD SDK callback interface:

	ZEGO Express SDK
Platform	Callback	Error code
iOS/macOS	onPublisherStateUpdate	1003025
Android	onPublisherStateUpdate	1003025
Windows	onPublisherStateUpdate	1003025

The client receives the notification of the playing stream being prohibited by the server using the ZEGOCLOUD SDK callback interface:

Platform	ZegoExpress SDK
Platform	Callback	Error code
iOS/macOS	onPlayerStateUpdate	1004025
Android	onPlayerStateUpdate	1004025
Windows	onPlayerStateUpdate	1004025

2 Request method and endpoint

Request method: GET
Request endpoint: https://rtc-api.zego.im/?Action=ForbidRTCStream
Transmission protocol: HTTPS
Rate limit: 20 requests/second (Testing environment: 5 requests/second)

3 Request parameters

Listed below are the parameters specific to this request and part of the public request parameters. For the complete list of public request parameters, see Server APIs public request parameters.

Parameter	Type	Required	Description
StreamId	String	Yes	Stream ID.
Sequence	String	Yes	Request sequence number. Requests must be sent with the request sequence number in ascending order. It is recommended to use a timestamp (in milliseconds) as the request sequence number.

4 Sample request

https://rtc-api.zego.im/?Action=ForbidRTCStream
&StreamId=rtc01
&Sequence=1617249600001
&<Public Request Parameters>

5 Response parameters

Parameter	Type	Description
Code	Number	Return code.
Message	String	Description of the request execution result.
RequestId	String	Request ID.
Data	Object	Returned data.

6 Sample response

{
    "Code":0,
    "Message":"ok",
    "RequestId":"1929203990360298509",
    "Data":null
}

7 Return codes

Listed below are the return codes related to this API. For the complete list of return codes, see Return codes.

Return Code	Description	Suggested Action
3000	Invalid App.	Please contact ZEGOCLOUD technical support for handling.
3001, 5006, 30003	Internal error.	Please contact ZEGOCLOUD technical support for handling.
3002	Timestamp error.	Please regenerate a new Timestamp.
3003	App is not configured with Token.	Please contact ZEGOCLOUD technical support for handling.
30002	API call frequency is too high.	Please reduce the API request frequency.
30004	Parameter isTest is incorrect.	Please check if the common request parameter isTest is correct.
30005	Invalid AppId.	Please check if the AppId is correct.
30009	Invalid StreamId, stream name is not standardized.	Please check if the StreamId conforms to the stream name coding specifications.
40005	Authentication failed.	Please check if the signature Signature is correct.