发起解除协议

1. 接口描述

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

发起解除协议的主要应用场景为：基于一份已经签署的合同（签署流程），进行解除操作。解除协议的模板是官方提供，经过提供法务审核，暂不支持自定义。

注意：

原合同必须签署完成后才能发起解除协议。
只有原合同企业类型的参与人才能发起解除协议，个人参与方不能发起解除协议。
原合同个人类型参与人必须是解除协议的参与人，不能更换其他第三方个人参与解除协议。
如果原合同企业参与人无法参与解除协议，可以指定同企业具有同等权限的企业员工代为处理。
发起解除协议同发起其他企业合同一样，也会参与合同扣费，扣费标准同其他类型合同。
在解除协议发起之后，原合同的状态将转变为解除中。一旦解除协议签署完毕，原合同及解除协议均变为已解除状态。
非原合同企业参与人发起解除协议时，需要有解除合同的权限。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateReleaseFlow。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
NeedRelievedFlowId	是	String	待解除的签署流程编号（即原签署流程的编号）。示例值：yDwFmUUckpst10i3UubBSat8PWOt2iQF
ReliveInfo	是	RelieveInfo	解除协议内容, 包括解除理由等信息。
Agent	否	Agent	代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
ReleasedApprovers.N	否	Array of ReleasedApprover	替换解除协议的签署人，如不指定替换签署人, 则使用原流程的签署人。如需更换原合同中的企业端签署人，可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口DescribeFlowInfo查询签署人的RecipientId编号) 注意： `只能更换自己企业的签署人, 不支持更换个人类型或者其他企业的签署人。` `可以不指定替换签署人, 使用原流程的签署人`
Deadline	否	Integer	合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的7天时截止。如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。示例值：1604912664
UserData	否	String	调用方自定义的个性化字段，该字段的值可以是字符串JSON或其他字符串形式，客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输，支持的最大数据大小为20480长度。在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。

3. 输出参数

参数名称	类型	描述
FlowId	String	解除协议流程编号 `注意：这里的流程编号对应的合同是本次发起的解除协议。`
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 发起解除协议（主代子场景）

解除某个签署完成的合同
主企业代子企业操作(通过指定Agent中的ProxyOrganizationId)

输入示例

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
    },
    "Agent": {
        "ProxyOrganizationId": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP"
    },
    "NeedRelievedFlowId": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
    "ReleasedApprovers": [
        {
            "Mobile": "13200000000",
            "Name": "典子谦",
            "RelievedApproverReceiptId": "yDRSRUUgygj6rqouUuO4zjESlnSFPcIE"
        }
    ],
    "ReliveInfo": {
        "OriginalExpenseSettlement": "甲方需付给乙方xxxx以作赔偿",
        "OriginalOtherSettlement": "无",
        "OtherDeals": "无",
        "Reason": "因为业务调整, 结束合作。",
        "RemainInForceItem": "在业务结束前已产生的订单依旧有效。"
    }
}

输出示例

{
    "Response": {
        "FlowId": "yDwJBUUc***uxAppfh2XR",
        "RequestId": "s1693969234439636483"
    }
}

示例2 发起解除协议（默认情况，使用原流程的签署人）

1.使用原流程的签署人 2.包含了详细的解除内容

输入示例

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

{
    "Operator": {
        "UserId": "xxxOUUgyxxxxEWA0dddl"
    },
    "NeedRelievedFlowId": "xxxnGUUgygkgi7fdUx6JlVOE0wzdddd",
    "ReliveInfo": {
        "OriginalExpenseSettlement": "甲方需付给乙方xxxxxx以作赔偿",
        "OriginalOtherSettlement": "无",
        "OtherDeals": "无",
        "Reason": "因为业务调整,结束合作。",
        "RemainInForceItem": "在业务结束前已产生的订单依旧有效。"
    }
}

输出示例

{
    "Response": {
        "FlowId": "yDwnGUUgygkgi7fdUx6JlVOE0wzmtxxx",
        "RequestId": "s18776xxx345780"
    }
}

示例3 错误示例-解除协议中更换原合同个人类型的参与人

解除某个包含个人类型签署人的合同
更换其他个人类型签署人作为解除协议的参与人

