跳到主要内容

管理签署流程截止时间

1. 接口描述​

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

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

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

此接口有如下限制条件：

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

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：ModifyFlowDeadline。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
Agent是Agent应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
FlowId是String合同流程ID，为32位字符串。
  • 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
  • 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。

示例值：yDCNtUUckpvrcvf4UELZnZDvMStFgT7K
Deadline是Integer签署流程或签署人新的签署截止时间，格式为Unix标准时间戳（秒）

示例值：1705992543
RecipientId否String签署方角色编号，为32位字符串
  • 若指定了此参数，则只调整签署流程中此签署人的签署截止时间，否则调整合同整体的签署截止时间（合同截止时间+发起时未设置签署人截止时间的参与人的签署截止时间）
  • 通过用PDF文件创建签署流程发起合同，或通过用模板创建签署流程时，返回参数FlowApprovers会返回此信息，建议开发者妥善保存
  • 也可通过获取合同信息接口查询签署人的RecipientId编号

示例值：yDwhyUUckp1cmuh4Uu2bfpvRH38OvSw7

3. 输出参数​

参数名称类型描述
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

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

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

输入示例​

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

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "FlowId": "yDCNtUUckpvrezq3UudRJ1LEXDLa8Lga",
    "Deadline": 1705976964,
    "RecipientId": "yDwhyUUckp2cmuh4Uu2bfpvRH48OvSw7"
}

输出示例​

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

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

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

输入示例​

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

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "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: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyFlowDeadline
<公共请求参数>

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "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: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyFlowDeadline
<公共请求参数>

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "FlowId": "yDCNtUUckpvrcvf4UELZnZDvMStFgT7K",
    "Deadline": 1705977064
}

输出示例​

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

5. 错误码​

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

错误码描述
FailedOperation.NotAvailableSignReview当前合同状态无法进行签署审批。
InternalError内部错误。
InternalError.Db数据库错误。
InvalidParameter参数错误。
InvalidParameter.ParamError参数错误。
InvalidParameter.Status状态异常。
MissingParameter缺少参数错误。
OperationDenied操作被拒绝。
OperationDenied.NoFlowPermission无权操作合同。
ResourceNotFound资源不存在。
ResourceNotFound.Flow未找到对应流程。
ResourceUnavailable资源不可用。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
UnknownParameter未知参数错误。
UnsupportedOperation操作不支持。
更多开发者交流反馈
购买咨询
4006-808-062
4006-808-062