腾讯电子签集成版通过多模板创建合同组签署流程

1. 接口描述

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

接口（ChannelCreateFlowGroupByTemplates）用于通过多模板创建合同组签署流程。

该接口允许通过选择多个模板一次性创建多个合同，这些合同被组织在一个合同组中。
每个签署方将收到一个签署链接，通过这个链接可以访问并签署合同组中的所有合同。
合同组中的合同必须作为一个整体进行签署，不能将合同组拆分成单独的合同进行逐一签署。

2. 适用场景

该接口适用于需要一次性完成多份合同签署的情况，多份合同一般具有关联性，用户以目录的形式查看合同。

3. 发起方要求和签署方实名要求

发起方要求：作为合同发起方的第三方子企业A的员工必须进行实名认证。
签署方要求：签署方可以是多种身份（如第三方子企业的员工、个人、SaaS平台企业员工），其中企业和员工可以不进行实名认证。

可以作为发起方和签署方的角色列表

场景编号	可作为发起方类型	可作为签署方的类型
场景一	第三方子企业A员工	第三方子企业A员工
场景二	第三方子企业A员工	第三方子企业B员工
场景三	第三方子企业A员工	个人/自然人
场景四	第三方子企业A员工	SaaS平台企业员工

4. 签署方参数差异

根据签署方的不同类型（第三方子企业的员工、个人、SaaS平台企业员工），传递的参数也不同。具体参数的结构和要求可以参考开发者中心提供的 FlowApproverInfo 结构体说明。

5. 合同额度的扣减与返还

扣减时机：合同一旦发起，相关的合同额度就会被扣减，合同组下面的每个合同都要扣减一个合同额度。
返还条件：只有在合同被撤销且没有任何签署方签署过，或者只有自动签署的情况下，合同额度才会被返还。
不返还的情况：如果合同已过期、被拒签、签署完成或已解除，合同额度将不会被返还。

6. 静默（自动）签署的限制

在使用静默（自动）签署功能时，合同签署方不能有填写控件。此接口静默签(企业自动签)能力为白名单功能，使用前请联系对接的客户经理沟通。

7.合同组暂不支持抄送功能

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ChannelCreateFlowGroupByTemplates。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
Agent	是	Agent	合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置此接口下面信息必填。渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）合同的发起企业和发起人必需已经完成实名，并加入企业
FlowInfos.N	是	Array of FlowInfo	合同组中每个合同签署流程的信息，合同组中最少包含2个合同，不能超过50个合同。
FlowGroupName	是	String	合同组的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。示例值："2023年采购合同们"

3. 输出参数

参数名称	类型	描述
FlowGroupId	String	合同组ID，为32位字符串。建议开发者妥善保存此合同组ID，以便于顺利进行后续操作。示例值：yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
FlowIds	Array of String	合同组中每个合同流程ID，每个ID均为32位字符串。注: `此数组的顺序和入参中的FlowInfos顺序一致` 示例值：["yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT","yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS"]
TaskInfos	Array of TaskInfo	复杂文档合成任务（如，包含动态表格的预览任务）的任务信息数组；如果文档需要异步合成，此字段会返回该异步任务的任务信息，后续可以通过ChannelGetTaskResultApi接口查询任务详情；
Approvers	Array of FlowGroupApprovers	合同组签署方信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 通过多模板创建有2个合同的合同组

入参中FlowFileInfos有2个元素, 表示2个合同组成此合同组
每个合同都是B2C合同

