删除文档

... 2022-7-14 大约 2 分钟

# 删除文档

openID

300

# 接口说明

本接口用于删除用户列表中的一个文档，删除对象可以是源文件、共享文件、浏览记录、回收站文件。默认彻底删除，如需移入回收站，请使用查询参数 recoverable。

# 权限说明

本接口需要拥有以下任意一项权限：

scope.drive.deletable

# 请求格式

描述	定义
Path	/openapi/drive/v2/files/{fileID}
Method	DELETE
Content-Type	application/json

# 请求头部

详见Headers。

# 请求参数

# 路径参数

参数名	类型	必选	描述
fileID	string	是	文档唯一标识，详见fileID。注意：快捷方式文档只能删除 `shortcutID`，不能删除源文档 `ID`

# 查询参数

参数名	类型	必选	描述
type	string	否	文件所属的列表类型（`origin`：源文件，`shared`：共享文件，`recent`：浏览记录，`trash`：回收站文件），默认值是 `origin`
recoverable	integer	否	是否删除到回收站（`0`：彻底删除，`1`：删除到回收站），默认值是彻底删除。删除回收站、浏览记录中的文件时，结果都是彻底删除。

# 请求体

无

# 响应参数

# 请求体

参数名	类型	描述
ret	integer	业务返回码
msg	string	业务返回码描述

# 请求包体

DELETE /openapi/drive/v2/files/300000000$AAAAAAAAAAAA HTTP/1.1
Host: docs.qq.com
Access-Token: ACCESS_TOKEN
Client-Id: CLIENT_ID
Open-Id: OPEN_ID
Content-Length: 0

1
2
3
4
5
6

# 示例

curl --location --request DELETE 'https://docs.qq.com/openapi/drive/v2/files/300000000$AAAAAAAAAAAA' \
--header 'Access-Token: ACCESS_TOKEN' \
--header 'Client-Id: CLIENT_ID' \
--header 'Open-Id: OPEN_ID' 
--data '{
    "recoverable": 1
}'

1
2
3
4
5
6
7

# 响应包体

HTTP/1.1 200 OK
Date: Thu, 28 Jul 2022 15:34:46 GMT
Content-Type: text/plain; charset=utf-8
Content-Length: 2
Connection: keep-alive
 
{'ret': 0, 'msg': 'Succeed'}

1
2
3
4
5
6
7

# 错误码

错误码	错误说明	排查建议
10102	文件不存在	检查 `fileID` 参数是否正确，`fileID` 的获取方式见fileID

查询更多业务返回码

移动文档生成副本