创建导入任务

该接口用于创建导入文件的任务，并返回导入任务 ID。导入文件指将本地文件如 Word、TXT、Markdown、Excel 等格式的文件导入为某种格式的飞书在线云文档。该接口为异步接口，需要继续调用查询导入任务结果接口获取导入结果。了解完整的导入文件步骤，参考导入文件概述。

前提条件

创建导入任务前，你需先调用上传素材或上传文件接口获取源文件的 token。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/drive/v1/import_tasks
HTTP Method	POST
接口频率限制	100 次/分钟
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	docs:document:import 查看、创建云文档导入任务 drive:drive 查看、评论、编辑和管理云空间中所有文件

请求头

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

请求体

名称	类型	必填	描述
file_extension	string	是	要导入的文件的扩展名。了解支持的文件格式，参考导入文件概述。 注意：此处填写的文件扩展名需与实际文件的后缀名保持严格一致。请注意区分后缀为 “markdown”、“md”、“mark” 的 Markdown 文件，并在填写相关参数时保持后缀名一致。否则将返回 1069910 错误码。 示例值："xlsx"
file_token	string	是	要导入文件的 token。创建任务前，你需先调用上传素材或上传文件接口获取源文件的 token。了解更多，参考导入文件概述。 示例值："boxcnrHpsg1QDqXAAAyachabcef" 数据校验规则： - 最大长度：27 字符
type	string	是	目标云文档格式。不同文件支持的云文档格式不同。详情参考导入文件概述。可选值如下所示： - docx：新版文档 - sheet：电子表格 - bitable：多维表格 示例值："sheet"
file_name	string	否	导入后的在线云文档名称。参数为空时，使用上传本地文件时的文件名。 示例值："销售表"
point	import_task_mount_point	是	挂载点（导入后的云文档所在位置）
└ mount_type	int	是	挂载类型。取固定值 1，表示将该云文档挂载至云空间下。 示例值：1 可选值有： - 1: 挂载到云空间
└ mount_key	string	是	云文档挂载的文件夹的 token，即云空间下文件夹的 token。空表示云空间根目录。了解如何获取文件夹 token，参考文件夹概述。 示例值："AbqrfuRTjlJEIJduwDwcnIabcef"

请求体示例

{
    "file_extension": "xlsx",
    "file_token": "boxcnrHpsg1QDqXAAAyachabcef",
    "type": "sheet",
    "file_name": "销售表",
    "point": {
        "mount_type": 1,
        "mount_key": "AbqrfuRTjlJEIJduwDwcnIabcef"
    }
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ ticket	string	导入任务 ID

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "ticket": "7369583175086912356"
    }
}

错误码

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。
429	1069923	too many requests	请求发生限频，请降低请求频率并稍后重试