提交工单
咨询集成、功能及报价等问题
Forbids a specified live stream to be published to ZEGO's RTC server.
When a stream is forbidden on ZEGO'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:
ZEGO Express SDK | ||
---|---|---|
Platform |
Callback |
Error code |
iOS/macOS |
onPublisherStateUpdate |
1003025 |
Android |
onPublisherStateUpdate |
1003025 |
Windows |
onPublisherStateUpdate |
1003025 |
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. |
https://rtc-api.zego.im/?Action=ForbidRTCStream
&StreamId=rtc01
&Sequence=1617249600001
&<Public Request Parameters>
Parameter | Type | Description |
---|---|---|
Code |
Number |
Return code. |
Message |
String |
Description of the request execution result. |
RequestId |
String |
Request ID. |
Data |
Object |
Returned data. |
{
"Code":0,
"Message":"ok",
"RequestId":"1929203990360298509",
"Data":null
}
Listed below are the return codes related to this API. For the complete list of return codes, see Return codes.
Return code | Description |
---|---|
41001 | Failed to save live stream. |
41002 | Failed to save channel. |
41003 | Live stream does not exist. |
41004 | Stream no longer exists. |
42001 | Failed to forbid live stream. |
42002 | Failed to resume live stream. |
42003 | Batch disable live broadcast failed. |
42004 | Failed to resume live streaming in batches. |
43001 | Failed to create recording index file. |