创建一码多签签署码

1. 接口描述

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

此接口（CreateMultiFlowSignQRCode）用于创建一码多签签署码。

适用场景:
签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。

注意:

1. 本接口适用于发起方没有填写控件的 B2C或者单C模板, 若是B2C模板,还要满足以下任意一个条件
   • 模板中配置的签署顺序是无序
   • B端企业的签署方式是静默签署
   • B端企业是非首位签署
2. 通过一码多签签署码发起的合同，合同涉及到的回调消息可参考文档合同发起及签署相关回调
3. 用户通过一码多签签署码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档签署二维码相关回调

签署码的样式如下图:

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 创建指定用户的的合同流程签署二维码

创建一码多扫流程签署二维码，指定固定的用户才能扫码签署。

输入示例

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

{
    "Operator": {
        "UserId": "yDRCLUU******wg0vjoimj"
    },
    "FlowName": "测试合同",
    "TemplateId": "yDRS4U******TmzsIAR",
    "Restrictions": [
        {
            "Name": "张三",
            "Mobile": "188********"
        },
        {
            "Name": "李四",
            "Mobile": "189********"
        }
    ]
}

输出示例

{
    "Response": {
        "QrCode": {
            "QrCodeUrl": "https://res.ess.tencent.cn/mp-gate/release/CHANNEL_CONTRACT_COVER/xxx",
            "ExpiredTime": 1693814798,
            "QrCodeId": "yDRS****jEuBzwyiofZ"
        },
        "SignUrls": {
            "EffectiveTime": "2022-08-05 15:55:01",
            "HttpSignUrl": "https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=MSG&to=CHANNEL_CONTRACT_COVER&xxx",
            "AppSignUrl": "pages/guide?from=default&where=mini&autoJumpBack=true&to=CHANNEL_CONTRACT_COVER&xxx"
        },
        "RequestId": "s198*****111"
    }
}

示例2 创建指定了签署方签名方式的签署二维码

1. 使用B2C模板 yDRscUUgyg1zr7wnUyJ8QMwwnHc4OOcQ 创建了一个签署二维码。

2.指定RecipientId 为 yDRscUUgyg3zr9vfUyJ8QKwCN7z9YcOh 的签署人在签名时可以手写（HANDWRITE） 或者使用系统签名 (SYSTEM_ESIGN)。

3.指定RecipientId 为 yDwJNUUckpkojrmqUxTFHk0yndh70CpW 的签署人在签名时只能使用AI智能识别手写签名（OCR_ESIGN）。

输入示例

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
    },
    "FlowEffectiveDay": 7,
    "QrEffectiveDay": 7,
    "MaxFlowNum": 5,
    "TemplateId": "yDRscUUgyg1zr7wnUyJ8QMwwnHc4OOcQ",
    "FlowName": "示例合同-通过二维码发起",
    "ApproverComponentLimitTypes": [
        {
            "RecipientId": "yDRscUUgyg3zr9vfUyJ8QKwCN7z9YcOh",
            "Values": [
                "HANDWRITE",
                "SYSTEM_ESIGN"
            ]
        },
        {
            "RecipientId": "yDwJNUUckpkojrmqUxTFHk0yndh70CpW",
            "Values": [
                "OCR_ESIGN"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "QrCode": {
            "ExpiredTime": 1695783727,
            "QrCodeId": "yDwJNUUckpkoj9mdUIJN2kC7XWFFaSuR",
            "QrCodeUrl": "https://dyn.test.ess.tencent.cn/imgs/multiSignQrCodes/QrCode/yDwJNUUckpkoj9mdUIJN2kC7XWFFaSuR.png"
        },
        "RequestId": "s1695178926924585393",
        "SignUrls": {
            "AppSignUrl": "pages/guide?from=default&where=mini&autoJumpBack=true&to=CHANNEL_CONTRACT_COVER&qrCodeId=yDwJNUUckpkoj9mdUIJN2kC7XWFFaSuR&expiredTime=1695783727",
            "EffectiveTime": "",
            "HttpSignUrl": "https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?where=mini&from=MSG&to=CHANNEL_CONTRACT_COVER&qrCodeId=yDwJNUUckpkoj9mdUIJN2kC7XWFFaSuR&expiredTime=1695783727"
        }
    }
}

示例3 创建指合同流程签署二维码失败-模板不支持

如果模板不符合以下以下任意一个条件

1. 模板中配置的签署顺序是无序
2. B端企业的签署方式是静默签署
3. B端企业是非首位签署
   则创建二维码失败，返回错误信息

输入示例

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

{
    "FlowName": "测试合同",
    "MaxFlowNum": 100,
    "QrEffectiveDay": 7,
    "FlowEffectiveDay": 7,
    "Operator": {
        "UserId": "yDRCLUU******wg0vjoimj"
    },
    "TemplateId": "yDRS4U******xmzsIAR"
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "FailedOperation.QrCodeTemplateId",
            "Message": "二维码生成失败，模板未满足生成二维码"
        },
        "RequestId": "s169*****0872"
    }
}

示例4 创建有数量或时间限制的合同流程签署二维码

创建一码多扫流程签署二维码，设置该二维码在7天内有效，并将最大合同流程签署数量限制为100份。
设定签署合同的有效期为7天。

输入示例

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

{
    "FlowName": "测试合同",
    "MaxFlowNum": 100,
    "QrEffectiveDay": 7,
    "FlowEffectiveDay": 7,
    "Operator": {
        "UserId": "yDRCLUU******wg0vjoimj"
    },
    "TemplateId": "yDRS4U******TmzsIAR"
}

输出示例

{
    "Response": {
        "QrCode": {
            "QrCodeUrl": "https://res.ess.tencent.cn/mp-gate/release/CHANNEL_CONTRACT_COVER/xxx",
            "ExpiredTime": 1693814798,
            "QrCodeId": "yDRS****jEuBzwyiofZ"
        },
        "SignUrls": {
            "EffectiveTime": "2022-08-05 15:55:01",
            "HttpSignUrl": "https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=MSG&to=CHANNEL_CONTRACT_COVER&xxx",
            "AppSignUrl": "pages/guide?from=default&where=mini&autoJumpBack=true&to=CHANNEL_CONTRACT_COVER&xxx"
        },
        "RequestId": "s198*****111"
    }
}

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

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