获取旧版文档元信息
Warning 此接口只支持查询旧版文档元信息。要查询新版文档(
docx类型)元信息,使用获取文档元数据接口。
该接口用于根据 docToken 获取元数据。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/doc/v2/meta/:docToken |
| HTTP Method | GET |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | drive:drive 查看、评论、编辑和管理云空间中所有文件 drive:drive:readonly 查看、评论和下载云空间中所有文件 drive:drive.metadata:readonly 查看云空间中文件元数据 docs:doc 查看、评论、编辑和管理文档 docs:doc:readonly 查看、评论和导出文档 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | user_access_token 或 tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
Note 关于云文档接口的 AccessToken 调用说明详见 云文档接口快速入门。
### 路径参数 |参数|类型|必须|说明| |--|-----|--|----|----| |docToken|string|是|doc 的 token,获取方式见[如何获取云文档资源相关 token](https://open.larkoffice.com/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN#08bb5df6)|
Curl 请求 Demo
curl -H 'Authorization: Bearer u-s12okJw4R1VCZLWhk9Zyzg' 'https://open.feishu.cn/open-apis/doc/v2/meta/doccnilYPZU5b34ow4ca7aabcef'响应
响应体
| 参数 | 类型 | 说明 |
|---|---|---|
| create_date | string | 创建日期 |
| create_time | integer | 创建时间戳 |
| creator | string | 创建者open_id |
| create_user_name | string | 创建者用户名 |
| delete_flag | integer | 删除标志,0表示正常访问未删除,1表示在回收站,2表示已经彻底删除 |
| edit_time | integer | 最后编辑时间戳 |
| edit_user_name | string | 最后编辑者用户名 |
| is_external | bool | 是否外部文档 |
| is_pined | bool | 是否在接口调用者目录里快速访问 |
| is_stared | bool | 是否在接口调用者目录里收藏 |
| is_upgraded | bool | 文档是否被升级为新版文档 新旧文档的差异详见:新旧版本说明 如何接入新版文档详见:文档概述 默认值: false |
| obj_type | string | 文档类型,固定是doc |
| owner | string | 当前所有者open_id |
| owner_user_name | string | 当前所有者用户名 |
| server_time | integer | 处理请求时的服务器时间戳 |
| tenant_id | string | 文档所在租户id |
| title | string | 文档名称 |
| type | integer | 文档类型,固定是2 |
| upgraded_token | string | 升级后的文档 token,对应新版文档接口中的 document_id示例值: AcJ3d2QM1onnE4xjcZAcP7abcef |
| url | string | 文档url |
响应体示例
json
{
"code": 0,
"msg": "Success",
"data": {
"create_date": "20240808",
"create_time": 1723088043,
"creator": "ou_f700228a5386f25bc0e61135066abcef",
"create_user_name": "ZhangSan",
"delete_flag": 0,
"edit_time": 1723088073,
"edit_user_name": "ZhangSan",
"is_external": false,
"is_pined": false,
"is_stared": false,
"is_upgraded": true,
"obj_type": "doc",
"owner": "ou_f700228a5386f25bc0e61135066abcef",
"owner_user_name": "ZhangSan",
"server_time": 1723089073,
"tenant_id": "42",
"title": "项目管理",
"type": 2,
"upgraded_token": "AcJ3d2QM1onnE4xjcZAcP7abcef",
"url": "https://example.feishu.cn/docs/doccnilYPZU5b34ow4ca7aabcef"
}
}错误码
| 错误码 | 说明 | 排查建议 |
|---|---|---|
| 91401 | PARAMERR | 参数出现错误,检查参数有效性 |
| 91402 | NOTEXIST | 未找到,检查token是否有效 |
| 91403 | FORBIDDEN | 没有权限,检查是否有文档读权限 |
| 91404 | LOGIN_REQUIRED | 需要登录 |
| 95001 | internal error | 内部错误,请稍后重试 |
| 95003 | internal error | 内部错误,请稍后重试 |
| 95005 | internal error | 内部错误,请稍后重试 |
| 95006 | Failed | 文档未找到,检查token是否有效 |
| 95007 | Failed | 文档已删除,已删除文件无法获取文档meta信息 |
| 95008 | FORBIDDEN | 检查用户对文档、文件夹的权限 |
| 95009 | Failed | 没有权限,检查是否有文档读权限。添加文档权限 |
| 95010 | internal error | 内部错误,请稍后重试 |
| 95011 | internal error | 内部错误,请稍后重试 |
| 95017 | 具体错误信息 | 读取文档内容失败,检查revison是否正确 |
| 95018 | 具体错误信息 | 解析文档内容失败,详见具体错误信息 |
| 95023 | revision too old | 版本号太老,请使用最新版本号 |
| 95024 | Failed | 参数无效,检查参数有效性 |
| 95053 | this API does not support the Upgraded Docs(docx), please refer to the https://feishu.feishu.cn/docx/ICI7dp1Uioh4EvxXn0HcxUapn0c using the correct API. | 此 API 不支持新版文档(docx),请参考新版文档概述使用正确的 API。 |
具体可参考:服务端错误码说明
