拉取文件列表
... 2026-2-4 大约 3 分钟
# 拉取文件列表
# 接口说明
查询指定列表下的文件，按主页模式返回，支持按特定字段排序。
# 请求格式
| 描述 | 定义 |
|---|---|
| Path | /openapi/drive/v3/files:list |
| Method | POST |
| Content-Type | application/json; charset=utf-8 |
# 请求头部
详见Headers。
# 请求参数
# 请求体
| 参数名 | 类型 | 必选 | 描述 |
|---|---|---|---|
| listType | enum(ListType) | 是 | 列表类型 |
| offset | integer | 否 | 拉取列表的起点 默认值为0 |
| limit | integer | 否 | 单次拉取的最大文件数量 默认值为0 |
| orderBy | enum(OrderBy) | 否 | 排序条件，不同列表支持的排序条件不同, 仅支持 MY_DOC, RECENT, STAR,SHARED 列表类型 |
| desc | bool | 否 | 是否为降序，默认为降序, 仅支持 MY_DOC, RECENT, STAR，TRASH,SHARED 列表类型 |
| parentId | string | 否 | 上级文件夹ID,仅支持 MY_DOC列表类型,从返回的FileInfo中获取 |
| extension | enum array (FileExt) | 否 | 筛选品类 不支持 TRASH,COLLABORATION_LIST |
| createSource | enum (CreateSource) | 否 | 所有者 不支持 TRASH,SHARED ,COLLABORATION_LIST |
| shareSource | enum (ShareSource) | 否 | 分享方式 仅支持 SHARED |
| deleteType | enum (DeleteType) | 否 | 删除的类型 仅支持 TRASH |
# 列表类型
| 字段 | 描述 |
|---|---|
| MY_DOC | 我的文档 |
| RECENT | 最近浏览 |
| STAR | 收藏列表 |
| TRASH | 回收站 |
| COLLABORATION_LIST | 共享空间 |
| SHARED | 与我共享 支持 |
# 排序条件
| 字段 | 描述 |
|---|---|
| FILE_NAME | 文件名 |
| ACCESS_TIME | 查看时间 |
| MODIFY_TIME | 修改时间 |
| STAR_TIME | 收藏时间 |
| DELETE_TIME | 删除时间 |
# 文件后缀
| 字段 | 描述 |
|---|---|
| ALL | 所有品类 |
| TENCENT_DOC | 在线DOC |
| TENCENT_SHEET | 在线sheet |
| TENCENT_SLIDE | 在线slide |
| TENCENT_FORM | 在线收集表 |
| SMART_CANVAS | 智能文档 |
| SMART_SHEET | 智能表格 |
| MIND | 脑图 |
| FLOWCHART | 流程图 |
| BOARD | 智能白板 |
| OFD | ofd |
| DOC | 本地doc |
| SHEET | 本地sheet |
| PPT | 本地ppt |
# 所有者
| 字段 | 描述 |
|---|---|
| ALLFILES | 全部 |
| MY | 我所有的 |
| OTHERS | 他人所有的 |
# 分享方式
| 字段 | 描述 |
|---|---|
| ALL | 全部 |
| PERSONAL | 个人分享 |
| GROUP | 群组分享 |
# 删除类型
| 字段 | 描述 |
|---|---|
| TRASH_FILE | 文件/文件夹 |
| TRASH_SPACE | 空间 |
# 请求示例
curl --location 'https://{domain}/openapi/drive/v3/files:list' \
--header 'Access-Token: ACCESS_TOKEN' \
--header 'Client-Id: CLIENT_ID' \
--data '{
"list_type":"MY_DOC",
"offset": 0,
"limit": 10,
"order_by":"FILE_NAME",
"desc":true
}'
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
# 响应参数
# 响应体
| 参数名 | 类型 | 描述 |
|---|---|---|
| files[] | object(FileInfo) | 列表中的多个文件信息 |
| next | integer | 下一次拉取列表的起点 |
# 响应示例
{
"files": [
{
"meta": {
"id": "",
"parentId": "AKTQTmGvOCyH",
"name": "文件夹权限2",
"type": "FOLDER",
"ext": "",
"status": "NORMAL",
"url": "https:",
"icon": "https://{domain}/private_cdn/tim/docs/docs-design-resources/mobile/png@3x/file_workspace_64@3x-3d469c7eaf.png",
"creator": {
"id": "1022447688093794304"
},
"createTime": "1682306646905",
"owner": {
"id": "1022447688093794304"
},
"lastModifyingUser": {
"id": "1022447688093794304"
},
"modifiedTime": "1682306646905",
"accessTime": "1682306811699",
"isFolder": true,
"isLink": false
},
"entry": {
"sourceParentId": "",
"deleteTime": "0",
"isTop": false,
"topTime": "0",
"isStar": false,
"starTime": "0"
}
},
{}...,
{
"meta": {
"id": "",
"parentId": "AKTQTmGvOCyH",
"name": "测试权限文件夹",
"type": "FOLDER",
"ext": "",
"status": "NORMAL",
"url": "https:",
"icon": "https://{domain}/private_cdn/tim/docs/docs-design-resources/mobile/png@3x/file_workspace_64@3x-3d469c7eaf.png",
"creator": {
"id": "1022447688093794304"
},
"createTime": "1679991813662",
"owner": {
"id": "1022447688093794304"
},
"lastModifyingUser": {
"id": "1022447688093794304"
},
"modifiedTime": "1679991813662",
"accessTime": "1679991813662",
"isFolder": true,
"isLink": false
},
"entry": {
"sourceParentId": "",
"deleteTime": "0",
"isTop": false,
"topTime": "0",
"isStar": false,
"starTime": "0"
}
}
],
"next": 10
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74