导出云文档概述
导出云文档指将飞书文档、电子表格、多维表格导出为本地文件,包括 Word、Excel、PDF、CSV 格式。本文档介绍导出云文档的完整步骤。
注意事项
你需及时下载导出的文件。在导出任务结束 10 分钟后,导出的文件将被删除,导致无法下载。
启用水印说明
当企业内部启用水印时:
- 使用应用身份(tenant_access_token)进行导出,将会使用应用 ID 作为水印,比如
cli_a2c2xxxxxxxxd01b; - 使用用户身份(user_access_token)进行导出,将会使用用户标识作为水印。
支持导出的文件类型
OpenAPI 支持将以下飞书云文档导出为以下文件类型。
| 飞书云文档 | 支持导出的文件类型 |
|---|---|
| - 新版在线文档(docx) - 旧版在线文档(doc)(历史版本,已不推荐使用) | - 扩展名为 docx 的 Microsoft Word 文档 > Tip: 导出为 Microsoft Word 文档时,文档内资源大小总计不可超过 1 GB,否则将导出失败。 - 扩展名为 pdf 的文件 > Tip: 导出为 PDF 文件时,文档内资源大小总计不可超过 128 MB,否则将导出失败。 |
| - 多维表格 - 电子表格 | - 扩展名为 xlsx 的 Microsoft Excel 表格 - 扩展名为 csv 的文件 |
导出步骤
步骤一:创建导出任务
调用创建导出任务接口,创建导出云文档的任务并获取导出 ID。
Tip: 如果要导出类型为知识库(
wiki)的文档,你需要先通过获取知识空间节点信息得到节点对应的obj_token(文档 Token)和obj_type(文档类型),然后再创建导出任务。
步骤二:查询导出任务结果
调用查询导出任务结果接口,根据步骤一返回的导出任务 ID(ticket)获取导出结果和导出文件信息。
步骤三:下载导出文件
调用下载导出文件接口,根据步骤二返回的导出文件的 token 下载导出文件。
Warning: 你需及时下载导出的文件。在导出任务结束 10 分钟后,导出的文件将被删除,导致无法下载。
