结束动态签署流程

1. 接口描述

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

该接口用于结束动态签署方2.0的合同流程。

功能开通

• 动态签署方2.0功能的使用需要先联系产品经理开通模块化计费功能，然后到控制台中打开此功能。详细的使用说明请参考动态签署方2.0文档。

使用条件

• 此接口只能在合同处于非终态且所有的签署方都已经完成签署。一旦合同进入终态（例如：过期、拒签、撤销或者调用过此接口成功过），将无法通过此接口结束合同流程。

整体流程

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ArchiveDynamicFlow。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
FlowId	是	String	合同流程ID, 为32位字符串。 可登录腾讯电子签控制台，点击查看FlowId在控制台中的位置 示例值：yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
Agent	否	Agent	代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

3. 输出参数

参数名称	类型	描述
FlowId	String	合同流程ID 示例值：yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
Approvers	Array of ArchiveDynamicApproverData	动态签署人的参与人信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 结束动态签署合同

所有签署方都签署完成，并且不再新增签署方时，结束该动态签署合同

输入示例

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

{
    "Operator": {
        "ClientIp": "1.1.1.1",
        "UserId": "yDxZtUyKQD2JuqUuO4zjERYGxxxxxxxx"
    },
    "FlowId": "yDCmVUUckpufezuiUxQQFiT8Exxxxxxxx"
}

输出示例

{
    "Response": {
        "Approvers": [
            {
                "SignId": "yDCmDUUckpuf0hsfUuvalvQtaxxxxxxx",
                "RecipientId": "yDCmDUUckpuf0hseUuvalvQRmxxxxxx"
            }
        ],
        "FlowId": "yDCmDUUckpuf0hsmUuvalvQyxxxxxxxxx",
        "RequestId": "abc"
    }
}

示例2 归档失败

未签署完成前归档

输入示例

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

{
    "Operator": {
        "UserId": "yDwf3UUckps8dvveUEfH3DjvMmg3ZkjQ"
    },
    "FlowId": "yDCjFUUckp4jkz76UoofpTx3iZ3A3C3x"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "OperationDenied",
            "Message": "当前合同状态不支持归档合同,请检查后重试"
        },
        "RequestId": "34ded0a6-e679-4af7-a07e-ca457e388499"
    }
}

示例3 归档合同

所有签署方签署完成后，结束动态合同

输入示例

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

{
    "Operator": {
        "UserId": "yDwf3UUckps8dvveUEfH3DjvMmg3ZkjQ"
    },
    "FlowId": "yDCjFUUckp48fiwyUyh7ukYEdXdSyJps"
}

输出示例

{
    "Response": {
        "Approvers": [
            {
                "RecipientId": "yDCjFUUckp48fiwbUyh7ukYE1kRDNNN4",
                "SignId": "yDCjFUUckp48fiwwUyh7ukYvjx5PR1e2"
            }
        ],
        "FlowId": "yDCjFUUckp48fiwyUyh7ukYEdXdSyJps",
        "RequestId": "ca0fd107-4337-4650-8236-aa3e4561f7ef"
    }
}

5. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.System	系统错误，请稍后重试。
InvalidParameter.CancelReason	不合法的撤销取消理由，将检查长度，内容，并在修改后重试。
InvalidParameter.ParamError	参数错误。
InvalidParameter.Status	参数Status不正确。
MissingParameter.CancelReason	缺少撤销取消理由，请检查修改后重试。
OperationDenied	操作被拒绝。
OperationDenied.FlowHasTerminated	签署流程已经被终止，请检查。
OperationDenied.Forbid	禁止此项操作。
OperationDenied.NoIdentityVerify	未通过个人实名认证。
OperationDenied.WhiteListForbid	未开通功能白名单，请联系客服处理。
ResourceNotFound.Flow	签署流程未找到，请检查参数。
ResourceNotFound.NotExistFlow	流程不存在。
ResourceUnavailable	资源不可用。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。