查询任务状态
💡 调用API,需要认证。认证参考【接口认证】
GET {apiPrefix}/queryTaskStatus
根据任务id查询任务的执行状态
- 任务执行失败,同步返回失败原因
- 任务执行成功,同步返回任务ID,以及文件名及下载地址等。
- 除了成功与失败,任务如果还没处理结束,则会返回等待中或处理中
请求参数:
| 参数名 | 类型 | 说明 | 是否必须 |
|---|---|---|---|
| taskId | string | 任务id | 是 |
- tokenType/tokenValue/callback说明见本文档【通用字段说明】
根据返回值的code值,判断接口处理状态。 任务状态说明:
| code值 | 说明 |
|---|---|
| InvalidTaskId | 无效的任务id,表示这个任务id不是zoffice返回的 |
| TaskSuccessNotify (或ConvertSuccessNotify) | 任务处理成功 |
| TaskFailNotify (或ConvertFailNotify) | 任务处理失败 |
| TaskHandingNotify | 任务正在处理中 |
正常返回1(处理中):
// 任务未执行完时,返回处理中
{
"taskId": "86b5173f-1719-4cac-adc4-e2aa447335b9",
"code": "TaskHandingNotify",
"detail": null
}
正常返回2(处理成功):
// 任务执行成功,处理完成,返回success
{
"taskId": "86b5173f-1719-4cac-adc4-e2aa447335b9",
"code": "TaskSuccessNotify", // 或ConvertSuccessNotify
"detail": {
"taskStatus": "SUCCESS",
"defaultDownloadPath": "/docs/publicapi/v1/download",
"contentId": "670f8eb4f05ce339db231c57",
"startTime": 1729072540043,
"endTime": 1729072820389,
"filename": "demo-docx.pdf"
}
}
错误返回(任务失败):
{
"taskId": "695fbf6e-90d2-42ba-83d5-00e81e5e366e",
"code": "TaskFailNotify", // 或ConvertFailNotify
"detail": {
"taskStatus": "FAIL"
}
}