输入示例

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
    },
    "NeedRelievedFlowId": "yDR1AUUgygjazuesUuO4zjESPW4PkfNi",
    "ReleasedApprovers": [
        {
            "Mobile": "15100000000",
            "Name": "李四",
            "RelievedApproverReceiptId": "yDwFdUUckpsvi8mpUEn0aFR1tWzReoTk"
        }
    ],
    "ReliveInfo": {
        "OriginalExpenseSettlement": "甲方需付给乙方xxxx以作赔偿",
        "OriginalOtherSettlement": "无",
        "OtherDeals": "无",
        "Reason": "因为业务调整, 结束合作。",
        "RemainInForceItem": "在业务结束前已产生的订单依旧有效。"
    }
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "FailedOperation",
            "Message": "不能更换非企业签署人身份信息"
        },
        "RequestId": "s16939xxx23898"
    }
}

示例4 发起解除协议（记录下原合同与解除协议的映射关系）

更换原合同中的企业参与人(通过指定ReleasedApprovers中的RelievedApproverReceiptId)
在解除协议中记录下原合同ID(通过设置UserData字段)

输入示例

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
    },
    "UserData": "{\"OriginalFlowId\":\"yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm\"}",
    "NeedRelievedFlowId": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
    "ReleasedApprovers": [
        {
            "Mobile": "13200000000",
            "Name": "典子谦",
            "RelievedApproverReceiptId": "yDRSRUUgygj6rqouUuO4zjESlnSFPcIE"
        }
    ],
    "ReliveInfo": {
        "OriginalExpenseSettlement": "甲方需付给乙方xxxx以作赔偿",
        "OriginalOtherSettlement": "无",
        "OtherDeals": "无",
        "Reason": "因为业务调整, 结束合作。",
        "RemainInForceItem": "在业务结束前已产生的订单依旧有效。"
    }
}

输出示例

{
    "Response": {
        "FlowId": "yDwJBUUc***uxAppfh2XR",
        "RequestId": "s1693969233639636483"
    }
}

示例5 发起解除协议（替换原流程中本企业的参与人并指定其为自动签署）

更换原合同中本方企业的参与人
给该企业参与人指定未自动签署(ApproverType 设置为 ENTERPRISESERVER)

输入示例

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
    },
    "NeedRelievedFlowId": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
    "ReleasedApprovers": [
        {
            "Mobile": "13200000000",
            "Name": "典子谦",
            "RelievedApproverReceiptId": "yDRSRUUgygj6rqouUuO4zjESlnSFPcIE",
            "ApproverType": "ENTERPRISESERVER"
        }
    ],
    "ReliveInfo": {
        "OriginalExpenseSettlement": "甲方需付给乙方以作赔偿",
        "OriginalOtherSettlement": "无",
        "OtherDeals": "无",
        "Reason": "因为业务调整, 结束合作。",
        "RemainInForceItem": "在业务结束前已产生的订单依旧有效。"
    }
}

输出示例

{
    "Response": {
        "FlowId": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
        "RequestId": "s312334445587989"
    }
}

示例6 发起解除协议（使用本企业的签署人，替换用原流程中本企业的签署人）

发起解除协议（使用本企业的签署人，替换用原流程中本企业的签署人）

输入示例

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

{
    "Operator": {
        "UserId": "yDxjOUUgydjxxxxxjEWA07rC2xl"
    },
    "NeedRelievedFlowId": "yDwnGUUgygkgi7fdUx6JlVOE0wxxxxx",
    "ReleasedApprovers": [
        {
            "Mobile": "1870000000",
            "Name": "典子谦",
            "RelievedApproverReceiptId": "yDRscUUgyg1zr7vjUyJ8QKxxxxxxx"
        }
    ],
    "ReliveInfo": {
        "OriginalExpenseSettlement": "甲方需付给乙方xxxx以作赔偿",
        "OriginalOtherSettlement": "无",
        "OtherDeals": "无",
        "Reason": "因为业务调整,结束合作。",
        "RemainInForceItem": "在业务结束前已产生的订单依旧有效。"
    }
}

输出示例

{
    "Response": {
        "FlowId": "yDRscAABDg1zr7vjUyJ8QKxxxxxxx",
        "RequestId": "s1989876373464"
    }
}

