Skip to content

获取文件夹下文件清单

获取用户云空间中指定文件夹下的文件清单。清单类型包括文件、各种在线文档(文档、电子表格、多维表格、思维笔记)、文件夹和快捷方式。该接口不支持分页,并且不会递归的获取子文件夹的清单。

Error: 为了更好地提升该接口的安全性,我们对其进行了升级,请尽快迁移至 新版本>>

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/drive/explorer/v2/folder/:folderToken/children
HTTP MethodGET
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用drive:drive 查看、评论、编辑和管理云空间中所有文件

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token
Content-Typestring固定值:"application/json; charset=utf-8"

Note 关于云文档接口的 AccessToken 调用说明详见 云文档接口快速入门

路径参数

参数类型必须说明
folderTokenstring文件夹的 token,获取方式见 如何获取云文档资源相关 token

查询参数

参数类型必须说明
typesarray<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
         }
      }
   }
}

当请求对象为权限升级后的个人空间时,返回的数据除个人空间中的文件/文件夹外,还会返回共享空间中自己创建的文件夹

错误码

错误码说明排查建议
91201FAILED处理失败,稍后重试。
91202PARAMERR参数错误,检查参数是否正确,如:typefileTokendstFolderToken
91203NOTEXIST请检查请求参数是否正确,如:typefileToken是否匹配。
91204FORBIDDEN检查当前账户对文档、文件夹的权限。参考接入流程授权
91205DELETED来源文件已被删除,检查是否还存在。
91206OUT_OF_LIMIT超过限制。
91207DUPLICATE重复记录。
91208REVIEW内容审查不通过。

具体可参考:服务端错误码说明

内容来源:飞书开放平台 · 自动爬取整理