输入示例

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "kev_8"
        },
        "ProxyOrganizationOpenId": "kev_open_organization_8",
        "AppId": "16fd2f7d7ae85d13ca5f8d501d57b5ec"
    },
    "FlowGroupName": "2023年张三入职合同组合",
    "FlowInfos": [
        {
            "FlowName": "2023年张三入职合同",
            "FlowApprovers": [
                {
                    "OrganizationName": "典子谦示例企业",
                    "OrganizationOpenId": "kev_open_organization_8",
                    "OpenId": "kev_8",
                    "ApproverType": "ORGANIZATION",
                    "RecipientId": "yDwgKUUckp1jdybwUWptGKyGVpNME9fH"
                },
                {
                    "Name": "张三",
                    "Mobile": "18888888888",
                    "ApproverType": "PERSON",
                    "RecipientId": "yDwgKUUckp1jdybvUWptGKBD9TeupFMV"
                }
            ],
            "Deadline": 1698202075,
            "TemplateId": "yDwgKUUckp1jdy4dUWptGKRavSGWt9cW"
        },
        {
            "FlowName": "2023年张三入职保密协议",
            "FlowApprovers": [
                {
                    "OrganizationName": "典子谦示例企业",
                    "OrganizationOpenId": "kev_open_organization_8",
                    "OpenId": "kev_8",
                    "ApproverType": "ORGANIZATION",
                    "RecipientId": "yDwgKUUckp1jdybwUWptGKyGVpNME9fH"
                },
                {
                    "Name": "张三",
                    "Mobile": "18888888888",
                    "ApproverType": "PERSON",
                    "RecipientId": "yDwgKUUckp1jdybvUWptGKBD9TeupFMV"
                }
            ],
            "Deadline": 1698202075,
            "TemplateId": "yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR"
        }
    ]
}

输出示例

{
    "Response": {
        "FlowGroupId": "yDwiwUUckpo0n304UuwJzdxCQJhOooyw",
        "FlowIds": [
            "yDwiwUUckpo0n30bUuwJzdxxvnaMZpxW",
            "yDwiwUUckpo0n30uUuwJzdxxwyCoXw1Z"
        ],
        "RequestId": "s1698201691021218250",
        "TaskInfos": [
            {
                "TaskId": "",
                "TaskStatus": ""
            },
            {
                "TaskId": "",
                "TaskStatus": ""
            }
        ]
    }
}

示例2 通过多模板创建有2个合同的合同组，指定每个子合同第一方为动态签署方

入参中FlowFileInfos有2个元素, 表示2个合同组成此合同组
每个合同都是B2C合同
4.指定子合同一方为动态签署方（即不指定具体签署人，FillType=1），可在发起后再进行补充。

输入示例

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "kev_8"
        },
        "ProxyOrganizationOpenId": "kev_open_organization_8",
        "AppId": "16fd2f7d7ae85d13ca5f8d501d57b5ec"
    },
    "FlowGroupName": "2023年张三入职合同组合",
    "FlowInfos": [
        {
            "FlowName": "2023年张三入职合同",
            "FlowApprovers": [
                {
                    "ApproverOption": {
                        "FillType": 1
                    },
                    "ApproverType": "ORGANIZATION",
                    "RecipientId": "yDwgKUUckp1jdybwUWptGKyGVpNME9fH"
                },
                {
                    "Name": "张三",
                    "Mobile": "18888888888",
                    "ApproverType": "PERSON",
                    "RecipientId": "yDwgKUUckp1jdybvUWptGKBD9TeupFMV"
                }
            ],
            "Deadline": 1698202075,
            "TemplateId": "yDwgKUUckp1jdy4dUWptGKRavSGWt9cW"
        },
        {
            "FlowName": "2023年张三入职保密协议",
            "FlowApprovers": [
                {
                    "ApproverOption": {
                        "FillType": 1
                    },
                    "ApproverType": "ORGANIZATION",
                    "RecipientId": "yDwgKUUckp1jdybwUWptGKyGVpNME9fH"
                },
                {
                    "Name": "张三",
                    "Mobile": "18888888888",
                    "ApproverType": "PERSON",
                    "RecipientId": "yDwgKUUckp1jdybvUWptGKBD9TeupFMV"
                }
            ],
            "Deadline": 1698202075,
            "TemplateId": "yDRS4UUgygqdcj51UuO4zjEyWTmzsIAR"
        }
    ]
}

输出示例

