获取跳转至腾讯电子签小程序的批量签署链接

1. 接口描述

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

通过此接口，创建小程序批量签署链接，个人/企业员工点击此链接即可跳转小程序进行批量签署。
请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。

注：

• 使用此接口生成链接，需要提前开通 使用手机号验证签署方身份 功能，在 腾讯电子签网页端-企业设置-拓展服务 中可以找到。
• 参与人点击链接后需短信验证码才能查看合同内容。
• 企业用户批量签署，需要传OrganizationName（参与方所在企业名称）参数生成签署链接，请确保此企业已完成腾讯电子签企业认证。
• 个人批量签署，签名区仅支持手写签名。

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 生成个人小程序批量签署链接

按照合同发起时候填入的信息生成批量签署链接，并通过FlowIds参数对用户可以批签的合同进行限制

输入示例

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

{
    "IdCardNumber": "620000198802020000",
    "IdCardType": "ID_CARD",
    "Name": "典子谦",
    "NotifyType": "SMS",
    "Mobile": "13200000000",
    "Operator": {
        "UserId": "yDRCLUUgygq2******uO4zjEwg0vjoimj"
    },
    "FlowIds": [
        "yDwFdUUckpsw******yQ0af8bHosXQtb",
        "yDR1AUUgygj******uO4zjE8gTG7xvgH"
    ]
}

输出示例

{
    "Response": {
        "ExpiredTime": 1684899114,
        "RequestId": "5beb5f54-cf3d-4c26-a4ee-a97c85196a3e",
        "SignUrl": "https://ess.url.cn/FuP**Swc",
        "MiniAppPath": "pages/guide/index?shortKey=FuP3**wc"
    }
}

示例2 生成企业经办人小程序批量签署链接

按照合同发起时候填入的信息生成企业经办人批量签署链接，并通过FlowIds参数对用户可以批签的合同进行限制

输入示例

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

{
    "IdCardNumber": "620000198802020000",
    "IdCardType": "ID_CARD",
    "Name": "典子谦",
    "NotifyType": "SMS",
    "Mobile": "13200000000",
    "OrganizationName": "典子谦示例企业",
    "Operator": {
        "UserId": "yDRCLUUgygq2******uO4zjEwg0vjoimj"
    },
    "FlowIds": [
        "yDwFdUUckpsw******yQ0af8bHosXQtb",
        "yDR1AUUgygj******uO4zjE8gTG7xvgH"
    ]
}

输出示例

{
    "Response": {
        "ExpiredTime": 1684899114,
        "RequestId": "5beb5f54-cf3d-4c26-a4ee-a97c85196a3e",
        "SignUrl": "https://ess.url.cn/FuP**Swc",
        "MiniAppPath": "pages/guide/index?shortKey=FuP3**wc"
    }
}

示例3 合同发起的时候签署方信息和生成链接中的不一致

合同（yDR1AUUgygja**uO4zjEB8zAkJEFN）中的参与方为：【姓名：张三 ，手机号：18888888888】，发起的时候并未填入证件号且18888888888手机号并未在腾讯电子签注册实名。

此时，如果使用 【姓名：张三，手机号：17777777777】生成批量签署链接，且FlowIds参数传入（yDR1AUUgygja**uO4zjEB8zAkJEFN）时，会报错，提示签署方信息不存在。因为手机号不同，无法定位到签署方。

此时，除了将手机号修改成 18888888888 之外来解决问题，也可以在发起合同和生成链接的时候传入证件信息，保证姓名和证件一致的情况下，手机号可以不相同。

输入示例

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

{
    "IdCardNumber": "",
    "IdCardType": "",
    "Name": "张三",
    "NotifyType": "SMS",
    "Mobile": "17777777777",
    "Operator": {
        "UserId": "yDRCLUUgygq2******uO4zjEwg0vjoimj"
    },
    "FlowIds": [
        "yDR1AUUgygja******uO4zjEB8zAkJEFN"
    ]
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "InvalidParameter",
            "Message": "合同[yDR1AUUgygja******uO4zjEB8zAkJEFN]不包含链接中的参与方信息, 请确保链接姓名手机号等信息与合同中一致"
        },
        "RequestId": "5beb5f54-cf3d-4c26-a4ee-a97c85196a3e"
    }
}

示例4 生成动态签署人批量领取链接

按照合同发起时候返回的合同信息生成批量签署链接，通过FlowIds参数对用户可以批签的合同进行限制，并指定批量领取的动态签署方。

输入示例

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2******uO4zjEwg0vjoimj"
    },
    "FlowIds": [
        "yDwFdUUckpsw******yQ0af8bHosXQtb",
        "yDR1AUUgygj******uO4zjE8gTG7xvgH"
    ],
    "FlowBatchUrlInfo": {
        "FlowBatchApproverInfos": [
            {
                "FlowId": "yDwFdUUckpsw******yQ0af8bHosXQtb",
                "RecipientId": "yDC5SUUckp******sumxxsjT3EEMVG"
            },
            {
                "FlowId": "yDR1AUUgygj******uO4zjE8gTG7xvgH",
                "RecipientId": "yDC5SUUckp*****sumxEeTQ3Xcn0B"
            }
        ]
    }
}

输出示例

{
    "Response": {
        "ExpiredTime": 1714533495,
        "MiniAppPath": "pages/guide/index?shortKey=yDC5tUf****tMb93lb5",
        "RequestId": "s1713928695416440124",
        "SignUrl": "https://test.essurl.cn/uBS****do7"
    }
}

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

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