列表过滤

openID

300

接口说明

本接口用于根据限制条件拉取文档列表。

权限说明

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

• scope.drive.readonly

请求格式

描述	定义
Path	/openapi/drive/v2/filter
Method	GET
Accept	application/json

请求头部

详见Headers。

请求参数

路径参数

无

查询参数

参数名	类型	必选	描述
listType	string	否	见列表类型，默认为 folder
sortType	string	否	见排序类型，默认为 browse
asc	integer	否	是否正序排列，1：正序，0：倒序，默认为 0
folderID	string	否	文件夹唯一标识，根目录 folderID 为 /。默认为 /
start	integer	否	开始值，第一次填 0，后续填 next 的值
limit	integer	否	拉取数，上限为 20
isOwner	integer	否	根据请求者是否为文件拥有者进行过滤，1：返回所有文件，2：返回请求者拥有的文件，默认为返回所有文件
fileType	string	否	指定要拉取的文件品类，可传多个，用减号 - 分割，默认为拉取所有品类。见文件类型

请求体

无

响应参数

请求体

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

请求包体

GET /openapi/drive/v2/filter HTTP/1.1
Host: docs.qq.com
Access-Token: ACCESS_TOKEN
Client-Id: CLIENT_ID
Open-Id: OPEN_ID
Content-Length: 0

示例

curl --location --request GET 'https://docs.qq.com/openapi/drive/v2/filter?listType=folder&sortType=browse&limit=80&fileType=&folderID=/'  \
--header 'Access-Token: ACCESS_TOKEN' \
--header 'Client-Id: CLIENT_ID' \
--header 'Open-Id: OPEN_ID'

响应包体

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': 'aE33dOHqK2_100000', 'title': 'FOLDER_TITLE1', 'type': 'folder', 'url': 'https://docs.qq.com/desktop/mydoc/folder/aE33dOHqK2_100000', 'status': 'normal', 'fileSource': 'external', 'isCreator': True, 'createTime': 1587134924, 'creatorName': '张三', 'isOwner': True, 'ownerName': '张三', 'lastModifyTime': 1597200449, 'lastBrowseTime': 1603358078, 'isCollaborated': False}, {'ID': 'aE33dOHqK2_100001', 'title': 'FOLDER_TITLE2', 'type': 'folder', 'url': 'https://docs.qq.com/desktop/mydoc/folder/aE33dOHqK2_100001', 'status': 'normal', 'fileSource': 'personal', 'isCreator': True, 'createTime': 1597200352, 'creatorName': '张三', 'isOwner': True, 'ownerName': '张三', 'lastModifyTime': 1601026399, 'lastBrowseTime': 1603355308, 'isCollaborated': True}, {'ID': '300000000$AAAAAAAAAAAA', 'title': 'FILE_TITLE1', 'type': 'doc', 'url': 'https://docs.qq.com/doc/DAAAAAAAAAA', 'status': 'normal', 'fileSource': 'personal', 'isCreator': True, 'createTime': 1598499361, 'creatorName': '张三', 'isOwner': True, 'ownerName': '张三', 'lastModifyTime': 1599538733, 'lastBrowseTime': 1602837243, 'starred': False, 'pinned': False, 'isCollaborated': True}, {'ID': '300000000$BBBBBBBBBBB', 'title': 'FILE_TITLE2', 'type': 'doc', 'url': 'https://docs.qq.com/doc/DBBBBBBBBBB', 'status': 'normal', 'fileSource': 'external', 'isCreator': True, 'createTime': 1602751265, 'creatorName': '张三', 'isOwner': True, 'ownerName': '张三', 'lastModifyTime': 1602751265, 'lastBrowseTime': 1602751269, 'starred': False, 'pinned': False, 'isCollaborated': False}]}}

错误码

错误码	错误说明	排查建议
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 接口

查询更多业务返回码