撤销合同流程

1. 接口描述

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

撤销签署流程接口

适用场景：如果某个合同流程当前至少还有一方没有签署，则可通过该接口取消该合同流程。常用于合同发错、内容填错，需要及时撤销的场景。

可撤回合同状态：未全部签署完成
不撤回合同状态：已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。

注:

有对应合同撤销权限的人: 合同的发起人（并已经授予撤销权限）或者发起人所在企业的超管、法人
签署完毕的合同需要双方走解除流程将合同作废，可以参考发起解除合同流程接口
只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。
撤销后可以看合同PDF内容的人员：发起方的超管，发起方自己，发起方撤销合同的操作人员，已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员，其他参与人员看不到合同的内容。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ChannelCancelFlow。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
FlowId	是	String	要撤销的合同流程ID 示例值：yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
Agent	否	Agent	关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实名认证
CancelMessage	否	String	撤回原因，长度不能超过200，只能由中文、字母、数字和下划线组成。示例值：合同里边支付的价格写错了
CancelMessageFormat	否	Integer	撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式： 0 : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以CancelMessage的理由撤销当前合同 1 : 合同封面页面会展示为: 发起方以CancelMessage的理由撤销当前合同 2 : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以CancelMessage的理由撤销当前合同 3 : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以CancelMessage的理由撤销当前合同注: `CancelMessage为撤销当前合同的理由` 示例值：1

3. 输出参数

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

4. 示例

示例1 撤销签署流程

撤销签署流程

输入示例

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

{
    "FlowId": "yDwiBUUckpo2wjjbUuRr5O4wOuKZNrbr",
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "CancelMessage": "因为合同里边的金额填写错误",
    "CancelMessageFormat": 0
}

输出示例

{
    "Response": {
        "RequestId": "22c26f54-d604-4b71-9e66-734d02b44237"
    }
}

5. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
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. 错误码​