创建导出任务

POST

https://open.feishu.cn/open-apis/drive/v1/export_tasks

创建导出任务，将云文件导出为指定格式的本地文件。该接口为异步接口，需要通过轮询查询导出任务结果接口获取任务结果。

请求用户需要对该文档有导出权限

错误码

HTTP状态码	错误码	描述	排查建议
500	1069901	internal error	服务内部错误，详询 Oncall
403	1069902	no permission	无阅读或导出权限
400	1069904	invalid param	无效参数，导出 csv 是否传入 sub_id
410	1069906	docs deleted	文档已被删除
404	1069914	invalid file token	导出文档 token 不合法
400	1069918	file extension andtype mismatch	导出文件类型与云文档类型不匹配

其他错误码可参考：服务端错误码说明

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://open.feishu.cn/open-apis/drive/v1/export_tasks' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "file_extension": "pdf",
    "token": "doccnxe5OxxxxxxxSNdsJviENsk",
    "type": "doc"
}'

响应示例

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

请求参数

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

Body 参数application/json

file_extension

string

必需

导出文件扩展名示例值："pdf" 可选值有： docx：Microsoft Word (DOCX) 格式 pdf：pdf 格式 xlsx：Microsoft Excel (XLSX) 格式 csv：csv 格式

token

string

必需

导出文档 token 获取文档 token 示例值："doccnxe5OxxxxxxxSNdsJviENsk"

type

string

必需

导出文档类型文档类型说明示例值："doc" 可选值有： doc：旧版飞书云文档类型，支持导出为 docx、pdf 格式 sheet：飞书电子表格类型，支持导出为 xlsx、csv 格式 bitable：飞书多维表格类型，支持导出为 xlsx、csv 格式 docx：新版飞书云文档类型，支持导出为 docx、pdf 格式

sub_id

string

可选

导出子表ID，仅当将电子表格/多维表格导出为 csv 时使用获取电子表格子表ID 文档中的 sheet_id 获取多维表格子表ID 文档中的 table_id 示例值："tblKz5D60T4JlfcT"

示例

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

ticket

string

导出任务ID

必需

修改于 2023-01-13 06:26:42

导出文件指南

查询导出任务结果

创建导出任务

错误码#

请求参数

返回响应

错误码