转为文档结果查询

查询PDF、图片转为文档格式的转换结果

请求说明

请求地址	/v7/developer/weboffice/tasks/convert/to/:office_type/:task_id
请求方法	GE
权限要求	查询和管理格式转换 kso.format_conversion.readwrite

参数	必须	类型	说明
Content-Type	是	string	目前固定为: `application/json`
Authorization	是	string	授权凭证，格式为：`Bearer {access_token}`

Path 参数

参数	必须	类型	说明
office_type	是	string	转换为的文件类型：`docx`,`xlsx`,`pptx`,`json`
task_id	是	string	格式转换任务 id，有效期1个小时，请及时保存转换结果

返回参数

参数	必须	类型	说明
code	是	integer	错误码
data	是	data {}	响应数据
├ status		string	转换任务状态， 1：结束 2：运行中 3：被中断 4：发生错误 5：阻塞中，还在队列里
├ progress		int	转换任务进度
├ errMsgs		string	转换任务失败原因
├ duration		int	转换耗时，单位秒
├ download_url		string	已转换完成的下载地址
├ start_time		int	开始转换的时间戳
├ page_count		int	已转换的页数

示例

请求示例

httpsnippet

{"method":"GET","url":"https://openapi.wps.cn/v7/developer/weboffice/tasks/convert/to/pptx/0f27ff302780428e9ddfd39189731891","headers":{"Content-Type":"application/json","Authorization":"Bearer ejxxx"}}

返回示例

json

{
    "code": 0,
    "data": {
        "status": 1,
        "duration": 4.074,
        "download_url": "http://zhai-platereduction.ks3-cn-beijing.ksyun.com/tmp/layout_test/pdfwriter/tmp/2023-10-23/0f27ff302780428e9ddfd39189731891.docx?Expires=1698633007&AWSAccessKeyId=AKLTvraLpUToTR6_PmBcKXIRCw&Signature=y9UFdStk19xj7E7fM1JkHvrvmBA%3D",
        "task_id": "0f27ff302780428e9ddfd39189731891",
        "progress": 100,
        "start_time": 1698028203329,
        "page_count": 3,
        "errMsgs": null
    }
}

说明

转换状态 status为1和progress为100时，表示转换完成，才会返回download_url。

本查询接口需要轮询，可根据progress的进度进行相关业务提示，并间隔一定时间再次查询，直到终止状态。

错误码

请参考错误码说明