查询导出任务结果

根据创建导出任务返回的导出任务 ID（ticket）轮询导出任务结果，并返回导出文件的 token。你可使用该 token 继续调用下载导出文件接口将导出的产物下载到本地。了解完整的导出文件步骤，参考导出飞书云文档概述。

注意事项

调用该接口的用户或应用需与调用创建导出任务接口的用户或应用保持一致。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/drive/v1/export_tasks/:ticket
HTTP Method	GET
接口频率限制	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

路径参数

名称	类型	描述
ticket	string	导出任务 ID。调用创建导出任务 获取。 示例值："6933093124755412345"

查询参数

名称	类型	必填	描述
token	string	是	要导出的云文档的 token。获取方式参考如何获取云文档相关 token。你可参考以下请求示例了解如何使用查询参数。 示例值：docbcZVGtv1papC6jAVGiyabcef 数据校验规则： - 最大长度：27 字符

请求示例

curl --location --request GET 'https://open.feishu.cn/open-apis/drive/v1/export_tasks/7143131813848809492?token=docbcZVGtv1papC6jAVGiyabcef' \
--header 'Authorization: Bearer t-g1029efgIY34MWD1L4CEYQOVN5TZF2OMPJXTDVOP'

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ result	export_task	导出任务结果
└ file_extension	string	导出的文件的扩展名 可选值有： - docx: Microsoft Word 格式 - pdf: PDF 格式 - xlsx: Microsoft Excel (XLSX) 格式 - csv: CSV 格式
└ type	string	要导出的云文档的类型。可通过云文档的链接判断。 可选值有： - doc: 旧版飞书文档。支持导出扩展名为 docx 和 pdf 的文件。已不推荐使用。 - sheet: 飞书电子表格。支持导出扩展名为 xlsx 和 csv 的文件 - bitable: 飞书多维表格。支持导出扩展名为 xlsx 和 csv 格式的文件 - docx: 新版飞书文档。支持导出扩展名为 docx 和 pdf 格式的文件
└ file_name	string	导出的文件名称
└ file_token	string	导出的文件的 token。可用于调用下载导出文件接口将导出的产物下载到本地。
└ file_size	int	导出文件的大小，单位字节。
└ job_error_msg	string	导出任务失败的原因
└ job_status	int	导出任务状态 可选值有： - 0: 成功 - 1: 初始化 - 2: 处理中 - 3: 内部错误 - 107: 导出文档过大 - 108: 处理超时 - 109: 导出内容块无权限 - 110: 无权限 - 111: 导出文档已删除 - 122: 创建副本中禁止导出 - 123: 导出文档不存在 - 6000: 导出文档图片过多

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "result": {
            "file_extension": "pdf",
            "type": "doc",
            "file_name": "docName",
            "file_token": "boxcnxe5OdjlAkNgSNdsJvabcef",
            "file_size": 34356,
            "job_error_msg": "success",
            "job_status": 0
        }
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	1069901	internal error	服务内部错误，请联系技术支持
403	1069902	no permission	当前访问身份没有文档阅读或编辑权限。请参考以下方式解决： - 如果你使用的是 tenant_access_token，意味着当前应用没有文档阅读或编辑权限。你需通过云文档网页页面右上方 「...」 -> 「...更多」 ->「添加文档应用」 入口为应用添加文档权限。 - 如果你使用的是 user_access_token，意味着当前用户没有文档阅读或编辑权限。你需通过云文档网页页面右上方 分享 入口为当前用户添加文档权限。 了解具体操作步骤或其它添加权限方式，参考云文档常见问题 3。
400	1069904	invalid param	无效参数，导出 csv 是否传入 sub_id
410	1069906	docs deleted	文档已被删除

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