跳到主要内容

发起解除协议

1. 接口描述​

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

发起解除协议，主要应用场景为：基于一份已经签署的合同，进行解除操作。 合同发起人必须在电子签已经进行实名。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：ChannelCreateReleaseFlow。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，本接口不需要传递此参数。
Agent是Agent应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 和 Agent.ProxyAppId 均必填。
NeedRelievedFlowId是String待解除的流程编号（即原流程的编号）
ReliveInfo是RelieveInfo解除协议内容
ReleasedApprovers.N否Array of ReleasedApprover非必须，解除协议的本企业签署人列表，默认使用原流程的签署人列表；当解除协议的签署人与原流程的签署人不能相同时（例如原流程签署人离职了），需要指定本企业的其他签署人来替换原流程中的原签署人，注意需要指明ApproverNumber来代表需要替换哪一个签署人，解除协议的签署人数量不能多于原流程的签署人数量
CallbackUrl否String签署完回调url，最大长度1000个字符
Organization否OrganizationInfo暂未开放
Operator否UserInfo暂未开放

3. 输出参数​

参数名称类型描述
FlowIdString解除协议流程编号
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

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

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

输入示例​

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

{
    "Agent": {
        "ProxyAppId": "c17bdf***********200fef3d",
        "ProxyOrganizationOpenId": "d7c13a8***********0ee248f04",
        "ProxyOperator": {
            "OpenId": "00498cc***********3aff766cac"
        },
        "AppId": "65f***********aa382cc5ed0e"
    },
    "NeedRelievedFlowId": "待解除的流程编号xx",
    "ReliveInfo": {
        "Reason": "解除理由xx",
        "RemainInForceItem": "保留条款xx",
        "OriginalExpenseSettlement": "原合同费用结算xx",
        "OriginalOtherSettlement": "原合同其他约定xx",
        "OtherDeals": "其他约定xx"
    }
}

输出示例​

{
    "Response": {
        "FlowId": "yDRsF*****************cbBRXBW6Rd",
        "RequestId": "s1669186754600597655"
    }
}

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

  1. 使用本企业的签署人
  2. 包含了详细的解除内容
  3. 替换原流程中本企业的签署人
  4. 被替换的原流程中的签署人ApproverNumber=1（即第二个签署人，在原流程签署人列表中的第二位）

扩展信息： 针对ApproverNumber举个例子， 例如在原流程中共有三个签署人（a, b, c）， 那么a是第一位(ApproverNumber=0)，b是第二位(ApproverNumber=1)，c是第三位(ApproverNumber=2)， 注意这里的顺序不是签署顺序，仅仅是签署人列表中的自然顺序，签署人列表的获取可以参考DescribeFlowDetailInfo接口。

输入示例​

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

{
    "Agent": {
        "ProxyAppId": "c17bdf***********200fef3d",
        "ProxyOrganizationOpenId": "d7c13a8***********0ee248f04",
        "ProxyOperator": {
            "OpenId": "00498cc***********3aff766cac"
        },
        "AppId": "65f***********aa382cc5ed0e"
    },
    "NeedRelievedFlowId": "待解除的流程编号test",
    "ReleasedApprovers": [
        {
            "ApproverNumber": 1,
            "Name": "张三",
            "Mobile": "13********",
            "ApproverType": "ORGANIZATION",
            "OrganizationName": "test"
        }
    ],
    "ReliveInfo": {
        "Reason": "解除理由test",
        "RemainInForceItem": "保留条款test",
        "OriginalExpenseSettlement": "原合同费用结算test",
        "OriginalOtherSettlement": "原合同其他约定test",
        "OtherDeals": "其他约定test"
    }
}

输出示例​

{
    "Response": {
        "FlowId": "yDRsF*****************cbBRXBW6Rd",
        "RequestId": "s16692xxx82203341"
    }
}

5. 开发者资源​

腾讯云 API 平台​

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector​

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK​

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具​

6. 错误码​

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

错误码描述
FailedOperation操作失败。
InternalError内部错误。
InternalError.Api其他API错误。
InternalError.PdfPdf合成错误。
InvalidParameter.Application应用号不存在。
InvalidParameter.Mobile手机号码不正确。
InvalidParameter.Name姓名不符合要求。
InvalidParameter.OpenIdOpenId不合法。
InvalidParameter.OrganizationName企业名称不合法。
InvalidParameter.ParamError参数错误。
MissingParameter缺少参数错误。
OperationDenied.UserNotInOrganization用户不归属于当前企业，无法操作，请检查后重试。
ResourceNotFound资源不存在。
ResourceNotFound.Flow未找到对应流程。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。