文档中心
超级白板
服务端 API
删除文件

删除文件

更新时间：2024-04-02 14:23

本 API 为最新服务端 API v2 接口，支持全球就近接入、统一的鉴权方式、统一的参数风格和公共错误码。后续相关功能的新增都会在此更新。
旧版 API 接口仅供 2021-09-10 前接入的旧用户维护使用。旧版接口文档请参考旧版服务端 API。

1 描述

通过本接口将“转码后文件”或者“源文件以及转码后文件”从 ZEGO 云存储删除。

2 接口原型

请求方法：POST
请求地址：https://docs-api.zego.im/?Action=DeleteFile
传输协议：HTTPS
调用频率限制：10 次/秒

3 请求参数

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

参数	类型	是否必选	描述
FileId	String	是	转码成功后返回的文件 ID。
DeleteType	Int64	是	删除文件的类型参数，可设置为 1、2，各参数值说明如下： 1：转码后文件 2：源文件和转码后文件仅存储在 ZEGO 文件存储服务中的源文件可被删除。通过超级白板/文件共享 SDK 上传并转码的文件，源文件会存储在ZEGO 文件存储服务中。

4 请求示例

请求 URL

https://docs-api.zego.im/?Action=DeleteFile
&AppId=1234567890
&SignatureNonce=15215528852396
&Timestamp=1234567890
&Signature=7a2c0f11145fb760d607a07b54825013
&SignatureVersion=2.0
&IsTest=false

请求消息体

{
  "FileId": "8cb1bccbdf2e655a3b45f4b126ef8392",
  "DeleteType": 1
}

5 响应参数

参数	类型	描述
Code	Int64	错误码。
Message	String	错误描述。
RequestId	String	请求 ID。

6 响应示例

{
    "Code": 0,
    "Message": "succeed",
    "RequestId": "abcd123"
}

7 返回码

以下仅列出了接口业务相关的返回码，公共返回码请参考公共返回码。

返回码	说明
60100	删除文件的类型参数错误
60101	找不到 FileId 对应的转码后文件。