QueryForbidCDNLiveStream

GET

https://rtc-api.zego.im/

调用本接口查询已被禁止推流到 CDN 的 URL 列表。

注意

首次使用本接口，需要联系 ZEGO 技术支持进行配置。

调用频率限制

同一个 AppID 下所有房间：20 次/秒

Request

Query Parameters

Action stringrequired

Possible values: [QueryForbidCDNLiveStream]

接口原型参数

https://rtc-api.zego.im?Action=QueryForbidCDNLiveStream

AppId uint32required

💡公共参数。AppId，ZEGO 分配的用户唯一凭证。

SignatureNonce stringrequired

💡公共参数。随机字符串。

Timestamp int64required

💡公共参数。Unix 时间戳，单位为秒。最多允许 10 分钟的误差。

Signature stringrequired

💡公共参数。签名，用于验证请求的合法性。

SignatureVersion stringrequired

Possible values: [2.0]

Default value: 2.0

💡公共参数。签名版本号。

IsTest string

Possible values: [true, false]

Default value: false

💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境，可根据业务需求设置此参数；而之后创建的项目默认是正式环境。

Vendor stringrequired

CDN 提供商，ws：网宿。

Responses

成功

application/json

Schema
Example (from schema)
Example

Schema

Code number

返回码。以下仅列出了接口业务逻辑相关的部分返回码，完整返回码请参考全局返回码。

返回码	说明	处理建议
0	请求成功。	-
1	请求失败。	-
2	参数错误。	-
3	鉴权失败。	请检查鉴权参数是否正确。

Message string

操作结果描述

RequestId string

请求 ID

Data object

响应数据

Ws object

网宿返回的查询结果

ResultDetail object[]

查询结果的集合

Array[

Channel string

加速域名

Url string

被禁止推流的 CDN 直播地址的完整 URL，例如，rtmp://publish-ws.zegotech.cn/test/流 ID

StartTime string

开始禁止推流的时间，UTC 时间

EndTime string

恢复推流的时间，UTC 时间

Ip stringdeprecated

禁止观看直播的用户 IP（已废弃）

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "",
  "Data": {
    "Ws": {
      "ResultDetail": [
        {
          "Channel": "publish-ws.zegotech.cn",
          "Url": "rtmp://publish-ws.zegotech.cn/test/stream001",
          "StartTime": "2024-10-12T03:47:53Z",
          "EndTime": "2024-10-14T02:22:00Z"
        }
      ]
    }
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "",
  "Data": {
    "Ws": {
      "ResultDetail": [
        {
          "Channel": "publish-ws.zegotech.cn",
          "Url": "rtmp://publish-ws.zegotech.cn/test/stream001",
          "StartTime": "2024-10-12T03:47:53Z",
          "EndTime": "2024-10-14T02:22:00Z"
        }
      ]
    }
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "",
  "Data": {
    "Ws": {
      "ResultDetail": [
        {
          "Channel": "publish-ws.zegotech.cn",
          "Url": "rtmp://publish-ws.zegotech.cn/test/stream001",
          "StartTime": "2024-10-12T03:47:53Z",
          "EndTime": "2024-11-11T03:47:53Z",
          "Ip": ""
        },
        {
          "Channel": "publish-ws.zegotech.cn",
          "Url": "rtmp://publish-ws.zegotech.cn/test/stream002",
          "StartTime": "2024-10-12T02:48:15Z",
          "EndTime": "2024-10-14T02:22:00Z",
          "Ip": ""
        }
      ]
    }
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "",
  "Data": {
    "Ws": {
      "ResultDetail": [
        {
          "Channel": "publish-ws.zegotech.cn",
          "Url": "rtmp://publish-ws.zegotech.cn/test/stream001",
          "StartTime": "2024-10-12T03:47:53Z",
          "EndTime": "2024-11-11T03:47:53Z",
          "Ip": ""
        },
        {
          "Channel": "publish-ws.zegotech.cn",
          "Url": "rtmp://publish-ws.zegotech.cn/test/stream002",
          "StartTime": "2024-10-12T02:48:15Z",
          "EndTime": "2024-10-14T02:22:00Z",
          "Ip": ""
        }
      ]
    }
  }
}

CURL

RESPONSEClear

Click the "Send" button above and see the response here!

QueryForbidCDNLiveStream

https://rtc-api.zego.im/

Request

Query Parameters

Responses​

Responses