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

1. 接口描述

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

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

注意事项：

使用此接口生成链接，需要贵企业先开通个人签署方仅校验手机号功能。您可以在 【腾讯电子签网页端】->【企业设置】->【拓展服务】中找到该功能。
生成批量签署链接时，合同目标参与方的状态必须为待签署状态。签署人点击链接后需要输入短信验证码才能查看合同内容。
企业员工批量签署链接：需要传入签署方所在企业名称，用户名字和手机号（或者身份证件信息）参数来生成签署链接。该签署方企业必须已完成腾讯电子签企业认证
个人批量签署链接：需要传入签署方用户名字和手机号（或者身份证件信息）参数来生成签署链接。个人批量签署进行的合同的签名区，全部变成手写签名（不管合同里边设置的签名限制）来进行。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateBatchSignUrl。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
Name	否	String	签署方经办人的姓名。经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。注：`请确保和合同中填入的一致`, `除动态签署人场景外，此参数必填`
Mobile	否	String	手机号码，支持国内手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此业务通知方。注：`请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人场景外，此参数必填`
Agent	否	Agent	代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
IdCardType	否	String	证件类型，支持以下类型 ID_CARD : 中国大陆居民身份证 (默认值) HONGKONG_AND_MACAO : 港澳居民来往内地通行证 HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证) 注：`请确保和合同中填入的一致`
IdCardNumber	否	String	证件号码，应符合以下规则居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给香港居民，“M”字头签发给澳门居民；第2位至第11位为数字。港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。注：`请确保和合同中填入的一致`
NotifyType	否	String	通知用户方式： NONE : 不通知（默认） SMS : 短信通知（发送短信通知到Mobile参数所传的手机号）
FlowIds.N	否	Array of String	批量签署的合同流程ID数组。注: `在调用此接口时，请确保合同流程均为本企业发起，且合同数量不超过100个。`
OrganizationName	否	String	目标签署人的企业名称，签署人如果是企业员工身份，需要传此参数。注：请确认该名称与企业营业执照中注册的名称一致。如果名称中包含英文括号()，请使用中文括号（）代替。请确保此企业已完成腾讯电子签企业认证。
JumpToDetail	否	Boolean	是否直接跳转至合同内容页面进行签署 false: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认) true: 跳过合同流程列表, 直接进入合同内容页面进行签署
FlowBatchUrlInfo	否	FlowBatchUrlInfo	批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
AutoJumpBack	否	Boolean	签署完成后是否自动回跳 false：否, 签署完成不会自动跳转回来(默认) true：是, 签署完成会自动跳转回来注: 1. 该参数只针对APP类型（电子签小程序跳转贵方小程序）场景的签署链接有效 2. 手机应用APP 或微信小程序需要监控界面的返回走后序逻辑, 微信小程序的文档可以参考这个 3. 电子签小程序跳转贵方APP，不支持自动跳转，必需用户手动点击完成按钮（微信的限制）示例值：false

3. 输出参数

参数名称	类型	描述
SignUrl	String	批量签署链接，以短链形式返回，短链的有效期参考回参中的 ExpiredTime。注: 1. 非小程序和APP集成使用 2. 生成的链路后面不能再增加参数（会出现覆盖链接中已有参数导致错误）
ExpiredTime	Integer	链接过期时间以 Unix 时间戳格式表示，默认生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。
MiniAppPath	String	从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径注: 1. 小程序和APP集成使用 2. 生成的链路后面不能再增加参数（会出现覆盖链接中已有参数导致错误）
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

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

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.Api	第三方接口失败。
InternalError.Db	数据库异常。
InvalidParameter	参数错误。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
ResourceNotFound.Organization	机构不存在或者未完成认证，请检查机构信息。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

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

输入示例​

输出示例​

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

输入示例​

输出示例​

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

输入示例​

输出示例​

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

输入示例​

输出示例​

5. 错误码​

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

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

输入示例

输出示例

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

输入示例

输出示例

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

输入示例

输出示例

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

输入示例

输出示例

5. 错误码