创建导出任务
该接口用于创建导出文件的任务，并返回导出任务 ID。导出文件指将飞书文档、电子表格、多维表格导出为本地文件，包括 Word、Excel、PDF、CSV 格式。该接口为异步接口，需要继续调用查询导出任务结果接口获取导出结果。了解完整的导出步骤，参考导出云文档概述。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/drive/v1/export_tasks |
| HTTP Method | POST |
| 接口频率限制 | 100 次/分钟 |
| 支持的应用类型 | custom |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | docs:document:export 导出云文档 drive:export:readonly 导出云文档 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| 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 | 是 | 将云文档导出为本地文件后，本地文件的扩展名。了解各类云文档支持导出的文件格式，参考导出云文档概述。 示例值："csv" 可选值有： - docx: Microsoft Word 格式 - pdf: PDF 格式 - xlsx: Microsoft Excel 格式 - csv: CSV 格式 |
token | string | 是 | 要导出的云文档的 token。获取方式参考 如何获取云文档相关 token。 示例值："Fm7osyjtMh5o7Ktrv32c73abcef" 数据校验规则： - 最大长度： 27 字符 |
type | string | 是 | 要导出的云文档的类型 。可通过云文档的链接判断。 示例值："sheet" 可选值有： - doc: 旧版飞书文档。支持导出扩展名为 docx 和 pdf 的文件。已不推荐使用。 - sheet: 飞书电子表格。支持导出扩展名为 xlsx 和 csv 的文件。 - bitable: 飞书多维表格。支持导出扩展名为 xlsx 和 csv 格式的文件。 - docx: 新版飞书文档。支持导出扩展名为 docx 和 pdf 格式的文件。 |
sub_id | string | 否 | 导出飞书电子表格或多维表格为 CSV 文件时，需传入电子表格工作表的 ID 或多维表格数据表的 ID： - 电子表格可调用获取工作表 接口获取返回的 sheet_id 的值作为该参数的值 - 多维表格可调用列出数据表接口获取返回的 table_id 的值作为该参数的值示例值："6e5ed3" |
请求体示例
json
{
"file_extension": "csv",
"token": "Fm7osyjtMh5o7Ktrv32c73abcef",
"type": "sheet",
"sub_id": "6e5ed3"
}响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码，非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ ticket | string | 导出任务的 ID |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"ticket": "6933093124755423251"
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 500 | 1069901 | internal error | 服务内部错误。请联系技术支持 |
| 403 | 1069902 | no permission | 当前访问身份没有文档阅读或编辑权限。请参考以下方式解决： - 如果你使用的是 tenant_access_token，意味着当前应用没有文档阅读或编辑权限。你需通过云文档网页页面右上方 「...」 -> 「...更多」 ->「添加文档应用」 入口为应用添加文档权限。 - 如果你使用的是 user_access_token，意味着当前用户没有文档阅读或编辑权限。你需通过云文档网页页面右上方 分享 入口为当前用户添加文档权限。 了解具体操作步骤或其它添加权限方式，参考云文档常见问题 3。 |
| 400 | 1069904 | invalid param | 无效参数。请检查导出 CSV 文件时是否传入电子表格中工作表的 ID |
| 404 | 1069906 | docs deleted | 文档已被删除 |
| 404 | 1069914 | invalid file token | 导出文档 token 不合法。参考云文档常见问题了解如何获取文档 token。 |
| 400 | 1069918 | file extension and type mismatch | 导出文件类型与云文档类型不匹配 |
| 429 | 1069923 | too many requests | 请求发生限频，请降低请求频率并稍后重试 |
| 列1 | 列2 | 列3 | 列4 |
|---|---|---|---|
| 200 | 600 | hybrid resource expired | 混合部署数据已转移到私有化机房，请稍后重试 |
其他错误码可参考：服务端错误码说明