获取文档列表

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

# 获取文档列表

openID

300

# 接口说明

本接口用于拉取目录下的文件与文件夹列表。

# 权限说明

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

scope.drive.readonly

# 请求格式

描述	定义
Path	/openapi/drive/v2/folders/{folderID}
Method	GET
Accept	application/json

# 请求头部

详见Headers。

# 请求参数

# 路径参数

参数名	类型	必选	描述
folderID	string	否	文件夹唯一标识，不填默认为 `我的文档` 目录

# 查询参数

参数名	类型	必选	描述
sortType	string	否	排序类型，默认为 `browse`
asc	integer	否	排列顺序。`1`：正序；`0`：倒序，默认值
start	integer	否	开始值，默认为 `0`
limit	integer	否	拉取条目，默认为 `20`

# 请求体

无

# 响应参数

# 请求体

参数名	类型	描述
ret	integer	业务返回码
msg	string	业务返回码描述
data	json object	业务响应数据，详见列表中的文件信息

# 请求包体

GET /openapi/drive/v2/folders/FOLDER_ID 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 GET 'https://docs.qq.com/openapi/drive/v2/folders/FOLDER_ID?sortType=browse&asc=0&start=0&limit
=20' \
--header 'Access-Token: ACCESS_TOKEN' \
--header 'Client-Id: CLIENT_ID' \
--header 'Open-Id: OPEN_ID'

1
2
3
4
5

# 响应包体

HTTP/1.1 200 OK
Date: Thu, 28 Jul 2022 15:34:46 GMT
Content-Type: text/plain; charset=utf-8
Content-Length: 3
Connection: keep-alive
 
{'ret': 0, 'msg': 'Succeed', 'data': {'next': 20, 'list': [{'ID': 'FOLDER_ID1', 'title': 'Hi，欢迎使用腾讯文档', 'type': 'folder', 'url': 'https://docs.qq.com/desktop/mydoc/folder/FOLDER_ID1', 'status': 'normal', 'isCreator': True, 'createTime': 1587134924, 'creatorName': '张三', 'isOwner': True, 'ownerName': '张三', 'lastModifyTime': 1597200449, 'lastBrowseTime': 1603358078}, {'ID': 'FOLDER_ID2', 'title': 'test', 'type': 'folder', 'url': 'https://docs.qq.com/desktop/mydoc/folder/FOLDER_ID2', 'status': 'normal', 'isCreator': True, 'createTime': 1597200352, 'creatorName': '张三', 'isOwner': True, 'ownerName': '张三', 'lastModifyTime': 1601026399, 'lastBrowseTime': 1603355308}, {'ID': '300000000$AAAAAAAAAAAA', 'title': 'file', 'type': 'doc', 'url': 'https://docs.qq.com/doc/DAAAAAAAAAAAAAAAA', 'status': 'normal', 'isCreator': True, 'createTime': 1598499361, 'creatorName': '张三', 'isOwner': True, 'ownerName': '张三', 'lastModifyTime': 1599538733, 'lastBrowseTime': 1602837243, 'starred': False, 'pinned': False}, {'ID': '300000000$FFFFFFFFFFFF', 'title': '无标题文档', 'type': 'doc', 'url': 'https://docs.qq.com/doc/DFFFFFFFFFFFFFFFF', 'status': 'normal', 'isCreator': True, 'createTime': 1602751265, 'creatorName': '张三', 'isOwner': True, 'ownerName': '张三', 'lastModifyTime': 1602751265, 'lastBrowseTime': 1602751269, 'starred': False, 'pinned': False}]}}

1
2
3
4
5
6
7

# 错误码

错误码	错误说明	排查建议
10313	Access-Token 为空	HTTP Header 里 `Access-Token` 校验失败，请参考示例中的携带方式，检查相应字段。详情请见Headers。
10303	Open-Id 错误	HTTP Header 里 `Open-Id` 与预期不符，可能的原因有： - `Open-Id` 为空。请参考示例中的携带方式，检查相应字段。详情请见Headers。 - `Open-Id` 与 `Access-Token` 不匹配，请检查 Header 内容和获取 Token 接口回包是否一致。
10302	Client-Id 错误	HTTP Header 里 `Client-Id` 与预期不符，可能的原因有： - `Client-Id` 为空。请参考示例中的携带方式，检查相应字段。详情请见Headers。 - `Client-Id` 与 `Access-Token` 不匹配，请检查 Header 内容和调用获取 Token 接口接口时参数中的 `Client-Id` 是否一致。
37019	Token 校验失败，错误或过期	检查位于 HTTP Header 中的 `Access-Token` 是否正确，获取 Token 的方式请查阅授权流程以及获取 Token 接口

查询更多业务返回码

导出进度查询查询文件夹信息