获取文件元数据

该接口用于根据文件 token （文件的唯一标识）获取其元数据，包括标题、所有者、创建时间、密级、访问链接等数据。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/drive/v1/metas/batch_query
HTTP Method	POST
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	drive:drive 查看、评论、编辑和管理云空间中所有文件 drive:drive.metadata:readonly 查看云空间中文件元数据
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID drive:file.meta.sec_label.read_only 获取文档密级标签名称

请求头

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

查询参数

名称	类型	必填	描述
user_id_type	string	否	用户 ID 类型 示例值：open_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ 默认值：open_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体

名称	类型	必填	描述
request_docs	request_doc\[\]	是	请求的文件的 token 和类型。一次请求中不可超过 200 个 数据校验规则： - 长度范围：1 ～ 200
└ doc_token	string	是	文件的 token，获取方式见文件概述 示例值："doccnfYZzTlvXqZIGTdAHKabcef"
└ doc_type	string	是	文件的类型 示例值："doc" 可选值有： - doc: 飞书文档 - sheet: 飞书电子表格 - bitable: 飞书多维表格 - mindnote: 飞书思维笔记 - file: 飞书文件 - wiki: 飞书知识库 - docx: 飞书新版文档 - folder: 飞书文件夹 - synced_block: 文档同步块（灰度中） - slides: 文档幻灯片
with_url	boolean	否	是否获取文件的访问链接，默认值为false。 示例值：false

请求体示例

{
    "request_docs": [
        {
            "doc_token": "doccnfYZzTlvXqZIGTdAHKabcef",
            "doc_type": "doc"
        }
    ],
    "with_url": false
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ metas	meta\[\]	文件的元数据列表
└ doc_token	string	文件的 token
└ doc_type	string	文件的类型
└ title	string	标题
└ owner_id	string	文件的所有者
└ create_time	string	创建时间。UNIX 时间戳，单位为秒
└ latest_modify_user	string	最后编辑者
└ latest_modify_time	string	最后编辑时间。UNIX 时间戳，单位为秒
└ url	string	文档访问链接
└ sec_label_name	string	文档密级标签名称 字段权限要求： drive:file.meta.sec_label.read_only 获取文档密级标签名称
└ request_doc_info	request_doc	用于回显入参(requst_doc_info中的字段信息即为为请求体中的request_docs字段信息)，如果入参中有相同token时无效
└ doc_token	string	文件的 token，获取方式见概述
└ doc_type	string	文件类型 可选值有： - doc: 飞书文档 - sheet: 飞书电子表格 - bitable: 飞书多维表格 - mindnote: 飞书思维笔记 - file: 飞书文件 - wiki: 飞书wiki - docx: 飞书新版文档 - folder: 飞书文件夹 - synced_block: 文档同步块 - slides: 文档幻灯片
└ failed_list	meta_failed\[\]	获取元数据失败的文档 token 列表
└ token	string	获取元数据失败的文档token
└ code	int	获取元数据失败的错误码 可选值有： - 970002: 文档类型不支持 - 970003: 当前应用或用户没有获取该文件元数据的权限 - 970005: 文件 token 和 doc_type 不匹配或该文件不存在

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "metas": [
            {
                "doc_token": "doccnfYZzTlvXqZIGTdAHKabcef",
                "doc_type": "doc",
                "title": "sampletitle",
                "owner_id": "ou_b13d41c02edc52ce66aaae67bf1abcef",
                "create_time": "1652066345",
                "latest_modify_user": "ou_b13d41c02edc52ce66aaae67bf1abcef",
                "latest_modify_time": "1652066345",
                "url": "https://sample.feishu.cn/docs/doccnfYZzTlvXqZIGTdAHKabcef",
                "sec_label_name": "L2-内部",
                "request_doc_info": {
                    "doc_token": "TLLKdcpDro9ijQxA33ycNMabcef",
                    "doc_type": "docx"
                }
            }
        ],
        "failed_list": [
            {
                "token": "boxcnrHpsg1QDqXAAAyachabcef",
                "code": 970005
            }
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
401	1069701	User identity verification failed	检查appid是否正确
503	1069704	Internal server error	服务端错误，请稍后重试，若仍报错可联系技术支持