跳到主要内容

获取发起合同组嵌入链接

1. 接口描述​

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

接口（ChannelCreatePrepareFlowGroup）用于创建嵌入式合同组签署流程。

  • 该接口当前仅支持文件发起
  • 该接口能力和ChannelCreateFlowGroupByFiles，ChannelCreateFlowGroupByTemplates保持一致。
  • 返回的FlowGroupId 为临时id，只有在页面内成功发起后FlowGroupId才会有效。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：ChannelCreatePrepareFlowGroup。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
BaseFlowInfos.N是Array of BaseFlowInfo合同组中每个合同签署流程的信息，合同组中最少包含2个合同，不能超过50个合同。
FlowGroupName是String合同组的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
示例值："2023年采购合同们"
ResourceType是Integer资源类型，取值有：
  • 1：模板
  • 2：文件

示例值：1
Agent否Agent合同的发起企业和发起人信息，点击查看合同发起企业和人展示的位置

此接口下面信息必填。

  • 渠道应用标识: Agent.AppId
  • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（合同的发起企业）
  • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （合同的发起人）



合同的发起企业和发起人必需已经完成实名，并加入企业

3. 输出参数​

参数名称类型描述
FlowGroupIdString合同组ID，为32位字符串。
建议开发者妥善保存此合同组ID，以便于顺利进行后续操作。
示例值：yDwFmUUckpstqfvzUE1h3jo1f3cqjkGm
PrepareUrlString嵌入式发起链接
示例值：https://embed.test.qian.tencent.cn/contract-create?embed=1&expiredOn=1744785243&code=yDtBLUUckpx65&businessId=yDtBLUUckYNlO&channel=TENCENTCLOUD&operateSource=byFileGroup&themeId=saas_web_theme
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 嵌入式文件发起合同组​

输入示例​

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

{
    "Agent": {
        "AppId": "yDwFoUUckpsomwx1UyhWGhIR2RkhOjw2",
        "ProxyOrganizationOpenId": "kevinlcheng_open_organization_1",
        "ProxyOperator": {
            "OpenId": "kevinlcheng_1"
        }
    },
    "FlowGroupName": "group",
    "ResourceType": 2,
    "BaseFlowInfos": [
        {
            "FlowName": "第三方预发起合同",
            "FlowType": "第三方嵌入式文件发起合同",
            "FileIds": [
                "yDCWiUUckpv6iggyUyuqIrwyppQVS7TR"
            ],
            "FlowDescription": "这是2025年购买食物的合同",
            "Deadline": 1757034793,
            "Unordered": false,
            "IntelligentStatus": "CLOSE",
            "FormFields": [],
            "NeedCreateReview": false,
            "NeedSignReview": false,
            "UserData": "",
            "CcInfos": [],
            "Approvers": [
                {
                    "ApproverType": 1,
                    "OrganizationName": "",
                    "NotChannelOrganization": false,
                    "ApproverName": "典子签",
                    "ApproverOption": {
                        "CanEditApprover": true
                    },
                    "IsFullText": true,
                    "ApproverMobile": "18700000000",
                    "SignComponents": [
                        {
                            "ChannelComponentId": "",
                            "ComponentDateFontSize": 0,
                            "ComponentDescription": "",
                            "ComponentExtra": "",
                            "ComponentHeight": 100,
                            "ComponentId": "",
                            "ComponentName": "",
                            "ComponentPage": 3,
                            "ComponentPosX": 160,
                            "ComponentPosY": 360,
                            "ComponentRecipientId": "",
                            "ComponentRequired": false,
                            "ComponentType": "SIGN_SIGNATURE",
                            "ComponentValue": "",
                            "ComponentWidth": 100,
                            "DocumentId": "",
                            "FileIndex": 0,
                            "ForbidMoveAndDelete": true,
                            "GenerateMode": "",
                            "KeywordIndexes": [],
                            "KeywordOrder": "",
                            "KeywordPage": 0,
                            "LockComponentValue": false,
                            "OffsetX": 0,
                            "OffsetY": 0,
                            "Placeholder": "",
                            "RelativeLocation": ""
                        }
                    ]
                }
            ]
        }
    ]
}

输出示例​

