撤销签署流程

1. 接口描述

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

撤销签署流程接口，可以撤回：未全部签署完成；不可以撤回（终态）：已全部签署完成、已拒签、已过期、已撤回。注意: 能撤回合同的只能是合同的发起人或者发起企业的超管、法人

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ChannelCancelFlow。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
FlowId	是	String	签署流程编号示例值：xxx
Agent	否	Agent	应用相关信息。此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
CancelMessage	否	String	撤回原因，最大不超过200字符示例值：xxx
CancelMessageFormat	否	Integer	撤销理由自定义格式；选项： 0 默认格式 1 只保留身份信息：展示为【发起方】 2 保留身份信息+企业名称：展示为【发起方xxx公司】 3 保留身份信息+企业名称+经办人名称：展示为【发起方xxxx公司-经办人姓名】

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 撤销签署流程

撤销签署流程

输入示例

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

{
    "Operator": {
        "OpenId": "test"
    },
    "FlowId": "test",
    "CancelMessage": "test",
    "Agent": {
        "ProxyOperator": {
            "OpenId": "test"
        },
        "ProxyOrganizationOpenId": "test",
        "AppId": "test"
    }
}

输出示例

{
    "Response": {
        "RequestId": "s16221xxxx12775546"
    }
}

5. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.Db	数据库错误。
InternalError.System	系统错误。
InvalidParameter	参数错误。
InvalidParameter.CancelReason	撤销理由填写格式错误。
InvalidParameter.ParamError	参数错误。
InvalidParameter.Status	状态异常。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
OperationDenied.FlowHasTerminated	流程已终止。
OperationDenied.Forbid	禁止操作。
OperationDenied.UserNotInOrganization	用户不归属于当前企业，无法操作，请检查后重试。
ResourceNotFound	资源不存在。
ResourceNotFound.Flow	未找到对应流程。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。
UnknownParameter	未知参数错误。
UnsupportedOperation	操作不支持。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 撤销签署流程​

输入示例​

输出示例​

5. 错误码​