文档合并
💡 调用API,需要认证。认证参考【接口认证】
POST {apiPrefix}/merge
提交文档合并任务
- 任务添加失败,同步返回失败原因
- 任务添加成功,同步返回任务ID。第三方可以配置任务回调通知获取任务状态。
请求体:
Content-Type为application/json
| 参数名 | 类型 | 说明 | 是否必须 |
|---|---|---|---|
| callback | string | 回调地址。任务结束后zOffice回调通知状态 | 是 |
| tokenType | string | 三方token类型,值为cookie或者header | 否 |
| tokenValue | string | 三方token值,zOffice下载文件或回调通知时回传 | 否 |
| fileList | array | 待合并的文件信息列表(文件信息见下方表格,长度在1~10之间(包含)) | 是 |
文件信息:
| 参数名 | 类型 | 说明 | 是否必须 |
|---|---|---|---|
| downloadUrl | string | 文件下载链接 | 是 |
| filename | string | 包含后缀的文件名(支持文字(doc,docx,wps)和版式(pdf),必须相同类型) | 是 |
| start | number | 待合并的文档起始页码(包含),从1开始。默认1。必须大于等于1 。仅pdf文件支持。 | 否 |
| end | number | 待合并的文档结束页码(包含),从1开始。默认最后一页。必须大于等于1。仅pdf文件支持。 | 否 |
- downloadUrl(同fileUrl)/tokenType/tokenValue/callback说明见本文档【通用字段说明】
- 版式文件单个大小不能超过200m,总大小不能超过400m。文字文件单个大小不能超过200m,总大小不能超过300m。
正常返回:
{
"taskId": "6f6598c8-c87e-420b-b6c4-6f1b187201dc",
"code": "Ok",
"detail": {
"taskStatus": "IN_QUEUE"
}
}
错误返回:
{
"taskId": "695fbf6e-90d2-42ba-83d5-00e81e5e366e",
"code": "TaskQueueCongestion",
"detail": {
"taskStatus": "FAIL"
}
}