管理签署流程截止时间

1. 接口描述

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

在已发起的签署流程中，支持对签署截止日期进行延期操作，主要涉及以下两个维度：

1. 合同（流程）维度：只需要传递签署流程ID。这将对签署流程和发起时未单独设定签署截止时间的签署人进行延期操作。
2. 签署人维度：需要传递流程ID和签署人ID。此操作将对签署人进行延期操作，尤其对于有序的合同（流程），签署截止时间不能超过后一位合同（流程）签署人的流程截止时间。

此接口有如下限制条件：

1. 执行操作的员工需为发起方企业的超级管理员、法定代表人或签署流程的发起人。
2. 在延长整个签署流程时，签署流程应至少还有一方未签署（即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态）。
3. 在延长整个签署流程时，新的签署截止日期应晚于合同已设定的签署截止日期和当前日期。
4. 在延长签署方的截止时间时，签署方不能处于流程完结或已终止状态（即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态）。
5. 在延长签署方的截止时间时，签署方的新签署截止日期应晚于当前日期和签署方已设定的截止日期。若为有序合同，还应早于或等于下一签署人的截止日期，且早于签署流程整体的截止日期。
6. 不支持操作合同组合同。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 延期签署方的签署截止时间

1.将签署流程yDCNtUUckpvrezq3UudRJ1LEXDLa8Lga 中 签署人角色编号 yDwhyUUckp2cmuh4Uu2bfpvRH48OvSw7 对应的签署人设置的签署截止时间延长到1705976964

输入示例

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

{
    "Operator": {
        "UserId": "yDRt2UUgygqxyp7yUuO5zjEwqXwsIljA"
    },
    "FlowId": "yDCNtUUckpvrezq3UudRJ1LEXDLa8Lga",
    "Deadline": 1705976964,
    "RecipientId": "yDwhyUUckp2cmuh4Uu2bfpvRH48OvSw7"
}

输出示例

{
    "Response": {
        "RequestId": "s1705924585583461780"
    }
}

示例2 延期签署方的签署截止时间失败-签署流程已过期

1.将签署流程yDCNtUUckpvrezq3UudRJ1LEXDLa9Lga中 签署人角色编号yDwhyUUckp2cmuh4Uu2bfpvRH48OvSw8 对应的签署人设置的签署截止时间延长到1705976980
2.此时合同已经过期，无法操作

输入示例

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

{
    "Operator": {
        "UserId": "yDRt2UUgygqxyp7yUuO5zjEwqXwsIljA"
    },
    "FlowId": "yDCNtUUckpvrezq3UudRJ1LEXDLa9Lga",
    "Deadline": 1705976980,
    "RecipientId": "yDwhyUUckp2cmuh4Uu2bfpvRH48OvSw8"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "FailedOperation",
            "Message": "此签署流程已经终止，当前处于流程已经过期状态，无法进行延期操作，请确认后重试"
        },
        "RequestId": "s1705991274996790452"
    }
}

示例3 延期整个合同-合同发起时有签署人单独设置了签署截止时间

1.合同发起时设置合同截止时间为1704988032，该合同有3个签署人A，B，C
2.合同发起时A签署人设置签署截止时间为1704978032，B，C签署人未单独设置签署人截止时间（默认和合同保持一致）
3.通过接口对整个合同延期后，A签署人截止时间不变（还是1704978032），B，C签署人的签署截止时间和合同截止时间延期为1705977064

输入示例

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

{
    "Operator": {
        "UserId": "yDRt2UUgygqxyp7yUuO5zjEwqXwsIljA"
    },
    "FlowId": "yDCNtUUckpvrcvf4UELZnZDvMStFgT7K",
    "Deadline": 1705977064
}

输出示例

{
    "Response": {
        "RequestId": "s1705924585583461781"
    }
}

示例4 延期整个合同-合同发起时没有签署人设置签署人签署截止时间

1.合同发起时设置合同截止时间为1704988032，该合同有3个签署人A，B，C
2.合同发起时并未为签署人未单独设置签署人截止时间（默认和合同保持一致）
3.通过接口对整个合同延期后，A，B，C签署人的签署截止时间和合同截止时间延期为1705977064

输入示例

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

{
    "Operator": {
        "UserId": "yDRt2UUgygqxyp7yUuO5zjEwqXwsIljA"
    },
    "FlowId": "yDCNtUUckpvrcvf4UELZnZDvMStFgT7K",
    "Deadline": 1705977064
}

输出示例

{
    "Response": {
        "RequestId": "s1705924585583461781"
    }
}

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. 错误码

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