结束动态签署流程
1. 接口描述
接口请求域名： essbasic.tencentcloudapi.com 。
该接口用于结束动态签署方2.0的合同流程。
功能开通
- 动态签署方2.0功能的使用需要先联系产品经理开通模块化计费功能，然后到控制台中打开此功能。详细的使用说明请参考动态签署方2.0文档。
使用条件
- 此接口只能在合同处于非终态且所有的签署方都已经完成签署。一旦合同进入终态（例如：过期、拒签、撤销或者调用过此接口成功过），将无法通过此接口结束合同流程。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ArchiveDynamicFlow。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-26。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Agent | 是 | Agent | 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。
第三方平台子客企业和员工必须已经过实名认证 |
| FlowId | 是 | String | 合同流程ID 示例值："yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm" |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FlowId | String | 合同流程ID 示例值：yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm |
| Approvers | Array of ChannelArchiveDynamicApproverData | 动态签署人的参与人信息 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.System | 系统错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.Application | 应用号不存在。 |
| InvalidParameter.EndPoint | 不合法的EndPoint，请检查修改后重试。 |
| InvalidParameter.FlowIds | 参数错误，合同id列表长度非法，请检查后重试。 |
| InvalidParameter.GenerateType | 参数错误，不受支持的GenerateType，请检查后重试。 |
| InvalidParameter.ParamError | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| MissingParameter.FlowIdsOrFlowGroupId | 请传入需要查询的合同或合同组的ID。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.NoIdentityVerify | 未通过个人实名。 |
| OperationDenied.UserNotInOrganization | 用户不归属于当前企业，无法操作，请检查后重试。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.Application | 应用号不存在。 |
| ResourceNotFound.FlowGroup | 合同组不存在。 |
| ResourceNotFound.Template | 模板不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |
