模板发起合同-创建签署流程
1. 接口描述
接口请求域名： ess.tencentcloudapi.com 。
通过模板创建签署流程
适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
注：该接口是通过模板生成合同流程的前置接口，先创建一个不包含签署文件的流程。
配合“创建电子文档”接口和“发起流程”接口使用。
默认接口请求频率限制：300次/秒。
推荐使用 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方 |
| FlowType | 否 | String | 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符 |
| ClientToken | 否 | String | 客户端Token，保持接口幂等性,最大长度64个字符 |
| DeadLine | 否 | Integer | 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间一年后 |
| UserData | 否 | String | 用户自定义字段，回调的时候会进行透传，长度需要小于20480 |
| FlowDescription | 否 | String | 签署流程描述,最大长度1000个字符 |
| Unordered | 否 | Boolean | 发送类型： true：无序签 false：有序签 注：默认为false（有序签），请和模板中的配置保持一致 |
| CustomShowMap | 否 | String | 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始 |
| NeedSignReview | 否 | Boolean | 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。 若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。 |
| Agent | 否 | Agent | 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填 |
| CcInfos.N | 否 | Array of CcInfo | 被抄送人的信息列表。 注: 此功能为白名单功能，若有需要，请联系电子签客服开白使用。 |
| AutoSignScene | 否 | String | 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FlowId | String | 签署流程编号 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建单C流程
创建一个单C流程
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlow
<公共请求参数>
{
"RelatedFlowId": "xxx",
"UserData": "字符串",
"FlowName": "字符串",
"FlowDescription": "字符串",
"FlowType": "字符串",
"Approvers": [
{
"OrganizationName": "字符串",
"ApproverType": "1",
"IsFullText": "false",
"VerifyChannel": [
"WEIXIN"
],
"Required": "true",
"UserId": "",
"RecipientId": "",
"NotifyType": "SMS",
"ApproverMobile": "135****6345",
"ApproverName": "史国富",
"PreReadTime": "5"
}
],
"DeadLine": "1652931170",
"ClientToken": "字符串",
"Operator": {
"UserId": "yDxMkUy*****E8VI2JmKxPkk"
},
"Unordered": "true",
"CallbackUrl": ""
}
输出示例
{
"Response": {
"FlowId": "yDR8YUUg****O4zjEuwxLMnR24",
"RequestId": "2846e98d-xxxxx2632a7fceef"
}
}
示例2 创建签署流程
创建一个B2C流程
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlow
<公共请求参数>
{
"Operator": {
"UserId": "1956103********520fde6a"
},
"FlowName": "测试",
"Unordered": false,
"DeadLine": 1604912664,
"CustomShowMap": "合同名称:{合同名称} {发起方企业} {发起方姓名};国家:中国;发起方:{发起方企业};签署方1: {签署方1企业};签署方2: {签署方2企业}{签署方2姓名};签署方3: {签署方3姓名}",
"Approvers": [
{
"ApproverType": 0,
"OrganizationName": "***有限公司",
"Required": true,
"ApproverName": "张三",
"ApproverMobile": "185****11111"
},
{
"ApproverType": 1,
"Required": true,
"ApproverName": "李四",
"ApproverMobile": "185****2222"
}
]
}
输出示例
{
"Response": {
"FlowId": "2fb48c3945****65aaedf6",
"RequestId": "s1234345677xxxx"
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| 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 | 请升级到对应版本后即可使用该接口。 |