跳到主要内容

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

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 和 Agent.ProxyAppId 必填。
TemplateId是String模版ID
FlowName是String签署流程名称，最大长度200个字符。
MaxFlowNum否Integer最大可发起签署流程份数，默认5份；发起签署流程数量超过此上限后，二维码自动失效。
FlowEffectiveDay否Integer签署流程有效天数 默认7天 最高设置不超过30天
QrEffectiveDay否Integer二维码有效天数 默认7天 最高设置不超过90天
Restrictions.N否Array of ApproverRestriction限制二维码用户条件
CallbackUrl否String回调地址，最大长度1000个字符
不传默认使用第三方应用号配置的回调地址
回调时机:用户通过签署二维码发起合同时，企业额度不足导致失败
ApproverRestrictions否ApproverRestriction限制二维码用户条件（已弃用）
Operator否UserInfo暂未开放

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": {
        "ProxyAppId": "test",
        "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"
    }
}

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签署二维码模板信息有误，请检查参数后重试。
InternalError内部错误。
InvalidParameter参数错误。
InvalidParameter.ParamError参数错误。
MissingParameter缺少参数错误。
OperationDenied.NoQuota流程配额不足。
ResourceNotFound资源不存在。
ResourceNotFound.Application应用号不存在。
ResourceNotFound.Template模板不存在。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。