示例7 发起解除协议（替换原流程中本企业的参与人并指定签署人角色、签署控件）

更换原合同中本方企业的参与人
给该企业参与人指定自定义的角色名称(通过设置ApproverSignRole)
给该企业参与人指定签署控件类型为手写签名(通过设置ApproverSignComponentType)

输入示例

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
    },
    "NeedRelievedFlowId": "yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm",
    "ReleasedApprovers": [
        {
            "Mobile": "13200000000",
            "Name": "典子谦",
            "RelievedApproverReceiptId": "yDRSRUUgygj6rqouUuO4zjESlnSFPcIE",
            "ApproverSignRole": "自定义的签署方角色(供应商)",
            "ApproverSignComponentType": "SIGN_SIGNATURE"
        }
    ],
    "ReliveInfo": {
        "OriginalExpenseSettlement": "甲方需付给乙方以作赔偿",
        "OriginalOtherSettlement": "无",
        "OtherDeals": "无",
        "Reason": "因为业务调整, 结束合作。",
        "RemainInForceItem": "在业务结束前已产生的订单依旧有效。"
    }
}

输出示例

{
    "Response": {
        "FlowId": "yDwgkUU7y***********zWBfv",
        "RequestId": "s1688099393764508839"
    }
}

5. 错误码

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

错误码	描述
FailedOperation	操作失败。
FailedOperation.AgeNotAchieveNormalLegal	年龄限制无法使用电子签服务，请联系客服咨询处理。
FailedOperation.FlowHasDocument	签署流程已有关联文档，请检查参数修改后重试。
FailedOperation.OrganizationExperienceChange	企业经营状态与工商局信息不符。
FailedOperation.OrganizationNameChanged	企业名称与工商局信息不符。
FailedOperation.OrganizationNameNeedChange	企业名称与工商局信息不符,需要超管修改。
FailedOperation.RequestLimitExceeded	请求的次数超过了频率限制，请联系客服处理。
FailedOperation.UserInfoNoMatch	用户信息不匹配，请检查后重试。
InternalError.DbInsert	数据库新增记录出错。
InternalError.DbRead	内部错误,数据库查询失败,请稍后重试。
InternalError.System	系统错误，请稍后重试。
InvalidParameter.ApproverType	不合法的签署人类型，请检查后重试。
InvalidParameter.CardNumber	不合法的证件信息，请检查证件号证件类型是否正确。
InvalidParameter.CardType	不合法的证件信息，请检查证件号证件类型是否正确。
InvalidParameter.CcNum	不合法的抄送方设置，请联系客服了解抄送设置规则，修改后重试。
InvalidParameter.ClientToken	ClientToken不合法请检查。
InvalidParameter.CustomShowMap	无效的自定义页卡模板，请检查后重试。
InvalidParameter.FlowCallbackUrl	不合法的签署流程回调链接，请修改后重试。
InvalidParameter.FlowDeadLine	不合法的签署流程截止日期，请修改后重试。
InvalidParameter.FlowDescription	不合法的签署流程描述，请修改后重试。
InvalidParameter.FlowName	不合法的签署流程名称，请修改后重试。
InvalidParameter.FlowType	不合法的签署流程类型，请修改后重试。
InvalidParameter.FlowUserData	不合法的签署流程用户自定义数据，请修改后重试。
InvalidParameter.FromSource	不合法的FromSource，请联系开发，检查后重试。
InvalidParameter.IdCardValidityOverLimit	用户个人证件已过期。
InvalidParameter.InvalidMobile	手机号码不正确。
InvalidParameter.InvalidName	姓名不正确。
InvalidParameter.Mobile	不合法的手机号，请检查后重试。
InvalidParameter.Name	不合法的用户名称，请修改后重试。
InvalidParameter.NonsupportMobile	手机号为空或者非法的手机号。
InvalidParameter.NotifyType	不支持的通知类型，请检查并联系客服处理。
InvalidParameter.OrganizationName	不合法的企业名称，请修改后重试。
InvalidParameter.ParamError	参数错误。
InvalidParameter.PersonAutoSignTag	个人静默签Tag未设置，请检查后重试。
InvalidParameter.PreReadTime	不合法的阅读时长限制，请联系客服了解阅读时长设置规则，修改后重试。
InvalidParameterValue.Mask	需要屏蔽的告警。
LimitExceeded	超过配额限制。
MissingParameter.ApproverMobile	缺少签署人手机号，请检查后重试。
MissingParameter.ApproverName	缺少签署人姓名，请检查后重试。
MissingParameter.ApproverOrganizationInfo	缺少签署人企业信息，请检查后重试。
OperationDenied	操作被拒绝。
OperationDenied.ApproverRepeat	签署人重复，请联系客服了解发起签署流程签署人规则，修改后重试。
OperationDenied.BranchSendFlowToParentNotAllow	子公司不能发起本方母体公司的合同。
OperationDenied.CcForbid	当前不支持抄送，请联系客服咨询处理。
OperationDenied.CcUserRepeat	抄送方存在相同抄送人，请检查修改后重试。
OperationDenied.Forbid	禁止此项操作。
OperationDenied.InvalidApproverAge	签署人年龄限制无法使用电子签服务。
OperationDenied.NoIdentityVerify	未通过个人实名认证。
OperationDenied.NoLogin	用户未登录,请先登录后再操作。
OperationDenied.NoOpenServerSign	未开通静默签功能，请联系签署方企业开通后重试。
OperationDenied.NoQuota	企业额度不足，请检查企业额度后处理。
OperationDenied.OrgUniformSocialCreditCodeErr	此社会信用编码未查询到结果，请检查后重试。
OperationDenied.OrganizationNotActivated	企业未激活。
OperationDenied.OutQueryLimit	查询限频，请先联系客服了解限频策略，稍后重试。
OperationDenied.OverSeaForbid	当前不支持境外用户，请联系客服咨询处理。
OperationDenied.PersonHasNoSignature	个人名下没用可使用的签名，请联系个人配置签名后重试。
OperationDenied.PersonNoOpenServerSign	该用户已关闭或者未开启自动签服务，请检查后重试。
OperationDenied.WhiteListForbid	未开通功能白名单，请联系客服处理。
RequestLimitExceeded	请求的次数超过了频率限制。
ResourceNotFound	资源不存在。
ResourceNotFound.Application	应用号不存在或已删除。
ResourceNotFound.AuthActiveOrganization	机构未完成认证激活，请检查并联系客服处理。
ResourceNotFound.FlowApprover	签署流程的签署人不存在，请检查后重试。
ResourceNotFound.Organization	机构不存在或者未完成认证，请检查机构信息。
ResourceNotFound.SuperAdmin	超管信息不存在，请检查企业认证信息。
ResourceNotFound.User	用户或者员工信息不存在，请检查参数后重试。
ResourceNotFound.VerifyUser	用户或者员工未完成实名认证，请检查参数后重试。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

