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

1. 接口描述

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

通过模板创建签署流程

适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。

注：配合创建电子文档和发起签署流程接口使用。整体的逻辑如下图

注：静默（自动）签署不支持合同签署方存在填写功能

相关视频指引

1. 创建静默（自动）签署模板和开通自动签署
   
2. 用模板创建发起合同
   

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateFlow。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。使用此接口时，必须填写userId。 支持填入集团子公司经办人 userId 代发合同。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
FlowName	是	String	合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。 示例值：张三的入职合同
Approvers.N	是	Array of FlowCreateApprover	合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。 注: 在发起流程时，需要保证 approver 中的顺序与模板定义顺序一致，否则会发起失败。 例如，如果模板中定义的第一个参与人是个人用户，第二个参与人是企业员工，则在 approver 中传参时，第一个也必须是个人用户，第二个参与人必须是企业员工。 点击查看模板参与人顺序定义位置
FlowDescription	否	String	合同流程描述信息(可自定义此描述)，最大长度1000个字符。
FlowType	否	String	合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。 此合同类型需要跟模板配置的合同类型保持一致。 示例值：劳务合同
ClientToken	否	String	已经废弃字段，客户端Token，保持接口幂等性,最大长度64个字符
DeadLine	否	Integer	合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。 示例值：1604912664
RemindedOn	否	Integer	合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。 到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
UserData	否	String	调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
Unordered	否	Boolean	合同流程的签署顺序类型： false：(默认)有序签署, 本合同多个参与人需要依次签署 true：无序签署, 本合同多个参与人没有先后签署限制 注：请和模板中的配置保持一致 示例值：true
CustomShowMap	否	String	您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量： {合同名称} {发起方企业} {发起方姓名} {签署方N企业} {签署方N姓名} 其中，N表示签署方的编号，从1开始，不能超过签署人的数量。 例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}，则小程序中列表页展示此合同为以下样子 合同名称：租房合同 发起方：腾讯公司(张三) 签署方：李四 示例值：合同名称:{合同名称};发起方: {发起方企业}的{发起方姓名}大佬！;净重: 100吨;品类: 铁矿石
NeedSignReview	否	Boolean	发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下： false：（默认）不需要审批，直接签署。 true：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。 注：此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同 示例值：true
Agent	否	Agent	代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
CcInfos.N	否	Array of CcInfo	合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
AutoSignScene	否	String	个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签） OTHER : 通用场景 注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。 示例值：E_PRESCRIPTION_AUTO_SIGN

3. 输出参数

4. 示例

示例1 创建单C流程

创建一个单C流程

输入示例

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

{
    "UserData": "5a2X56ym5Liy",
    "FlowName": "西红柿购买合同",
    "FlowDescription": "2024年西红柿购买合同",
    "FlowType": "采购合同",
    "Approvers": [
        {
            "ApproverType": "1",
            "Required": "true",
            "NotifyType": "SMS",
            "ApproverMobile": "113200000000",
            "ApproverName": "典子谦"
        }
    ],
    "DeadLine": "1652931170",
    "Operator": {
        "UserId": "yDRSRUUgygj6qnwfUuO4zjEwc193c2hH"
    },
    "Unordered": "true"
}

输出示例

{
    "Response": {
        "FlowId": "yDRS4UUgygqdcj2tUuO4zjEEFuP35Swc",
        "RequestId": "2632a7fceef"
    }
}

示例2 创建签署流程

创建一个B2C流程

输入示例

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

{
    "Operator": {
        "UserId": "yDRSRUUgygj6qnwfUuO4zjEwc193c2hH"
    },
    "FlowName": "西红柿采购合同",
    "Unordered": false,
    "DeadLine": 1604912664,
    "Approvers": [
        {
            "ApproverType": 0,
            "OrganizationName": "典子谦示例企业",
            "Required": true,
            "ApproverName": "典子谦",
            "ApproverMobile": "13200000000"
        },
        {
            "ApproverType": 1,
            "Required": true,
            "ApproverName": "李四",
            "ApproverMobile": "15100000000"
        }
    ]
}

输出示例

{
    "Response": {
        "FlowId": "yDwfGUUckps86q8kUoTIbgRXTZbVk9I2",
        "RequestId": "001uSHUNDy"
    }
}

示例3 创建含有动态签署人流程，签署方不指定具体的签署人

创建一个B2C流程，两方签署方不指定具体的签署人
注：
1.签署人相关信息为空，如：姓名、手机号码等
2.FillType需传值为1，表示为动态签署人（不确定具体的签署人），需后续进行补充。

输入示例

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

{
    "Operator": {
        "UserId": "yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR"
    },
    "FlowName": "西瓜购买合同",
    "Unordered": false,
    "DeadLine": 1604912664,
    "Approvers": [
        {
            "ApproverType": 0,
            "Required": true,
            "ApproverOption": {
                "FillType": 1
            }
        },
        {
            "ApproverType": 1,
            "Required": true,
            "ApproverOption": {
                "FillType": 1
            }
        }
    ]
}

输出示例

{
    "Response": {
        "FlowId": "yDRS4UUgygqdcj5pUuO4zjEu602GFIe6",
        "RequestId": "4zjEBpXdcsHWX"
    }
}

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

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