StartCDNRecord

GET

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

CDN 可配置是否对所有直播流录制，若需要选择录制某条具体的直播流，可调用本接口实现。相关回调请参考录制文件生成回调。

在使用腾讯云提供的 CDN 服务时，要明确以下录制参数：

录制文件格式：支持 M3U8、FLV、MP4、AAC（单音频）和 MP3（单音频）。
录制间隔：录制文件的时长，单位为秒 (s)，取值范围为 300 s ～ 7200 s，默认值为 7200 s。此参数对 M3U8 录制文件格式无效。如果希望录制文件的时长超过 7200 s（2 小时），则需要使用录制文件合并接口对多个录制文件进行合并。
存储时长：明确录制文件的保留时长。

注意

使用本接口之前需要明确录制参数，然后将录制参数同步给 ZEGO 技术支持进行配置，或前往 ZEGO 控制台自助配置，详情请参考控制台 - 服务配置 - CDN。

调用频率限制

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

Request

Query Parameters

Action stringrequired

Possible values: [StartCDNRecord]

接口原型参数

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

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 控制台创建的项目默认是测试环境，可根据业务需求设置此参数；而之后创建的项目默认是正式环境。

StreamId string[]required

Possible values: >= 1

流 ID 列表。
以同时录制 “cdn01” 和 “cdn02” 两个流为例，请求的参数为：StreamId[]=cdn01和StreamId[]=cdn02。

Vendor stringrequired

Possible values: [Tencent, Ws, Huawei]

CDN 厂商名。

Tencent：腾讯云。 Ws：网宿。 Huawei：华为云。

EndTime string

录制任务结束时间，Unix 时间戳。设置时间必须大于当前时间，且不能超过从当前时刻开始 24 小时之内的时间。

此参数仅在 Vendor 为 “Tencent” 时才生效。

Responses

成功

application/json

Schema
Example (from schema)

Schema

Code number

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

返回码	说明	处理建议
0	请求成功。	-
2	输入参数错误。	-
3	未开通相关权限。	请联系 ZEGO 技术支持。
4	CDN 类型不匹配。	请检查参数。
5	配置错误。	请联系 ZEGO 技术支持。
6	请求过于频繁。	请稍后重试。
7	鉴权失败。	请检查鉴权参数是否正确。
1000	请求失败。	请联系 ZEGO 技术支持。

Message string

操作结果描述。

RequestId string

请求 ID，由 ZEGO 服务端返回。

Data object

响应数据。

Tencent object[]

腾讯云 返回内容（Vendor 为 Tencent 时返回）。

Array[

StreamName string

流名称，即请求参数中的 StreamId。

TaskId string

任务 ID，全局唯一标识录制任务。

RequestId string

唯一请求 ID，由请求参数 Vendor 取值对应的 CDN 厂商（即腾讯云）返回，定位问题时需要提供该次请求的 RequestId。

Code string

当前流的错误码，请参考 Message 信息处理，或联系 ZEGO 技术支持。

Message string

当前流错误信息。

]

Ws object

网宿 返回内容（Vendor 为 Ws 时返回）。

msg object

操作结果提示语。

http_code int32

业务操作状态。

trace_id string

流水号。

call_time string

发起请求时间。

list object[]

Array[

task string

录制文件的格式。

id string

流名称，即请求参数中的 StreamId。

http_code int32

该任务的操作状态，请参考 msg 信息处理，或联系 ZEGO 技术支持。

msg string

该任务的操作结果提示语。

persistentId string

该任务的文件标识。

]

Huawei object[]

华为云 返回内容（Vendor 为 Huawei 时返回）。

Array[

StreamName string

流名称，即请求参数中的 StreamId。

RequestId string

唯一请求 ID，由请求参数 Vendor 取值对应的 CDN 厂商（即 Huawei）返回，定位问题时需要提供该次请求的 RequestId。

Code int32

当前流录制的错误码，请参考 Message 信息处理，或联系 ZEGO 技术支持。

Message string

当前流录制的错误信息。

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "4191282558729715911",
  "Data": {
    "Tencent": [
      {
        "StreamName": "cdn01",
        "TaskId": "UUpTbkZUQV5WQVxrRFtDUQIUB29FWwMeAxwALBxMAggNHxw7WRUWGBVeEzoTDl0CDEoFNgIESVpXQV9rRVRCXlVKWGlFV0daVENeaFdURVNY",
        "RequestId": "70628bcd-5652-4d5c-aa04-97956a4e771a",
        "Code": "",
        "Message": ""
      }
    ],
    "Ws": {
      "msg": null,
      "http_code": 200,
      "trace_id": "15ccf21b-f3c2-4ee3-aaad-d995393f80cd",
      "call_time": "2022-04-27 14:27:48",
      "list": [
        {
          "task": "mp4",
          "id": "vega_test",
          "http_code": 200,
          "msg": "success",
          "persistentId": "2020bc8b648883c64e7e81f03cf72b70b86f"
        }
      ]
    },
    "Huawei": [
      {
        "StreamName": "hwtest",
        "RequestId": "c373b2cc8a51159d4d60e0ec543csd88",
        "Code": 0,
        "Message": "success"
      }
    ]
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "4191282558729715911",
  "Data": {
    "Tencent": [
      {
        "StreamName": "cdn01",
        "TaskId": "UUpTbkZUQV5WQVxrRFtDUQIUB29FWwMeAxwALBxMAggNHxw7WRUWGBVeEzoTDl0CDEoFNgIESVpXQV9rRVRCXlVKWGlFV0daVENeaFdURVNY",
        "RequestId": "70628bcd-5652-4d5c-aa04-97956a4e771a",
        "Code": "",
        "Message": ""
      }
    ],
    "Ws": {
      "msg": null,
      "http_code": 200,
      "trace_id": "15ccf21b-f3c2-4ee3-aaad-d995393f80cd",
      "call_time": "2022-04-27 14:27:48",
      "list": [
        {
          "task": "mp4",
          "id": "vega_test",
          "http_code": 200,
          "msg": "success",
          "persistentId": "2020bc8b648883c64e7e81f03cf72b70b86f"
        }
      ]
    },
    "Huawei": [
      {
        "StreamName": "hwtest",
        "RequestId": "c373b2cc8a51159d4d60e0ec543csd88",
        "Code": 0,
        "Message": "success"
      }
    ]
  }
}

CURL

RESPONSEClear

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

StartCDNRecord

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

Request

Query Parameters

Responses​

Responses