跳到主要内容

全量撤销企业合同

1. 接口描述​

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

全量撤销企业所有签署中的合同，单次任务最多支持撤销3000份合同。

适用场景：在企业信息变更场景下，签署中的合同需要全部撤销，全部重新发起，则可通过该接口取消签署中的合同流程，需注意：该接口会将企业下签署中的合同都进行撤销操作，谨慎使用此接口。

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

批量撤销结果可以通过接口返回的TaskId关联批量撤销任务结果回调或通过接口查询批量撤销合同结果主动查询。

注:

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

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

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

2. 输入参数​

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

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

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

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

CancelMessage否String

撤回原因，长度不能超过200，只能由中文、字母、数字和下划线组成。备注:如果不传递撤回原因，那么默认撤回原因是 "自动撤销（通过接口实现）"


示例值：接口自动撤销
CancelMessageFormat否Integer

撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式：0 : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以CancelMessage的理由撤销当前合同1 : 合同封面页面会展示为: 发起方以CancelMessage的理由撤销当前合同2 : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以CancelMessage的理由撤销当前合同3 : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以CancelMessage的理由撤销当前合同注: CancelMessage为撤销当前合同的理由image

枚举值：

  • 0： 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以CancelMessage的理由撤销当前合同
  • 1： 合同封面页面会展示为: 发起方以CancelMessage的理由撤销当前合同
  • 2： 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以CancelMessage的理由撤销当前合同
  • 3： 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以CancelMessage的理由撤销当前合同注: `CancelMessage为撤销当前合同的理由

示例值：1

3. 输出参数​

参数名称类型描述
TaskIdString

批量撤销任务编号，为32位字符串，可用于查询批量撤销合同结果 或关联批量撤销任务结果回调


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

4. 示例​

示例1 全量撤销企业合同​

全量撤销企业合同

输入示例​

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

{
    "Agent": {
        "AppId": "yDwFoUUckpsomwx1UyhWGhIR2RkhOjw2",
        "ProxyOrganizationOpenId": "es******************n_1",
        "ProxyOperator": {
            "OpenId": "k*********g"
        }
    }
}

输出示例​

{
    "Response": {
        "TaskId": "yD3PzUUckpzfafu8UaytqwM63aaNhNqP",
        "RequestId": "658033fa-247c-4e49-b8e5-cc7da03b1863"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
InvalidParameter参数错误。
InvalidParameter.ParamError参数错误。
InvalidParameterValue参数取值错误。
MissingParameter缺少参数错误。
OperationDenied操作被拒绝。
ResourceNotFound资源不存在。
更多开发者交流反馈