格式转换
💡 调用API,需要认证。认证参考【接口认证】
POST {apiPrefix}/convert
提交转换任务
- 任务添加失败,同步返回失败原因
- 任务添加成功,同步返回任务ID。第三方可以配置任务回调通知获取任务状态。
请求体
Content-Type为application/json
| 参数名 | 类型 | 说明 | 是否必须 |
|---|---|---|---|
| fileUrl | string | 文件下载地址 | 是 |
| filename | string | 包含后缀的文件名 | 是 |
| targetFilename | string | 包含后缀的目标文件名 | 是 |
| tokenType | string | 三方token类型,值为cookie或者header | 否 |
| tokenValue | string | 三方token值,zOffice下载文件或回调通知时回传 | 否 |
| callback | string | 回调地址。任务转换结束后zOffice回调通知状态 | 是 |
| uniqueId | string | 文件内容唯一标识 | 否 |
| tiledWatermark | TiledWatermark | 平铺⽔印配置。⽬前仅⽀持doc/docx/wps/dot/wpt/dotx/docm/dotm/ppt/pps/dps/pot/pptx/pptm/potx /ppsx/ppsm/potm导出为pdf时有效,仅支持文字水印 | 否 |
| msPicWatermark | MsPicWatermark | 位置图片水印 ⽬前仅⽀持docx/wps/doc导出为pdf时有效 | 否 |
| excel2pdfOptions | Excel2PdfOptions | 表格转PDF选项。仅在xls/xlsx/et导出为PDF时有效 | 否 |
| toPicOptions | toPicOptions | pdf/word转图片选项。仅在pdf/word导出为图片时有效 | 否 |
- fileUrl/tokenType/tokenValue/callback说明见本文档【通用字段说明】
- pdf导出为图片时,如果拼接长图下载返回的文件为图片类型,如果不拼接长图下载返回的文件为zip的格式的压缩包
转换类型支持及限制
| 源文件类型 | 目标文件类型 | 限制 |
|---|---|---|
| doc/docx/wps/dot/wpt/dotx/docm/dotm | 源文件最大300M,docx格式600M。最多1000页 | |
| xls/xlsx/et/ett/xlt/xltx/xlsm/xltm/xlsb | 源文件最大300M,xlsx格式600M。最多导出200页 | |
| jpg/jpeg/png/bmp | 源文件最大200M,总页数最大50页 | |
| ppt/pps/dps/pot/pptx/pptm/potx/ppsx/ppsm/potm | 源文件最大50M | |
| doc/docx/wps/dot/wpt/dotx/docm/dotm | ofd | 源文件最大50M,总页数最大100页 |
| doc/docx/wps/dot/wpt/dotx/docm/dotm | jpg/jpeg/png | 源文件最大300M,docx格式600M。最多1000页 |
| ofd | 源文件最大50M,总页数最大100页 | |
| ofd | 源文件最大50M | |
| html | pdf/docx | 源文件最大5M |
正常返回:
{
"taskId": "6f6598c8-c87e-420b-b6c4-6f1b187201dc",
"code": "Ok",
"detail": {
"taskStatus": "IN_QUEUE"
}
}
错误返回:
{
"taskId": "695fbf6e-90d2-42ba-83d5-00e81e5e366e",
"code": "TaskQueueCongestion",
"detail": {
"taskStatus": "FAIL"
}
}