异步导入文档
... 2022-7-27 大约 2 分钟
# 异步导入文档
# 接口说明
本接口用来文档异步导入，在使用腾讯云 COS (opens new window)上传文档成功后调用。
注意：导入是个耗时的异步行为，需要通过进度查询接口查询导入进度。
# 权限说明
本接口需要拥有以下任意一项权限：
scope.drive.creatable
# 请求格式
| 描述 | 定义 |
|---|---|
| Path | /openapi/drive/v2/files/async-import |
| Method | POST |
| Content-Type | application/x-www-form-urlencoded |
| Accept | application/json |
# 请求头部
详见Headers
# 请求参数
# 路径参数
无
# 查询参数
无
# 请求体
| 参数名 | 类型 | 必选 | 描述 |
|---|---|---|---|
| fileMD5 | string | 是 | 文档的 MD5 值 |
| fileName | string | 是 | 文件名 |
| parentfolderID | string | 否 | 目标文件夹，默认为根文件夹 |
| filePassword | string | 否 | 如果是加密文档，需要提供文档密码 |
| COSFileKey | string | 是 | 调用 upload-url 返回的 COSFileKey |
# 响应参数
# 请求体
| 参数名 | 类型 | 描述 |
|---|---|---|
| ret | integer | 业务返回码 |
| msg | string | 业务返回码描述 |
| data.progressQueryID | string | 进度查询凭证，后续可以使用来查询导入进度 , 有效期为 10 分钟 |
# 请求包体
POST /openapi/drive/v2/files/async-import 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: 92
fileMD5=FILE_MD5&fileName=FILENAME.pdf&COSFileKey=data/cfs/import/pdf/example/COSFILEKEY.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/async-import' \
--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 'fileMD5=FILE_MD5' \
--data-urlencode 'fileName=FILENAME.pdf' \
--data-urlencode 'COSFileKey=data/cfs/import/pdf/example/COSFILEKEY.pdf' \
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
# 响应包体
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': {'progressQueryID': 'PROGRESS_QUERY'}}
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 接口 |