回调API列表
任务完成通知
对接方调用格式处理接口后,通过此接口通知对接方任务已完成。
回调说明
请求地址: 回调地址 + uri(默认/cps/async/v1/task/notify)
请求方法: POST
签名方式: 无
请求头(Header)
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
查询参数(Query)
| 参数 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| *(任意参数) | *(任意类型) | 否 | 在格式处理时按需求传入的query中的自定义参数 |
请求体(Body)
| 参数 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| task_id | string | 是 | 转换任务id |
| method | string | 是 | 任务类型,枚举:OFFICE_CONVERT格式转换 OFFICE_WARP_HEADER多书签套用 OFFICE_MERGE文档合并 OFFICE_SPLIT文档拆分 OFFICE_SMART_OFFICIAL智能公文 OFFICE_OPERATE内容操作 OFFICE_QUERY_BOOKMARK查询书签 OFFICE_SET_BOOKMARK_PERMS限制书签 OFFICE_QUERY_BOOKMARK_PERMS查询只读/可编辑书签 IMAGE_OPERATE图片操作 |
| result | object | 是 | 执行结果 |
| ∟ success | bool | 是 | 是否成功 |
| ∟ message | string | 是 | 执行结果描述 |
| ∟ download_id | string | 否 | 下载id |
| ∟ route_key | string | 否 | 下载接口header需要传,用于路由 |
| ∟ decompression_file_list | object[] | 否 | 适用版本 >= v7.1.2303.20230322,压缩包中的文件列表 |
| ∟ download_id | string | 否 | 下载id,directory为false时返回 |
| ∟ size | string | 否 | 文件大小 |
| ∟ name | string | 否 | 文件/文件夹名称 |
| ∟ directory | boolean | 否 | 是否文件夹 |
| ∟ modify_time | long | 否 | 最后修改时间 |
| ∟ list_files | object[] | 否 | 文件夹中的文件列表,directory为true时存在 |
响应体(Response)
200 OK