跳到主要内容

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

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. 输出参数​

参数名称类型描述
FlowGroupIdString合同组ID，为32位字符串。
建议开发者妥善保存此合同组ID，以便于顺利进行后续操作。
示例值：yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
FlowIdsArray of String合同组中每个合同流程ID，每个ID均为32位字符串。

注:
此数组的顺序和入参中的FlowInfos顺序一致
示例值：["yDRSRUUgygj6rqi6UuO4zjEBDACwAjgT","yDRS4UUgygqdcjjdUuO4zjEC0osCOsHS"]
TaskInfosArray of TaskInfo复杂文档合成任务（如，包含动态表格的预览任务）的任务信息数组；
如果文档需要异步合成，此字段会返回该异步任务的任务信息，后续可以通过ChannelGetTaskResultApi接口查询任务详情；
ApproversArray of FlowGroupApprovers合同组签署方信息
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

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

  1. 入参中FlowFileInfos有2个元素, 表示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个合同的合同组，指定每个子合同第一方为动态签署方​

  1. 入参中FlowFileInfos有2个元素, 表示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. 错误码​

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

错误码描述
InternalError内部错误。
InternalError.Db数据库错误。
InternalError.Decryption解密错误。
InternalError.Encryption加密错误。
InternalError.GenerateId生成唯一ID错误。
InternalError.System系统错误。
InternalError.ThirdParty第三方错误。
InvalidParameter参数错误。
InvalidParameter.Application应用号不存在。
InvalidParameter.ApproverVerifyTypeApproverVerifyType参数值非法
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请升级到对应版本后即可使用该接口。
更多开发者交流反馈
购买咨询
联系销售
预约咨询
购买热线
售后反馈
技术顾问