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

1. 接口描述

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

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

签署人类别	需要提前准备的信息
自己企业的员工签署（未认证加入或已认证加入）	签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）
自己企业的员工签署（已认证加入）	签署企业的名字、员工在电子签平台的ID（UserId）
其他企业的员工签署	签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）
个人（自然人）签署	个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）

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

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

相关视频指引
1. 创建静默（自动）签署模板和开通自动签署
2. 用模板创建发起合同

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

推荐使用 API Explorer

点击调试

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

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个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。 注 1. 抄送人名单中可以包括自然人以及本企业的员工。 2. 请确保抄送人列表中的成员不与任何签署人重复。
AutoSignScene	否	String	个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传： E_PRESCRIPTION_AUTO_SIGN：电子处方单（医疗自动签） OTHER : 通用场景 注: 个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。 示例值：E_PRESCRIPTION_AUTO_SIGN
FlowDisplayType	否	Integer	在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下： 0 :合同（默认值） 1 :文件 2 :协议 效果如下: 示例值：1

3. 输出参数

参数名称	类型	描述
FlowId	String	合同流程ID，为32位字符串。 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 注: 此返回的合同流程ID，需再次调用创建电子文档和发起签署流程接口将合同开始后，合同才能进入签署环节，点击查看FlowId在控制台中的位置（只在进入签署环节后有效）
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

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

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

错误码	描述
FailedOperation	操作失败。
FailedOperation.AgeNotAchieveNormalLegal	年龄限制无法使用电子签服务，请联系客服咨询处理。
FailedOperation.FlowHasDocument	签署流程已有关联文档，请检查参数修改后重试。
FailedOperation.NotFoundShadowUser	未找到集团子企业相关用户信息，请检查用户相关参数
FailedOperation.OrganizationExperienceChange	企业经营状态与工商局信息不符。
FailedOperation.OrganizationNameChanged	企业名称与工商局信息不符。
FailedOperation.OrganizationNameNeedChange	企业名称与工商局信息不符,需要超管修改。
FailedOperation.RequestLimitExceeded	请求的次数超过了频率限制，请联系客服处理。
FailedOperation.UserInfoNoMatch	用户信息不匹配，请检查后重试。
InternalError.Db	数据库异常。
InternalError.DbInsert	数据库新增记录出错。
InternalError.DbRead	内部错误,数据库查询失败,请稍后重试。
InternalError.Decryption	解密失败。
InternalError.DependsApi	依赖的第三方API返回错误。
InternalError.DependsDb	数据库执行错误。
InternalError.Encryption	加密失败。
InternalError.System	系统错误，请稍后重试。
InvalidParameter.ApproverType	不合法的签署人类型，请检查后重试。
InvalidParameter.CardNumber	不合法的证件信息，请检查证件号证件类型是否正确。
InvalidParameter.CardType	不合法的证件信息，请检查证件号证件类型是否正确。
InvalidParameter.CcNum	不合法的抄送方设置，请联系客服了解抄送设置规则，修改后重试。
InvalidParameter.ClientToken	ClientToken不合法请检查。
InvalidParameter.CustomShowMap	无效的自定义页卡模板，请检查后重试。
InvalidParameter.FlowCallbackUrl	不合法的签署流程回调链接，请修改后重试。
InvalidParameter.FlowDeadLine	不合法的签署流程截止日期，请修改后重试。
InvalidParameter.FlowDescription	不合法的签署流程描述，请修改后重试。
InvalidParameter.FlowName	不合法的签署流程名称，请修改后重试。
InvalidParameter.FlowType	不合法的签署流程类型，请修改后重试。
InvalidParameter.FlowUserData	不合法的签署流程用户自定义数据，请修改后重试。
InvalidParameter.FromSource	不合法的FromSource，请联系开发，检查后重试。
InvalidParameter.IdCardValidityOverLimit	用户个人证件已过期。
InvalidParameter.InvalidMobile	手机号码不正确。
InvalidParameter.InvalidName	姓名不正确。
InvalidParameter.Mobile	不合法的手机号，请检查后重试。
InvalidParameter.Name	不合法的用户名称，请修改后重试。
InvalidParameter.NotifyType	不支持的通知类型，请检查并联系客服处理。
InvalidParameter.OrganizationName	不合法的企业名称，请修改后重试。
InvalidParameter.ParamError	参数错误。
InvalidParameter.PersonAutoSignTag	个人静默签Tag未设置，请检查后重试。
InvalidParameter.PreReadTime	不合法的阅读时长限制，请联系客服了解阅读时长设置规则，修改后重试。
InvalidParameterValue.Mask	需要屏蔽的告警。
LimitExceeded	超过配额限制。
MissingParameter.ApproverMobile	缺少签署人手机号，请检查后重试。
MissingParameter.ApproverName	缺少签署人姓名，请检查后重试。
MissingParameter.ApproverOrganizationInfo	缺少签署人企业信息，请检查后重试。
OperationDenied	操作被拒绝。
OperationDenied.ApproverRepeat	签署人重复，请联系客服了解发起签署流程签署人规则，修改后重试。
OperationDenied.BranchSendFlowToParentNotAllow	子公司不能发起本方母体公司的合同。
OperationDenied.CcForbid	当前不支持抄送，请联系客服咨询处理。
OperationDenied.CcUserRepeat	抄送方存在相同抄送人，请检查修改后重试。
OperationDenied.Forbid	禁止此项操作。
OperationDenied.InvalidApproverAge	签署人年龄限制无法使用电子签服务。
OperationDenied.NoIdentityVerify	未通过个人实名认证。
OperationDenied.NoLogin	用户未登录,请先登录后再操作。
OperationDenied.NoOpenServerSign	未开通静默签功能，请联系签署方企业开通后重试。
OperationDenied.NoQuota	企业额度不足，请检查企业额度后处理。
OperationDenied.OrgUniformSocialCreditCodeErr	此社会信用编码未查询到结果，请检查后重试。
OperationDenied.OrganizationNotActivated	企业未激活。
OperationDenied.OutQueryLimit	查询限频，请先联系客服了解限频策略，稍后重试。
OperationDenied.OverSeaForbid	当前不支持境外用户，请联系客服咨询处理。
OperationDenied.PersonHasNoSignature	个人名下没用可使用的签名，请联系个人配置签名后重试。
OperationDenied.PersonNoOpenServerSign	该用户已关闭或者未开启自动签服务，请检查后重试。
OperationDenied.WhiteListForbid	未开通功能白名单，请联系客服处理。
RequestLimitExceeded	请求的次数超过了频率限制。
ResourceNotFound	资源不存在。
ResourceNotFound.Application	应用号不存在或已删除。
ResourceNotFound.AuthActiveOrganization	机构未完成认证激活，请检查并联系客服处理。
ResourceNotFound.FlowApprover	签署流程的签署人不存在，请检查后重试。
ResourceNotFound.Organization	机构不存在或者未完成认证，请检查机构信息。
ResourceNotFound.SuperAdmin	超管信息不存在，请检查企业认证信息。
ResourceNotFound.User	用户或者员工信息不存在，请检查参数后重试。
ResourceNotFound.VerifyUser	用户或者员工未完成实名认证，请检查参数后重试。
ResourceUnavailable	资源不可用。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。