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

1. 接口描述

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

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

注：

使用此接口生成链接，需要提前开通 个人签署方仅校验手机号 功能，在 腾讯电子签网页端-企业设置-拓展服务 中可以找到。
个人参与方点击链接后需短信验证码才能查看合同内容。
个人用户批量签署，需要传Name，Mobile，IdCardNumber(IdCardType) 参数。
saas企业员工用户批量签署，在传递了姓名等基本信息参数的情况下，还需要传OrganizationName（参与方所在企业名称）参数生成签署链接，请确保此企业已完成腾讯电子签企业认证。
子客企业员工用户批量签署，需要传递员工OpenId和子客企业的OrganizationOpenId。请确保此OrganizationOpenId对应子客已经认证，且OpenId对应员工此子客下已经实名。Name，Mobile, IdCard等信息此时可以不传，系统会查询此OpenId实名信息自动补充。
生成批量签署链接时，合同目标参与方状态需为待签署状态。
个人批量签署进行的合同的签名区，全部变成手写签名（不管合同里边设置的签名限制）来进行。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ChannelCreateBatchSignUrl。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
Agent	是	Agent	关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 第三方平台子客企业和员工必须已经过实名认证
Name	否	String	签署方经办人的姓名。经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。注：`请确保和合同中填入的一致`，`除动态签署人或子客员工经办人场景外，此参数必填`
Mobile	否	String	手机号码，支持国内手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此业务通知方。注：`请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人或子客员工经办人场景外，此参数必填`
Operator	否	UserInfo	执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
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	SaaS平台企业员工签署方的企业名称。目标签署人如果为saas应用企业员工身份，此参数必填。注：请确认该名称与企业营业执照中注册的名称一致。如果名称中包含英文括号()，请使用中文括号（）代替。请确保此企业已完成腾讯电子签企业认证。若为子客企业员工，请使用OpenId，OrganizationOpenId参数，此参数留空即可
JumpToDetail	否	Boolean	是否直接跳转至合同内容页面进行签署 false: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认) true: 跳过合同流程列表, 直接进入合同内容页面进行签署
FlowBatchUrlInfo	否	FlowBatchUrlInfo	批量签署合同相关信息，指定合同和签署方的信息，用于补充动态签署人。
OpenId	否	String	第三方平台子客企业员工的标识OpenId，批签合同经办人为子客员工的情况下为必填。注：传入的OpenId对应员工在此子客企业下必须已经实名传递了此参数可以无需传递Name，Mobile，IdCardNumber，IdCardType参数。系统会根据员工OpenId自动拉取实名信息。
OrganizationOpenId	否	String	第三方平台子客企业的企业的标识, 即OrganizationOpenId，批签合同经办人为子客企业员工是为必填。
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: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelCreateBatchSignUrl
<公共请求参数>

{
    "IdCardNumber": "610000000000000000",
    "IdCardType": "ID_CARD",
    "Name": "小明",
    "NotifyType": "SMS",
    "Mobile": "1234567890",
    "Agent": {
        "ProxyOperator": {
            "OpenId": "test_open_id"
        },
        "ProxyOrganizationOpenId": "test_org_open_id",
        "AppId": "yDxbWUyKQ*******4zjEB8mxCcDjAyF"
    },
    "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 生成saas企业经办人小程序批量签署链接

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

输入示例

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

{
    "IdCardNumber": "610000000000000000",
    "IdCardType": "ID_CARD",
    "Name": "小明",
    "NotifyType": "SMS",
    "Mobile": "1234567890",
    "OrganizationName": "典子谦示例企业",
    "Agent": {
        "ProxyOperator": {
            "OpenId": "test_open_id"
        },
        "ProxyOrganizationOpenId": "test_org_open_id",
        "AppId": "yDxbWUyKQ*******4zjEB8mxCcDjAyF"
    },
    "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",
    "Agent": {
        "ProxyOperator": {
            "OpenId": "test_open_id"
        },
        "ProxyOrganizationOpenId": "test_org_open_id",
        "AppId": "yDxbWUyKQ*******4zjEB8mxCcDjAyF"
    },
    "FlowIds": [
        "yDR1AUUgygja******uO4zjEB8zAkJEFN"
    ]
}

输出示例

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

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

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

输入示例

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "test_open_id"
        },
        "ProxyOrganizationOpenId": "test_org_open_id",
        "AppId": "yDxbWUyKQ*******4zjEB8mxCcDjAyF"
    },
    "FlowIds": [
        "yDwFdUUckpsw******yQ0af8bHosXQtb",
        "yDR1AUUgygj******uO4zjE8gTG7xvgH"
    ],
    "FlowBatchUrlInfo": {
        "FlowBatchApproverInfos": [
            {
                "FlowId": "yDC5yUUckpwexoz4UuoHfkT1DMEDQSG5",
                "RecipientId": "yDC5yUUckpwexozwUuoHfkTwB00zdfLo"
            }
        ]
    }
}

输出示例

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

示例5 生成子客经办人小程序批量签署链接

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

输入示例

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

{
    "OpenId": "test_open_id",
    "OrganizationOpenId": "test_org_open_id",
    "Name": "",
    "NotifyType": "SMS",
    "Mobile": "",
    "OrganizationName": "",
    "Agent": {
        "ProxyOperator": {
            "OpenId": "test_open_id"
        },
        "ProxyOrganizationOpenId": "test_org_open_id",
        "AppId": "yDxbWUyKQ*******4zjEB8mxCcDjAyF"
    },
    "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"
    }
}

5. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.Api	其他API错误。
InternalError.Db	数据库错误。
InvalidParameter	参数错误。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
ResourceNotFound.Organization	机构不存在。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

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

输入示例​

输出示例​

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

输入示例​

输出示例​

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

输入示例​

输出示例​

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

输入示例​

输出示例​

示例5 生成子客经办人小程序批量签署链接​

输入示例​

输出示例​

5. 错误码​

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

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

输入示例

输出示例

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

输入示例

输出示例

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

输入示例

输出示例

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

输入示例

输出示例

示例5 生成子客经办人小程序批量签署链接

输入示例

输出示例

5. 错误码