创建小程序发起合同链接

1. 接口描述

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

创建小程序发起流程链接，在小程序页面上完成签署人等信息的编辑与确认后，可快速发起流程。


适用场景：如果需要签署人在自己的APP、小程序、H5应用中发起合同，可在收集合同信息，签署人等信息后（非必选），通过此接口获取跳转腾讯电子签小程序的合同发起跳转链接，跳转到腾讯电子签小程序继续合同的发起。

跳转到小程序的实现，参考微信官方文档（分为全屏、半屏两种方式），如何配置也可以请参考: 跳转电子签小程序配置

注：

• 1. 签署链接的有效期为90天，超过有效期链接不可用
• 2. 生成的链路后面不能再增加参数（会出现覆盖链接中已有参数导致错误）
• 3. 调用接口后，流程不会立即发起，需使用链接跳转到小程序上继续发起流程操作。
• 4. 使用链接成功发起一份合同后，链接立即失效

其中小程序的原始Id如下，或者查看小程序信息自助获取。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 文件发起

输入示例

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

{
    "Operator": {
        "UserId": "yDxjOUUgydjfxgnzUuO5zjEWA07rC5xl"
    },
    "ResourceId": "yDtIfUUckp9grxnsUyecoDMwRdhpe8IE",
    "UserFlowTypeId": "",
    "ResourceType": 2,
    "FlowName": "小程序合同发起测试",
    "Unordered": true,
    "DeadlineAfterStartDays": 3,
    "UserData": "VXNlckRhdGE=",
    "FlowOption": {
        "NeedCreateReview": false,
        "FlowDisplayType": 1
    },
    "PageOption": {
        "HideSignCodeAfterStart": true
    },
    "CcInfos": [
        {
            "CcType": 0,
            "Name": "程某",
            "Mobile": "18700000000"
        }
    ],
    "Approvers": [
        {
            "ApproverType": 0,
            "OrganizationName": "电子签测试企业",
            "ApproverName": "何规",
            "ApproverMobile": "18200000000"
        },
        {
            "ApproverType": 1,
            "ApproverName": "张某",
            "ApproverMobile": "18200000000"
        }
    ]
}

输出示例

{
    "Response": {
        "ExpiredOn": 1761031031,
        "FlowId": "yDtGEUUckp95buvoUuQn9oeynYWruYTL",
        "LongUrl": "https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=CREATE_CONTRACT&shortKey=yDtGEUqBRu0a9TF5sO50",
        "MiniAppPath": "pages/guide/index?to=CREATE_CONTRACT&shortKey=yDtGEUqBRu0a9TF5sO50",
        "WeixinQrcodeUrl": "https://res.ess.tencent.cn/mp-gate/develop/CREATE_CONTRACT?shortKey=yDtGEUqBE5oBLdr2d590",
        "QrcodeUrl": "https://dyn.test.ess.tencent.cn/imgs/qrcode_urls/create_contract/yDtGEUUckp95bu13UuQn9oe1FEBKizIN.png",
        "RequestId": "s1753255031857612403",
        "ShortUrl": "https://test.essurl.cn/t8c0UBN27z"
    }
}

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

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