Server APIs v2
  • Server APIs overview
  • Accessing Server APIs
  • Room signaling
  • Stream mixing
  • Streaming moderation
  • Streaming control
  • Cloud recording
  • Server callbacks
  • Return codes
  • API testing

Forbid a stream on CDN

Last updated:2022-03-22 13:07

1 Description

Forbids a live stream to be published to CDN.

To use the CDN live streaming service, you will need to contact ZEGO Technical Support to enable it first.

2 Request method and endpoint

  • Request method: GET
  • Request endpoint: https://rtc-api.zego.im/?Action=ForbidCDNLiveStream
  • Transmission protocol: HTTPS
  • Rate limit: 20 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.

4 Sample request

https://rtc-api.zego.im/?Action=ForbidCDNLiveStream
&StreamId=cdn00
&<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
Array of Object
Returned data.
└ CdnType
String
CDN Type.
  • ws: Wangsu Cloud
  • aliyun: Alibaba Cloud
  • tencent: Tencent Cloud
└ CdnResult
String
CDN processing result.

6 Sample response

{
    "Code": 0,
    "Message": "success",
    "Data": [
        {
            "CdnType": "ws",
            "CdnResult": "Purge tasks added successfully."
        }
    ],
    "RequestId": "4113829426153229963"
}

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
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.