{
    "Response": {
        "FlowGroupId": "yDttAUUckpxbcz9uUySqdD58t8bwneLp",
        "PrepareUrl": "https://embed.test.qian.tencent.cn/contract-create?embed=1&expiredOn=1747036582&code=yDttAUUckpxbcz9vUySqdD5u3jnsKVT6&businessId=yDttAUUckpxbcz9uUySqdD58t8bwneLp&channel=PROXYCHANNEL&operateSource=byFileGroup&themeId=channel_web_theme_yDSLbUUckpo3e14eUEK7ajSyPX7g3kIc",
        "RequestId": "s1747036282702037847"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
FailedOperation.AgeNotAchieveNormalLegal签署人未达到合法年龄。
InternalError内部错误。
InternalError.Db数据库错误。
InternalError.DbConnection数据库连接出错。
InternalError.Decryption解密错误。
InternalError.Encryption加密错误。
InternalError.GenerateId生成唯一ID错误。
InternalError.System系统错误。
InternalError.ThirdParty第三方错误。
InvalidParameter参数错误。
InvalidParameter.Application应用号不存在。
InvalidParameter.ApproverType参数错误，不合法的签署人类型，请修改后重试。
InvalidParameter.ApproverVerifyTypeApproverVerifyType参数值非法
InvalidParameter.BizApproverAlreadyExists重复添加签署人。
InvalidParameter.CardType证件类型错误。
InvalidParameter.CustomShowMap参数错误，无效的自定义页卡模板，仅支持{合同名称}{发起方姓名}{发起方企业}{签署方N姓名}{签署方N企业}，请修改后重试。
InvalidParameter.CustomerData参数错误，UserData长度非法，请修改后重试。
InvalidParameter.DataNotFound数据不存在。
InvalidParameter.FlowApproverInfos参数错误，不合法的备选签署人数量，请检查后重试。
InvalidParameter.FlowApprovers参数错误，参与者数量不能为空且不能超过数量限制，请修改后重试。
InvalidParameter.FlowCallbackUrl参数错误，不合法的签署流程回调链接，请修改后重试。
InvalidParameter.FlowDeadLine参数错误，不合法的签署流程截止日期，请修改后重试。
InvalidParameter.FlowDescription参数错误，不合法的签署流程描述，请修改后重试。
InvalidParameter.FlowFileIds参数错误，目前仅支持单个文件发起，请修改后重试。
InvalidParameter.FlowName参数错误，不合法的签署流程名称，请修改后重试。
InvalidParameter.FlowType参数错误，不合法的FlowType，请修改后重试。
InvalidParameter.Name姓名不符合要求。
InvalidParameter.NonsupportMobile不支持的手机号。
InvalidParameter.OrganizationName企业名称不合法。
InvalidParameter.ParamError参数错误。
InvalidParameter.SignComponentType参数错误，不合法的签署控件类型，请修改后重试。
InvalidParameter.Unordered参数错误，不合法的签署顺序，请检查后重试。
InvalidParameter.UnsupportedComponentType参数错误，不支持的控件类型，请检查后重试。
InvalidParameterValue参数取值错误。
LimitExceeded超过配额限制。
MissingParameter缺少参数错误。
MissingParameter.MissComponentName缺少控件名称参数，请检查后重试。
OperationDenied操作被拒绝。
OperationDenied.ByFilesServerSignForbid文件发起静默签未开通白名单。
OperationDenied.ErrNoResourceAccess无资源访问权限。
OperationDenied.InvalidApproverAge签署人未达到合法年龄。
OperationDenied.NoApproverMobileCheckPermission企业暂未开通手机号验证身份的服务，请在企业中心开通再使用
OperationDenied.NoIdentityVerify未通过个人实名。
OperationDenied.NoQuota流程配额不足。
OperationDenied.OverseaAbilityNotOpen当前企业员工没有开通境外签署能力。
ResourceNotFound资源不存在。
ResourceNotFound.Application应用号不存在。
ResourceNotFound.Resource资源不存在。
ResourceNotFound.Seal印章不存在，请检查后重试。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
更多开发者交流反馈
购买咨询
联系销售
预约咨询
购买热线
售后反馈
技术顾问