查询批量撤销签署流程任务结果

1. 接口描述

接口请求域名： ess.tencentcloudapi.com 。

通过获取批量撤销签署流程腾讯电子签小程序链接发起批量撤销任务后，可通过此接口查询批量撤销任务的结果。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCancelFlowsTask。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
TaskId	是	String	批量撤销任务编号，为32位字符串，通过接口获取批量撤销签署流程腾讯电子签小程序链接获得。
Agent	否	Agent	代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

3. 输出参数

参数名称	类型	描述
TaskId	String	批量撤销任务编号，为32位字符串，通过接口获取批量撤销签署流程腾讯电子签小程序链接获得。
TaskStatus	String	任务状态，需要关注的状态 PROCESSING - 任务执行中 END - 任务处理完成 TIMEOUT 任务超时未处理完成，用户未在批量撤销链接有效期内操作
SuccessFlowIds	Array of String	批量撤销成功的签署流程编号
FailureFlows	Array of CancelFailureFlow	批量撤销失败的签署流程信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询批量撤销任务结果

通过TaskId查询批量撤销任务结果

输入示例

POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCancelFlowsTask
<公共请求参数>

{
    "Operator": {
        "UserId": "yDxVwUyKQWho8CUuO4zjEyQOAgwvr4Zy"
    },
    "TaskId": "yDCVWUUckpwkjgiuUWGW8cRAzd93BVQb"
}

输出示例

{
    "Response": {
        "FailureFlows": [
            {
                "FlowId": "yDCNGUUckpvjdelbUuyImI9pY8I5Mep1",
                "Reason": "合同当前状态不支持撤销"
            },
            {
                "FlowId": "yDCV4UUckpwr0wq7UENkSSawLpt5Fz6C",
                "Reason": "合同当前状态不支持撤销"
            },
            {
                "FlowId": "yDw9jUUgyg54g2mdUxawbT61HrwMQ2gF",
                "Reason": "合同信息不存在或非本企业发起的合同"
            }
        ],
        "RequestId": "8698cab8-5947-49e6-8681-ce2080b70e73",
        "SuccessFlowIds": [
            "yDCN0UUckpvhnc6uUuyImI98ydIEe6bX"
        ],
        "TaskId": "yDCVWUUckpwkjgiuUWGW9cRAzd93BVQa",
        "TaskStatus": "END"
    }
}

5. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation	操作失败。
InternalError.System	系统错误，请稍后重试。
MissingParameter.FlowId	缺少签署流程id，请检查修改后重试。
OperationDenied	操作被拒绝。
OperationDenied.BatchCancelForbid	不允许批量撤销签署流程，请检查批量撤销合同信息。
ResourceNotFound.ErrNotExistRole	未获取到用户角色信息，请检查员工角色配置。
ResourceNotFound.Flow	签署流程未找到，请检查参数。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 查询批量撤销任务结果​

输入示例​

输出示例​

5. 错误码​