获取发起合同组嵌入链接

1. 接口描述

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

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

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

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

2. 输入参数

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

3. 输出参数

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. 开发者资源

腾讯云 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: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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