结束动态签署流程

1. 接口描述

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

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

功能开通

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

使用条件

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

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 结束动态签署合同

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

输入示例

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "openidxxxx"
        },
        "ProxyOrganizationOpenId": "testorgopenid",
        "AppId": "15edb41f2ee412f5ff533ac0185ebxxxxx"
    },
    "FlowId": "yDCmVUUckpufezuiUxQQFiT8Exxxxxxxx"
}

输出示例

{
    "Response": {
        "Approvers": [
            {
                "SignId": "yDCmDUUckpuf0hsfUuvalvQtaxxxxxxx",
                "RecipientId": "yDCmDUUckpuf0hseUuvalvQRmxxxxxx"
            }
        ],
        "FlowId": "yDCmDUUckpuf0hsmUuvalvQyxxxxxxxxx",
        "RequestId": "34ded0a6-e679-4af7-a07e-ca4573124213"
    }
}

示例2 结束动态签署合同失败

未签署完成前结束

输入示例

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "openidxxxx"
        },
        "ProxyOrganizationOpenId": "testorgopenid",
        "AppId": "15edb41f2ee412f5ff533ac0185ebxxxxx"
    },
    "FlowId": "yDCjFUUckp4jkz76UoofpTx3iZ3A3C3x"
}

输出示例

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

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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