Skip to content

获取元数据

该接口用于根据 token 获取各类文件的元数据。

Note 请求用户需要拥有该文件的访问(读)权限

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/suite/docs-api/meta
HTTP MethodPOST
支持的应用类型custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可drive:drive 查看、评论、编辑和管理云空间中所有文件 drive:drive.metadata:readonly 查看云空间中文件元数据

请求头

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

请求体

参数类型必须说明
request_docs请求文档,一次不超过200个
 ∟docs_tokenstring文件的 token,获取方式见概述
 ∟docs_typestring文件类型
1) "doc": 飞书文档
2) "sheet": 飞书电子表格
3) "bitable": 飞书多维表格
4) "mindnote": 飞书思维笔记
5) "file": 飞书文件
6) "docx": 飞书新版文档

请求体示例

json
{
    "request_docs": [
        {
            "docs_token": "12345",
            "docs_type": "doc"
        },  
        {
            "docs_token": "12345",
            "docs_type": "sheet"
        }
    ]
}

响应

响应体

参数说明
docs_metas文件元数据
 ∟docs_token文件token
 ∟docs_type文件类型
 ∟title标题
 ∟owner_id文件拥有者
 ∟create_time创建时间(Unix时间戳)
 ∟latest_modify_user最后编辑者
 ∟latest_modify_time最后编辑时间(Unix时间戳)

响应体示例

json
{
    "code": 0, 
    "msg": "Success",
    "data": { 
        "docs_metas": [ { 
                "docs_token": "doc22222",
                "docs_type": "doc",
                "title": "abc", 
                "owner_id": "12345", 
                "create_time": 123456, 
                "latest_modify_user": "12345", 
                "latest_modify_time": 123456
            }
        ]
    }
}

错误码

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

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