跳到主要内容

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

1. 接口描述​

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

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

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

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

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

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：CreateMultiFlowSignQRCode。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，本接口不需要传递此参数。
Operator是UserInfo用户信息，其中UserId为必填参数
TemplateId是String模板ID
FlowName是String签署流程名称，最大长度不超过200字符
MaxFlowNum否Integer最大可发起签署流程份数，默认5份
发起流程数量超过此上限后二维码自动失效
FlowEffectiveDay否Integer签署流程有效天数 默认7天 最高设置不超过30天
QrEffectiveDay否Integer二维码有效天数 默认7天 最高设置不超过90天
Restrictions.N否Array of ApproverRestriction限制二维码用户条件
UserData否String用户自定义字段，回调的时候会进行透传，长度需要小于20480
CallbackUrl否String回调地址,最大长度1000字符串
回调时机：
用户通过签署二维码发起签署流程时，企业额度不足导致失败

3. 输出参数​

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

4. 示例​

示例1 CreateMultiFlowSignQRCode​

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

输入示例​

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

{
    "FlowName": "测试合同",
    "MaxFlowNum": 0,
    "FlowEffectiveDay": 0,
    "Operator": {
        "UserId": "userId"
    },
    "TemplateId": "templateid",
    "QrEffectiveDay": 0,
    "CallbackUrl": ""
}

输出示例​

{
    "Response": {
        "QrCode": {
            "QrCodeUrl": "http://www.qrcode.com/url/qrcode",
            "ExpiredTime": 5,
            "QrCodeId": "qr_code_id"
        },
        "SignUrls": {
            "EffectiveTime": "",
            "HttpSignUrl": "http://www.qrcode.com/url/HttpSignUrl",
            "AppSignUrl": "/Pages/xxxxxx"
        },
        "RequestId": "s19873636434111"
    }
}

5. 开发者资源​

腾讯云 API 平台​

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector​

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK​

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具​

6. 错误码​

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

错误码描述
FailedOperation操作失败。
FailedOperation.QrCodeCreatorSignComponents签署二维码模板发起方签署人存在签署控件，请检查模板后重试。
FailedOperation.QrCodeSignUsers签署二维码模板签署人不存在，请检查模板后重试。
FailedOperation.QrCodeTemplateId一码多人二维码模板有误。
FailedOperation.RequestLimitExceeded请求的次数超过了频率限制，请联系客服处理。
InternalError内部错误。
InternalError.System系统错误，请稍后重试。
InvalidParameter.CardNumber不合法的证件信息，请检查证件号证件类型是否正确。
InvalidParameter.DataNotFound数据不存在。
InvalidParameter.FlowName不合法的签署流程名称，请修改后重试。
InvalidParameter.Mobile不合法的手机号，请检查后重试。
InvalidParameter.Name不合法的用户名称，请修改后重试。
InvalidParameter.QrEffectDay签署二维码的有效期不合法，请联系客服了解规则，并修改后重试。
InvalidParameter.QrFlowEffectDay二维码合同的有效期不合法，请联系客服了解规则，并修改后重试。
InvalidParameter.TemplateId不合法的签署二维码模板id，请检查修改后重试。
MissingParameter缺少参数错误。
OperationDenied.Forbid禁止此项操作。
OperationDenied.NoLogin用户未登录,请先登录后再操作。
OperationDenied.NoQuota企业额度不足，请检查企业额度后处理。
OperationDenied.NoVerify未完成实名认证，请检查后重试。
OperationDenied.UserNotInOrganization用户不归属于当前企业，无法操作，请检查后重试。
ResourceNotFound.AuthActiveOrganization机构未完成认证激活，请检查并联系客服处理。
ResourceNotFound.Organization机构不存在或者未完成认证，请检查机构信息。
ResourceNotFound.Resource未获取到文件资源，请检查资源是否完成上传，是否有效，并在修改后重试。
ResourceNotFound.Template模板不存在，请检查模板参数，模板配置，并稍后重试。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。