logo
控制台登录/注册
文档
客户端 API
服务端 API
实时语音
服务端 API
当前页

删除媒体文件

描述

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

注意

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

接口原型

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

请求参数

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

参数类型是否必选描述
VendorString是

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

  • Tencent：腾讯云。
  • Ws：网宿。
  • Huawei：华为云。
FileId[]Array of String是

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

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

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

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

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

请求示例

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

响应参数

参数类型描述
CodeNumber返回码。
MessageString操作结果描述。
RequestIdString请求 ID，由 ZEGO 服务端返回。
DataString响应数据，由以下参数 JSON 序列化后生成。
└ DeletedArray of String成功删除的文件列表。
└ ErrorsArray of Object未成功删除的文件列表，详情可见Errors。
Errors
参数类型描述
CodeString删除文件失败的错误码。
MessageString删除文件失败的错误消息。
KeyString删除失败的文件的唯一标识。
RequestIdString唯一请求 ID，由请求参数 Vendor 取值对应的 CDN 厂商返回，定位问题时需要提供该次请求的 RequestId。

响应示例

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

返回码

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

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

Previous

检索媒体信息

Next

合并媒体文件

当前页

返回到顶部