示例1 发起解除协议（主代子场景）​

输入示例​

输出示例​

示例2 发起解除协议（默认情况，使用原流程的签署人）​

输入示例​

输出示例​

示例3 错误示例-解除协议中更换原合同个人类型的参与人​

输入示例​

输出示例​

示例4 发起解除协议（记录下原合同与解除协议的映射关系）​

输入示例​

输出示例​

示例5 发起解除协议（替换原流程中本企业的参与人并指定其为自动签署）​

输入示例​

输出示例​

示例6 发起解除协议（使用本企业的签署人，替换用原流程中本企业的签署人）​

输入示例​

输出示例​

示例7 发起解除协议（替换原流程中本企业的参与人并指定签署人角色、签署控件）​

输入示例​

输出示例​

5. 错误码​

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

示例1 发起解除协议（主代子场景）

输入示例

输出示例

示例2 发起解除协议（默认情况，使用原流程的签署人）

输入示例

输出示例

示例3 错误示例-解除协议中更换原合同个人类型的参与人

输入示例

输出示例

示例4 发起解除协议（记录下原合同与解除协议的映射关系）

输入示例

输出示例

示例5 发起解除协议（替换原流程中本企业的参与人并指定其为自动签署）

输入示例

输出示例

示例6 发起解除协议（使用本企业的签署人，替换用原流程中本企业的签署人）

输入示例

输出示例

示例7 发起解除协议（替换原流程中本企业的参与人并指定签署人角色、签署控件）

输入示例

输出示例

5. 错误码