DeleteMedia

GET

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

用户进行 CDN 录制时，会把录制好的媒体文件存放在 CDN 服务器上，用户可以调用本接口删除该文件。

注意

首次使用本接口之前，请确认是否已经开通 CDN 录制服务。若未开通，请前往 ZEGO 控制台自助开通，详情请参考控制台 - 服务配置 - CDN，或联系 ZEGO 技术支持开通。

调用频率限制

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

Request

Query Parameters

Action stringrequired

Possible values: [DeleteMedia]

接口原型参数

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

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

Possible values: [Tencent, Ws, Huawei]

可能的取值及对应的 CDN 厂商：

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

FileId string[]required

Possible values: >= 1, <= 100

文件唯一标识，在录制文件生成回调中返回，最大支持 100 个媒体文件 FileId。

请注意，各 CDN 厂商的录制文件唯一标识不同：

腾讯云：FileID。
网宿：PersistentId。
华为云：ObsObject。

您也可以通过检索媒体信息接口，获取媒体文件的唯一标识，标识对应的参数名称有所差异，请注意区分使用。

示例：&FileId[]=5285890813221514958&FileId[]=5285890813221513290

Responses

成功

application/json

Schema
Example (from schema)

Schema

Code int32

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

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

Message string

操作结果描述。

RequestId string

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

Data object

响应数据，由以下参数 JSON 序列化后生成。

Deleted string[]

成功删除的文件列表。

Errors object[]

未成功删除的文件列表。

Array[

Code string

删除文件失败的错误码。

Message string

删除文件失败的错误消息。

Key string

删除失败的文件的唯一标识。

RequestId string

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

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "3574501647605445341",
  "Data": {
    "Deleted": [
      "3270835010809755971",
      "3270835010811335406"
    ],
    "Errors": []
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "3574501647605445341",
  "Data": {
    "Deleted": [
      "3270835010809755971",
      "3270835010811335406"
    ],
    "Errors": []
  }
}

CURL

RESPONSEClear

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

DeleteMedia

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

Request

Query Parameters

Responses​

Responses