跳到主要内容

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

1. 接口描述​

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

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

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：DescribeCancelFlowsTask。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
Agent是Agent

关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

  • 渠道应用标识: Agent.AppId
  • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
  • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
TaskId是String

批量撤销任务编号，为32位字符串，通过接口批量撤销合同流程或者获取批量撤销签署流程腾讯电子签小程序链接或者全量撤销企业合同获得。


示例值：yDCVWUUckpwkjgiuUWGW8cRAzd84BVQa
CancelType否Integer

撤销任务类型

枚举值：

  • 0： 默认类型，批量撤销合同任务或者获取批量撤销合同小程序链接的批量撤销任务
  • 1： 全量撤销任务

枚举值：

  • 0： 默认类型，批量撤销合同任务或者获取批量撤销合同小程序链接的批量撤销任务
  • 1： 全量撤销任务

示例值：1

3. 输出参数​

参数名称类型描述
TaskIdString

批量撤销任务编号，为32位字符串。


示例值：yDCVWUUckpwkjgiuUWGW7cRAzd93BVQa
TaskStatusString

任务状态，需要关注的状态

  • PROCESSING - 任务执行中
  • END - 任务处理完成
  • TIMEOUT 任务超时未处理完成，用户未在批量撤销链接有效期内操作


示例值：END
SuccessFlowIdsArray of String

批量撤销成功的签署流程编号


示例值：["yD3POUUckpzx1mhdU1UuDSYM1xwPbeJL"]
FailureFlowsArray of CancelFailureFlow

批量撤销失败的签署流程信息

RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 查询全量撤销企业合同任务结果​

查询全量撤销企业合同任务结果

输入示例​

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

{
    "Agent": {
        "AppId": "yDwFoUUckpsomwx1UyhWGhIR2RkhOjw2",
        "ProxyOrganizationOpenId": "ess_open_organization_1",
        "ProxyOperator": {
            "OpenId": "kevinlcheng"
        }
    },
    "TaskId": "yD3POUUckpzme5ekUxM7lqE1ODrkqmYz",
    "CancelType": 1
}

输出示例​

{
    "Response": {
        "FailureFlows": [],
        "SuccessFlowIds": [
            "yD3POUUckpzx1mhdU1UuDSYM1xwPbeJL"
        ],
        "TaskId": "yD3POUUckpzme5ekUxM7lqE1ODrkqmYz",
        "TaskStatus": "END",
        "RequestId": "d3becccb-75e5-43fc-9be6-27ccf7bd4067"
    }
}

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

查询批量撤销任务结果

输入示例​

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyOrganizationOpenId": "org_dianziqian",
        "AppId": "yDRS4UUgygqdcj8xUuO4zjEwOT7IN8Ec"
    },
    "TaskId": "yDCVWUUckpwkjgiuUWGW8cRAzd84BVQa"
}

输出示例​

{
    "Response": {
        "FailureFlows": [
            {
                "FlowId": "yDCNGUUckpvjdelbUuyImI9pY8I5Mep9",
                "Reason": "合同当前状态不支持撤销"
            },
            {
                "FlowId": "yDw9jUUgyg34g2mdUxawbT61HrwMQ3gF",
                "Reason": "合同信息不存在或非本企业发起的合同"
            }
        ],
        "RequestId": "49f10eec-73af-4f1b-bc99-d36e9a60e631",
        "SuccessFlowIds": [
            "yDCN0UUckpvhnc6uUuyImI98ydIEe4bX"
        ],
        "TaskId": "yDCVWUUckpwkjgiuUWGW7cRAzd93BVQa",
        "TaskStatus": "END"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
InvalidParameter.DupTask重复提交任务。
InvalidParameter.ParamError参数错误。
OperationDenied操作被拒绝。
OperationDenied.FlowHasTerminated流程已终止。
OperationDenied.UserNotInOrganization用户不归属于当前企业，无法操作，请检查后重试。
ResourceNotFound资源不存在。
ResourceNotFound.Application应用号不存在。
ResourceNotFound.User用户信息不存在。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
更多开发者交流反馈