{
    "Response": {
        "Approvers": [
            {
                "Approvers": [
                    {
                        "ApproverRoleName": "",
                        "RecipientId": "yDSx0UUckptqcu0rUuvGhoq88RKQezmP",
                        "SignId": "yDCVHUUckpwbqurqUuyXGHS1da6wB7v2"
                    },
                    {
                        "ApproverRoleName": "",
                        "RecipientId": "yDCVHUUckpwbqurlUuyXGHSChXDgrj1C",
                        "SignId": "yDCVHUUckpwbqurgUuyXGHS1cwtnpm8o"
                    }
                ],
                "FlowId": "yDCVHUUckpwbqur3UuyXGHSxpj1wPeJn"
            },
            {
                "Approvers": [
                    {
                        "ApproverRoleName": "",
                        "RecipientId": "yDSx0UUckptqcu0rUuvGhoq88RKQezmP",
                        "SignId": "yDCVHUUckpwbqursUuyXGHSCOm804z86"
                    },
                    {
                        "ApproverRoleName": "",
                        "RecipientId": "yDCVHUUckpwbqurrUuyXGHS8cOo8z4Vc",
                        "SignId": "yDCVHUUckpwbqulcUuyXGHSSvCaqc6He"
                    }
                ],
                "FlowId": "yDCVHUUckpwbqur1UuyXGHS1JCWpHawy"
            }
        ],
        "FlowGroupId": "yDCVHUUckpwbqurkUuyXGHS89Y9LLM4x",
        "FlowIds": [
            "yDCVHUUckpwbqur3UuyXGHSxpj1wPeJn",
            "yDCVHUUckpwbqur1UuyXGHS1JCWpHawy"
        ],
        "RequestId": "s1711352113176693412",
        "TaskInfos": [
            {
                "TaskId": "",
                "TaskStatus": ""
            },
            {
                "TaskId": "",
                "TaskStatus": ""
            }
        ]
    }
}

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

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

错误码	描述
InternalError	内部错误。
InternalError.Db	数据库错误。
InternalError.Decryption	解密错误。
InternalError.Encryption	加密错误。
InternalError.GenerateId	生成唯一ID错误。
InternalError.System	系统错误。
InternalError.ThirdParty	第三方错误。
InvalidParameter	参数错误。
InvalidParameter.Application	应用号不存在。
InvalidParameter.ApproverVerifyType	ApproverVerifyType参数值非法
InvalidParameter.BizApproverAlreadyExists	重复添加签署人。
InvalidParameter.DataNotFound	数据不存在。
InvalidParameter.FlowInfos	参数错误，FlowInfos非法，请修改后重试。
InvalidParameter.MissingRequiredParameterValue	缺少必填参数的值。
InvalidParameter.Mobile	手机号码不正确。
InvalidParameter.ParamError	参数错误。
InvalidParameterValue	参数取值错误。
LimitExceeded	超过配额限制。
LimitExceeded.CreateFlowNum	超出流程创建数量限制。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
OperationDenied.NoIdentityVerify	未通过个人实名。
OperationDenied.UserNotInOrganization	用户不归属于当前企业，无法操作，请检查后重试。
ResourceNotFound	资源不存在。
ResourceNotFound.Application	应用号不存在。
ResourceNotFound.Template	模板不存在。
ResourceNotFound.User	用户信息不存在。
ResourceUnavailable	资源不可用。
UnauthorizedOperation	未授权操作。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。

通过多模板创建合同组签署流程

本页目录：

1. 接口描述

2. 适用场景

3. 发起方要求和签署方实名要求

4. 签署方参数差异

5. 合同额度的扣减与返还

6. 静默（自动）签署的限制

7.合同组暂不支持抄送功能

2. 输入参数

3. 输出参数

4. 示例

示例1 通过多模板创建有2个合同的合同组

输入示例

输出示例

示例2 通过多模板创建有2个合同的合同组，指定每个子合同第一方为动态签署方

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码