StopCDNRecord

GET

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

调用本接口停止 CDN 录制。相关回调请参考录制文件生成回调。

调用频率限制

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

Request

Query Parameters

Action string必填

可选值: [StopCDNRecord]

接口原型参数

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

AppId uint32必填

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

SignatureNonce string必填

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

Timestamp int64必填

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

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

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

IsTest string

可选值: [false, true]

默认值: false

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

⚠️注意：测试环境跟正式环境是隔离的，请不要在操作正式环境 appid 时误把该参数标记为 true。2021-11-16 及之后创建的项目建议不要填写该参数。

📌是否必填参数：2021-11-16 及之前在 ZEGO 控制台创建的项目为必填，之后创建的则不是必填。

StreamId string[]必填

可选值: >= 1

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

Vendor string必填

可选值: [Tencent, Ws, Huawei]

CDN 厂商名。

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

Responses

成功

application/json

数据结构
按数据结构生成的示例

Schema

Code int32

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

返回码	说明	处理建议
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。

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": "4315169065145771656",
  "Data": {
    "Tencent": [
      {
        "StreamName": "cdn01",
        "RequestId": "d39548da-fbd4-4dce-8023-cfccd28a9963",
        "Code": "",
        "Message": ""
      }
    ],
    "Ws": {
      "msg": null,
      "http_code": 200,
      "trace_id": "10021988-6472-4b6d-9f9a-6b5a6d4b6551",
      "call_time": "2022-05-26 11:46:06",
      "list": [
        {
          "task": "mp4",
          "id": "test",
          "http_code": 200,
          "msg": "success",
          "persistentId": "202009a378bae528409f87dbe20717415676"
        }
      ]
    },
    "Huawei": [
      {
        "StreamName": "hwtest",
        "RequestId": "f7b1e2f0ca92e7e90f8f0c8b96cds757",
        "Code": 0,
        "Message": "success"
      }
    ]
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "4315169065145771656",
  "Data": {
    "Tencent": [
      {
        "StreamName": "cdn01",
        "RequestId": "d39548da-fbd4-4dce-8023-cfccd28a9963",
        "Code": "",
        "Message": ""
      }
    ],
    "Ws": {
      "msg": null,
      "http_code": 200,
      "trace_id": "10021988-6472-4b6d-9f9a-6b5a6d4b6551",
      "call_time": "2022-05-26 11:46:06",
      "list": [
        {
          "task": "mp4",
          "id": "test",
          "http_code": 200,
          "msg": "success",
          "persistentId": "202009a378bae528409f87dbe20717415676"
        }
      ]
    },
    "Huawei": [
      {
        "StreamName": "hwtest",
        "RequestId": "f7b1e2f0ca92e7e90f8f0c8b96cds757",
        "Code": 0,
        "Message": "success"
      }
    ]
  }
}

CURL

RESPONSE清除

点击上方 “发送” 按钮，在此处查看响应。

StopCDNRecord

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

Request

Query Parameters

Responses​

Responses