文档中心
服务端 API v2
媒体文件接口
删除媒体文件

删除媒体文件

更新时间：2024-04-01 18:28

1 描述

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

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

2 接口原型

请求方法：GET
请求地址：https://rtc-api.zego.im/?Action=DeleteMedia
传输协议：HTTPS
调用频率限制：20 次/秒

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式中的 “2.1 公共请求参数”。

参数	类型	是否必选	描述
Vendor	String	是	可能的取值及对应的 CDN 厂商： Tencent：腾讯云。 Ws：网宿。 Huawei：华为云。
FileId[]	Array of String	是	文件唯一标识，在录制文件生成回调中返回，最大支持 100 个媒体文件 FileId。请注意，各 CDN 厂商的录制文件唯一标识不同：腾讯云：FileID。网宿：PersistentId。华为云：ObsObject。您也可以通过检索媒体信息接口，获取媒体文件的唯一标识，标识对应的参数名称有所差异，请注意区分使用。示例：&FileId[]=5285890813221514958&FileId[]=5285890813221513290

4 请求示例

https://rtc-api.zego.im/?Action=DeleteMedia
&Vendor=Tencent
&FileId[]=5285890813221514958&FileId[]=5285890813221513290
&<公共请求参数>

5 响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	操作结果描述。
RequestId	String	请求 ID，由 ZEGO 服务端返回。
Data	String	响应数据，由以下参数 JSON 序列化后生成。
Deleted	Array of String	成功删除的文件列表。
Errors	Array of Object	未成功删除的文件列表。
Code	String	删除文件失败的错误码。
Message	String	删除文件失败的错误消息。
Key	String	删除失败的文件的唯一标识。
RequestId	String	唯一请求 ID，由请求参数 Vendor 取值对应的 CDN 厂商返回，定位问题时需要提供该次请求的 RequestId。

6 响应示例

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

7 返回码

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

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