导出文档
... 2022-7-27 大约 3 分钟
# 导出文档
- 每用户每天仅限调用9次
# 接口说明
本接口用于异步导出文档。
文档导出操作比较耗时,因此采用异步方案导出文档,执行操作后会获得一个查询凭证 operationID ,返回凭证的 20分钟 内可以使用该凭证查询导出进度。
- 导出接口每用户每天仅限调用9次
支持的文档导出类型
| 文档类型 | 可导出的文档类型 |
|---|---|
| doc | doc, pdf |
| sheet | sheet |
| slide | slide, pdf |
| smartcanvas | doc, pdf |
# 权限说明
本接口需要拥有以下任意一项权限:
scope.drive.exportable
# 请求格式
| 描述 | 定义 |
|---|---|
| Path | /openapi/drive/v2/files/{fileID}/async-export |
| Method | POST |
| Content-Type | application/x-www-form-urlencoded |
| Accept | application/json |
# 请求头部
详见Headers。
# 请求参数
# 路径参数
| 参数名 | 类型 | 必选 | 描述 |
|---|---|---|---|
| fileID | string | 是 | 文档唯一标识,详见fileID |
# 查询参数
无
# 请求体
| 参数名 | 类型 | 必选 | 描述 |
|---|---|---|---|
| exportType | string | 否 | 支持导出为其他类型文档,目前仅支持 doc、slide 转换为 pdf。不填时默认为不转换类型,导出为原本类型的文档。 |
# 响应参数
# 响应体
| 参数名 | 类型 | 描述 |
|---|---|---|
| ret | integer | 业务返回码 |
| msg | string | 业务返回码描述 |
| data.operationID | string | 操作 ID |
# 请求包体
POST /openapi/drive/v2/files/300000000$AAAAAAAAAAAA/async-export HTTP/1.1
Host: docs.qq.com
Access-Token: ACCESS_TOKEN
Client-Id: CLIENT_ID
Open-Id: OPEN_ID
Content-Type: application/x-www-form-urlencoded
Content-Length: 14
exportType=pdf
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
# 示例
curl --location --request POST 'https://docs.qq.com/openapi/drive/v2/files/300000000$AAAAAAAAAAAA/async-export' \
--header 'Access-Token: ACCESS_TOKEN' \
--header 'Client-Id: CLIENT_ID' \
--header 'Open-Id: OPEN_ID' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'exportType=pdf'
1
2
3
4
5
6
2
3
4
5
6
1
2
3
4
5
6
2
3
4
5
6
# 响应包体
HTTP/1.1 200 OK
Date: Thu, 28 Jul 2022 15:34:46 GMT
Content-Type: text/plain; charset=utf-8
Content-Length: 3
Connection: keep-alive
{'ret': 0, 'msg': 'Succeed', 'data': {'operationID': 'OPERATION_ID'}}
1
2
3
4
5
6
7
2
3
4
5
6
7
1
2
3
4
5
6
7
2
3
4
5
6
7
# 错误码
| 错误码 | 错误说明 | 排查建议 |
|---|---|---|
| 10313 | Access-Token 为空 | HTTP Header 里 Access-Token 校验失败,请参考示例中的携带方式,检查相应字段。详情请见Headers。 |
| 10303 | Open-Id 错误 | HTTP Header 里 Open-Id 与预期不符,可能的原因有:- Open-Id 为空。请参考示例中的携带方式,检查相应字段。详情请见Headers。- Open-Id 与 Access-Token 不匹配,请检查 Header 内容和获取 Token 接口回包是否一致。 |
| 10302 | Client-Id 错误 | HTTP Header 里 Client-Id 与预期不符,可能的原因有:- Client-Id 为空。请参考示例中的携带方式,检查相应字段。详情请见Headers。- Client-Id 与 Access-Token 不匹配,请检查 Header 内容和调用获取 Token 接口接口时参数中的 Client-Id 是否一致。 |
| 37019 | Token 校验失败,错误或过期 | 检查位于 HTTP Header 中的 Access-Token 是否正确,获取 Token 的方式请查阅授权流程以及获取 Token 接口 |