导出进度查询
... 2022-7-27 大约 2 分钟
# 导出进度查询
# 接口说明
本接口用于查询异步导出文档进度,如果导出成功会返回导出文档的可下载链接,下载链接30分钟内有效。
# 权限说明
本接口需要拥有以下任意一项权限:
scope.drive.exportable
# 请求格式
| 描述 | 定义 |
|---|---|
| Path | /openapi/drive/v2/files/{fileID}/export-progress |
| Method | GET |
| Accept | application/json |
# 请求头部
详见Headers。
# 请求参数
# 路径参数
# 响应参数
# 响应体
| 参数名 | 类型 | 描述 |
|---|---|---|
| ret | integer | 业务返回码 |
| msg | string | 业务返回码描述 |
| data.url | string | 文档下载临时链接,有效期为 24 小时,导出成功时返回 |
| data.progress | integer | 导出进度,取值[0, 100] |
# 请求包体
GET /openapi/drive/v2/files/300000000$AAAAAAAAAAAA/export-progress HTTP/1.1
Host: docs.qq.com
Access-Token: ACCESS_TOKEN
Client-Id: CLIENT_ID
Open-Id: OPEN_ID
Content-Length: 0
1
2
3
4
5
6
2
3
4
5
6
1
2
3
4
5
6
2
3
4
5
6
# 示例
curl --location --request GET 'https://docs.qq.com/openapi/drive/v2/files/300000000$AAAAAAAAAAAA/export-progress
?operationID=OPERATION_ID' \
--header 'Access-Token: ACCESS_TOKEN' \
--header 'Client-Id: CLIENT_ID' \
--header 'Open-Id: OPEN_ID' \
1
2
3
4
5
2
3
4
5
1
2
3
4
5
2
3
4
5
# 响应包体
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': {'url': 'https://download.com/url', 'progress': 100}}
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 接口 |