模板发起合同-发起签署流程

1. 接口描述

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

此接口用于启动流程。它是模板发起合同的最后一步。
在创建签署流程和创建电子文档之后，用于开始整个合同流程, 推进流程进入到签署环节。

注：
1.合同发起后就会扣减合同的额度, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）

2.静默（自动）签署不支持非本企业合同签署方存在填写功能

3.在发起签署流程之前，建议等待 PDF合成完成的回调，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 正常启动签署流程

启动签署流程

输入示例

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

{
    "Operator": {
        "UserId": "yDxZ1UyKQDSIMaUuO5zjEypPWudeHbnG"
    },
    "FlowId": "yDwJ0UUckpk2071xUxgm9jJEvuhEhqD7"
}

输出示例

{
    "Response": {
        "Status": "START",
        "RequestId": "xgm9jJv5GGyJXCh"
    }
}

示例2 启动签署流程-电子文档尚未准备好

在调用此接口时，若流程电子文档尚未准备就绪，将返回相关错误信息。
在此状态下，可以进行重试。
通常建议在调用创建签署流程电子文档接口后等待3秒，再调用此接口以启动签署流程。

输入示例

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

{
    "Operator": {
        "UserId": "yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc"
    },
    "FlowId": "yDRS4UUgygqdcjjtUuO4zjESYiOVONL1"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "OperationDenied.DocumentNoAvailable",
            "Message": "电子文档不可用，请稍后重试。"
        },
        "RequestId": "uO4zjEwxRFIf8q1"
    }
}

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

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