查询导入结果
根据创建导入任务返回的导入任务 ID(ticket)轮询导入结果。了解完整的导入文件步骤,参考导入文件概述。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/drive/v1/import_tasks/:ticket |
| HTTP Method | GET |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | docs:document:import 查看、创建云文档导入任务 drive:drive 查看、评论、编辑和管理云空间中所有文件 drive:drive:readonly 查看、评论和下载云空间中所有文件 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
路径参数
| 名称 | 类型 | 描述 |
|---|---|---|
ticket | string | 导入任务 ID。调用创建导入任务 获取 示例值:"7369583175086912356" |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ result | import_task | 导入结果 |
└ ticket | string | 导入任务 ID |
└ type | string | 导入的在线云文档类型 |
└ job_status | int | 任务的状态 可选值有: - 0: 导入成功。但需关注是否有 extra 参数返回。如果源文件内容超过系统上限,将被系统截断,此时将返回 extra 参数,进行额外提示。extra 参数说明见本文末尾。 - 1: 初始化 - 2: 处理中 - 3: 内部错误 - 100: 导入文档已加密 - 101: 内部错误 - 102: 内部错误 - 103: 内部错误 - 104: 租户容量不足 - 105: 文件夹节点太多 - 106: 内部错误 - 108: 处理超时 - 109: 内部错误 - 110: 无权限 - 112: 格式不支持 - 113: office格式不支持 - 114: 内部错误 - 115: 导入文件过大 - 116: 当前身份无导入至该文件夹的权限。参考开通文件夹权限解决 - 117: 目录已删除 - 118: 导入文件和任务指定后缀不匹配 - 119: 目录不存在 - 120: 导入文件和任务指定文件类型不匹配 - 121: 导入文件已过期 - 122: 创建副本中禁止导出 - 129: 文件格式损坏。请另存为新文件后导入 - 5000: 内部错误 - 7000: docx block 数量超过系统上限 - 7001: docx block 层级超过系统上线 - 7002: docx block 大小超过系统上限 |
└ job_error_msg | string | 任务失败的原因 |
└ token | string | 导入云文档的 token |
└ url | string | 导入云文档的 URL |
└ extra | string\[\] | 导入成功的额外提示。详情参考下文。 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"result": {
"ticket": "7369583175086912356",
"type": "sheet",
"job_status": 0,
"job_error_msg": "success",
"token": "Fm7osyjtMh5o7Ktrv32c73abcef",
"url": "https://example.feishu.cn/sheets/Fm7osyjtMh5o7Ktrv32c73abcef",
"extra": [
"2000"
]
}
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 1069901 | internal error | 服务内部错误,请联系技术支持 |
| 403 | 1069902 | no permission | 当前访问身份没有文档阅读或编辑权限。请参考以下方式解决: - 如果你使用的是 tenant_access_token,意味着当前应用没有文档阅读或编辑权限。你需通过云文档网页页面右上方 「...」 -> 「...更多」 ->「添加文档应用」 入口为应用添加文档权限。 - 如果你使用的是 user_access_token,意味着当前用户没有文档阅读或编辑权限。你需通过云文档网页页面右上方 分享 入口为当前用户添加文档权限。 了解具体操作步骤或其它添加权限方式,参考云文档常见问题 3。 |
| 500 | 1069903 | internal error | 服务内部错误,请联系技术支持 |
| 400 | 1069904 | invalid param | 无效参数。请检查文件扩展名参数 file_extension 与导入的文件的扩展名是否一致 |
| 500 | 1069905 | internal error | 服务内部错误,请联系技术支持 |
| 403 | 1069906 | docs deleted | 文档已被删除。请检查 |
| 404 | 1069907 | file token not found | 文件 token 不存在。请检查要导入文件的 token 是否正确 |
| 403 | 1069908 | mount point not found or no permission | 挂载点对应的文件夹不存在,或当前身份无导入至该文件夹的权限。请参考以下步骤解决: 1. 检查文件夹的 token 是否填写正确 2. 检查当前身份是否有导入至文件夹的权限: - 如果你使用的是 tenant_access_token,意味着应用没有导入至当前文件夹的权限。你需要为该应用添加机器人能力,并将该文件夹分享给含有该机器人的群组,为该应用开通文件夹的编辑权限。 - 如果你使用的是 user_access_token,意味着用户没有导入至当前文件夹的权限。你需将该文件夹分享给该用户身份,为用户开通文件夹的编辑权限。 了解具体操作步骤,参考开通文件夹权限。 |
| 400 | 1069909 | import file size over limit | 文件超过 20 MB 限制,无法导入 |
| 400 | 1069910 | import file extension not match | 上传文件和导入任务文件后缀不一致,请检查 |
| 400 | 1069911 | import file type not match | 上传文件和导入任务指定的文件类型不一致,请检查 |
| 400 | 1069912 | folder not exist | 目录不存在 |
| 400 | 1069913 | import file token expired | 上传文件过期,有效期 5 分钟 |
| 400 | 1069914 | invalid file token | 导出文档 token 不合法。参考云文档常见问题了解如何获取文档 token。 |
extra 额外信息提示
如果源文件内容超过系统上限,将被系统截断,此时将返回 extra 参数,进行额外提示。
| 提示码 | 说明 |
|---|---|
| 1000 | 导入内容块数量超出新版文档最大限制(上限 2 万个),超出的部分将被截断丢弃。 |
| 1001 | 导入表格单元格数量超出新版文档最大限制(上限 2000 个),超出的部分将被截断丢弃。 |
| 1002 | 导入表格列数超出新版文档最大限制(上限 100 列),超出的部分将被截断丢弃。 |
| 1003 | 导入单段文本字数超出新版文档最大限制(上限 10 万个 UTF-16 字符),超出的部分将被截断丢弃。 |
| 1005 | 文档部分图片上传失败。 |
| 2000 | 表格列数超过最大限制,超出的部分将被截断丢弃。 |
| 2001 | 表格单元格数超过最大限制,超出的部分将被截断丢弃。 |
| 2002 | 表格图片超过 4000 张,超出的图片被丢弃。 |
| 2003 | 云空间存储空间不足,请联系企业管理员。 |
| 2004 | 表格部分图片上传失败。 |
| 2005 | 表格单元格字符长度超过最大限制,超出的部分将被截断丢弃。 |
| 3000 | 多维表格图片超出数据行区域会丢弃。 |
| 3001 | 多维表格图片超出数据列区域会丢弃。 |
| 3003 | 多维表格列数超过最大限制,超出的部分将被截断丢弃。 |
| 3004 | 多维表格单元格数超过最大限制,超出的部分将被截断丢弃。 |
| 3005 | 多维表格图片超过 4000 张,超出的图片被丢弃。 |
| 3006 | 多维表格部分图片上传失败。 |
