获取文件夹下文件清单
获取用户云空间中指定文件夹下的文件清单。清单类型包括文件、各种在线文档(文档、电子表格、多维表格、思维笔记)、文件夹和快捷方式。该接口不支持分页,并且不会递归的获取子文件夹的清单。
Error: 为了更好地提升该接口的安全性,我们对其进行了升级,请尽快迁移至 新版本>>
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/drive/explorer/v2/folder/:folderToken/children |
| HTTP Method | GET |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 | drive:drive 查看、评论、编辑和管理云空间中所有文件 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
Note 关于云文档接口的 AccessToken 调用说明详见 云文档接口快速入门
路径参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| folderToken | string | 是 | 文件夹的 token,获取方式见 如何获取云文档资源相关 token |
查询参数
| 参数 | 类型 | 必须 | 说明 |
|---|---|---|---|
| types | array<string> | 否 | 需要查询的文件类型,默认返回所有 children;types 可多选,可选类型有 doc、sheet、file、bitable、docx、folder、mindnote 。如 url?types=folder&types=sheet |
响应体
| 参数 | 说明 |
|---|---|
| parentToken | 文件夹的 token |
| children | 文件夹的下的文件 |
| ∟token | 文件的 token |
| ∟name | 文件的标题 |
| ∟type | 文件的类型 |
| ∟is_shortcut | 该文件是否是快捷方式,如果值为true,代表该文件是一个快捷方式 |
响应体示例
json
{
"code":0,
"msg":"Success",
"data":{
"parentToken":"token",
"children":{
"nodbc9eC8*****UFOq05rLhpjzc":{
"token":"fldbcRho4*****3mJkOAuPUZR9d",
"name":"test_folder_name",
"type":"folder",
"is_shortcut":false
},
"nodbcOjPU*****aVVjRDSw4mpeb":{
"token":"boxbcj55r*****YAS3C7Z4GWKNg",
"name":"test_file_name",
"type":"file",
"is_shortcut":false
}
}
}
}当请求对象为权限升级后的个人空间时,返回的数据除个人空间中的文件/文件夹外,还会返回共享空间中自己创建的文件夹
错误码
| 错误码 | 说明 | 排查建议 |
|---|---|---|
| 91201 | FAILED | 处理失败,稍后重试。 |
| 91202 | PARAMERR | 参数错误,检查参数是否正确,如:type、fileToken、dstFolderToken。 |
| 91203 | NOTEXIST | 请检查请求参数是否正确,如:type跟fileToken是否匹配。 |
| 91204 | FORBIDDEN | 检查当前账户对文档、文件夹的权限。参考接入流程授权 |
| 91205 | DELETED | 来源文件已被删除,检查是否还存在。 |
| 91206 | OUT_OF_LIMIT | 超过限制。 |
| 91207 | DUPLICATE | 重复记录。 |
| 91208 | REVIEW | 内容审查不通过。 |
具体可参考:服务端错误码说明
