跳到主要内容

创建一码多扫签署流程二维码

1. 接口描述​

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

此接口（ChannelCreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。

本接口适用于发起方没有填写控件的 B2C或者单C模板

若是B2C模板,还要满足以下任意一个条件

  • 模板中配置的签署顺序是无序
  • B端企业的签署方式是静默签署
  • B端企业是非首位签署

通过一码多扫二维码发起的合同，合同涉及到的回调消息可参考文档合同发起及签署相关回调

用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档签署二维码相关回调

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：ChannelCreateMultiFlowSignQRCode。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
Agent是Agent应用相关信息。
此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
TemplateId是String模版ID
FlowName是String签署流程名称，最大长度200个字符。
MaxFlowNum否Integer最大可发起签署流程份数

默认5份

备注：发起签署流程数量超过此上限后，二维码自动失效。
FlowEffectiveDay否Integer签署流程有效天数 默认7天 最高设置不超过30天
QrEffectiveDay否Integer二维码有效天数 默认7天 最高设置不超过90天
Restrictions.N否Array of ApproverRestriction指定的签署二维码签署人

指定后，只允许知道的人操作和签署
ApproverComponentLimitTypes.N否Array of ApproverComponentLimitType指定签署方经办人控件类型是个人印章签署控件（SIGN_SIGNATURE） 时，可选的签名方式。

3. 输出参数​

参数名称类型描述
QrCodeSignQrCode签署二维码对象
SignUrlsSignUrl签署链接对象
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 ChannelCreateMultiFlowSignQRCode​

ChannelCreateMultiFlowSignQRCode

输入示例​

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

{
    "FlowName": "test",
    "Agent": {
        "ProxyOperator": {
            "OpenId": "test"
        },
        "ProxyOrganizationOpenId": "test",
        "AppId": "test"
    },
    "FlowEffectiveDay": 0,
    "TemplateId": "test",
    "MaxFlowNum": 0,
    "QrEffectiveDay": 0,
    "CallbackUrl": "test"
}

输出示例​

{
    "Response": {
        "QrCode": {
            "QrCodeUrl": "test",
            "ExpiredTime": 5,
            "QrCodeId": "test"
        },
        "SignUrls": {
            "EffectiveTime": "test",
            "HttpSignUrl": "test",
            "AppSignUrl": "test"
        },
        "RequestId": "test"
    }
}

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

1.使用B2C模板 yDRscUUgyg1zr7wnUyJ8QMwwnHc4OOcQ 创建了一个签署二维码。 2.指定RecipientId 为 yDRscUUgyg3zr9vfUyJ8QKwCN7z9YcOh 的签署人在签名时可以手写（HANDWRITE） 或者使用系统签名 (SYSTEM_ESIGN)。 3.指定RecipientId 为 yDwJNUUckpkojrmqUxTFHk0yndh70CpW 的签署人在签名时只能使用AI智能识别手写签名（OCR_ESIGN）。

输入示例​

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "proxy-operator-openid"
        },
        "ProxyOrganizationOpenId": "proxy-org-openid",
        "AppId": "yDRscUUgyg1zr7wnUyJ8QMwwnHc4OOcQ"
    },
    "TemplateId": "yDRvzUUgygqj42ouUuO4zjEueBrK5MeV",
    "FlowName": "通过签署二维码创建的实力合同",
    "FlowEffectiveDay": 5,
    "QrEffectiveDay": 7,
    "MaxFlowNum": 100,
    "ApproverComponentLimitTypes": [
        {
            "RecipientId": "yDRscUUgyg3zr9vfUyJ8QKwCN7z9YcOh",
            "Values": [
                "HANDWRITE",
                "SYSTEM_ESIGN"
            ]
        },
        {
            "RecipientId": "yDwJNUUckpkojrmqUxTFHk0yndh70CpW",
            "Values": [
                "OCR_ESIGN"
            ]
        }
    ]
}

输出示例​

{
    "Response": {
        "QrCode": {
            "ExpiredTime": 1695783727,
            "QrCodeId": "yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR",
            "QrCodeUrl": "https://dyn.test.ess.tencent.cn/imgs/multiSignQrCodes/QrCode/yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR.png"
        },
        "RequestId": "s1695178926924585393",
        "SignUrls": {
            "AppSignUrl": "pages/guide?from=default&where=mini&autoJumpBack=true&to=CHANNEL_CONTRACT_COVER&qrCodeId=yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR&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=yDwJNUUckpkoj0mdUIJN2kC3XWFFaSuR&expiredTime=1695783727"
        }
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
FailedOperation.QrCodeCreatorSignComponents发起签署存在填写控件。
FailedOperation.QrCodeSignUsers模板签署人不存在。
FailedOperation.QrCodeTemplateId签署二维码模板信息有误，请检查参数后重试。
InternalError内部错误。
InvalidParameter参数错误。
InvalidParameter.ParamError参数错误。
MissingParameter缺少参数错误。
OperationDenied.NoQuota流程配额不足。
ResourceNotFound资源不存在。
ResourceNotFound.Application应用号不存在。
ResourceNotFound.Template模板不存在。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。