获取企业签署合同web页面
1. 接口描述
接口请求域名： essbasic.tencentcloudapi.com 。
通过此接口，可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。
注：
- 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方或者领取方。
- 仅支持传入待签署或者待领取的合同，待填写暂不支持。
- 员工批量签署，支持多种签名方式，包括手写签名、临摹签名、系统签名、个人印章、签批控件等。
签署的嵌入页面长相如下：
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ChannelCreateOrganizationBatchSignUrl。 |
| Version | 是 | String | 公共参数，本接口取值：2021-05-26。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| Agent | 是 | Agent | 关于渠道应用的相关信息，包括子客企业及应用编、号等详细内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 |
| FlowIds.N | 否 | Array of String | 请指定需执行批量签署的流程ID，数量范围为1-100。 您可登录腾讯电子签控制台，浏览 "合同"->"合同中心" 以查阅某一合同的FlowId（在页面中显示为合同ID）。 用户将利用链接对这些合同实施批量操作。 示例值：["yDxxxxxxxxxxxxxxxxxxxxxxxx"] |
| OpenId | 否 | String | 第三方应用平台的用户openid。 您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同（FlowId）中的签署人。
示例值：user_open_id |
| Name | 否 | String | 签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 注： 请确保和合同中填入的一致示例值：张三 |
| Mobile | 否 | String | 员工手机号，必须与姓名一起使用。 如果OpenId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。 示例值：13800000000 |
| FlowGroupId | 否 | String | 合同组Id，传入此参数则可以不传FlowIds 示例值：yDttAUUckpxbczx6UySqdD5wIcNyCCQW |
| CanBatchReject | 否 | Boolean | 是否允许此链接中签署方批量拒签。
当前合同组不支持批量拒签功能。请对合同组中的每个子合同逐一执行拒签操作，以达到拒签整个合同组的效果。示例值：false |
| DynamicSignOption | 否 | DynamicSignOption | 动态签署方领取链接配置。 |
| RecipientIds.N | 否 | Array of String | 为签署方经办人在签署合同中的参与方ID，必须与参数FlowIds数组一一对应。 注：生成动态签署方领取时此参数必传。 示例值：["yDtK2UUckpfmgindUyHCZxCEZrJgOW8c"] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| SignUrl | String | 批量签署入口链接，用户可使用这个链接跳转到控制台页面对合同进行签署操作。 示例值：https://embed.test.qian.tencent.cn/console/?channel=PROXYCHANNEL&expiredTime=1695805069&code=xxxxx&menuStatus=ENABLE&token=xxxx |
| ExpiredTime | Integer | 链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。 示例值：1695805069 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建企业动态签署领取链接
发起合同指定B端企业员工为动态签署方，通过此接口获取动态领取链接。
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelCreateOrganizationBatchSignUrl
<公共请求参数>
{
"Agent": {
"AppId": "yDwFoUUckpsomwx1UyhWGhIR2RkhOjw2",
"ProxyOrganizationOpenId": "ess_open_organization_1",
"ProxyOperator": {
"OpenId": "kevinlcheng"
}
},
"FlowIds": [
"yDtK2UUckpfmgingU1UyHCZxCSSvzgqj"
],
"CanBatchReject": true,
"RecipientIds": [
"yDtK2UUckpfmgindUyHCZxCEZrJgOW8c"
]
}
输出示例
{
"Response": {
"ExpiredTime": 1767619219,
"SignUrl": "https://embed.test.qian.tencent.cn/contract-batchsign?embed=1&expiredOn=1767619219&code=yDtK2UUckpfmg5e1UyDuCxQBXaYPsgdA&shortKey=yDtK2UemxuuTcRfVpk7b&channel=PROXYCHANNEL",
"RequestId": "1e564965-8e7c-4a3e-bc8c-c35be86937ad"
}
}
示例2 创建企业动态签署领取链接，并且预设企业OpenId
发起合同指定B端企业员工为动态签署方，通过此接口获取动态领取链接。预设企业OpenId，要求只能由对应企业员工点击领取链接进行领取。
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelCreateOrganizationBatchSignUrl
<公共请求参数>
{
"Agent": {
"AppId": "yDwFoUUckpsomwx1UyhWGhIR2RkhOjw2",
"ProxyOrganizationOpenId": "ess_open_organization_1",
"ProxyOperator": {
"OpenId": "kevinlcheng"
}
},
"FlowIds": [
"yDtK2UUckpfmgingU1UyHCZxCSSvzgqj"
],
"RecipientIds": [
"yDtK2UUckpfmgindUyHCZxCEZrJgOW8c"
],
"DynamicSignOption": {
"OrganizationOpenId": "dian_zi_qian"
},
"CanBatchReject": true
}
输出示例
{
"Response": {
"ExpiredTime": 1767619145,
"SignUrl": "https://embed.test.qian.tencent.cn/contract-batchsign?embed=1&expiredOn=1767619145&code=yDtK2UUckpfmpuhxUuyfSWJxqnEnA7KP&shortKey=yDtK2UemxQpCrgNgy100&channel=PROXYCHANNEL",
"RequestId": "b9f75514-0559-4699-be54-11019de12574"
}
}
示例3 创建合同组签署链接
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelCreateOrganizationBatchSignUrl
<公共请求参数>
{
"Agent": {
"AppId": "60exxxxxxxxxxxxxxxxxxxxxc16e9",
"ProxyOrganizationOpenId": "org_open_id"
},
"Name": "",
"Mobile": "",
"FlowGroupId": "yDxxxxxxxxxxxxxxxxxxxxxxxx",
"OpenId": "user_open_id"
}
输出示例
{
"Response": {
"SignUrl": "https://embed.test.qian.tencent.cn/console/?channel=PROXYCHANNEL&expiredTime=1695805069&code=xxxxx&menuStatus=ENABLE&token=xxxx",
"ExpiredTime": 0,
"RequestId": "s1695804769054178191"
}
}
示例4 创建签署链接
待签署的合同
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelCreateOrganizationBatchSignUrl
<公共请求参数>
{
"Agent": {
"AppId": "60exxxxxxxxxxxxxxxxxxxxxc16e9",
"ProxyOrganizationOpenId": "org_open_id"
},
"Name": "",
"Mobile": "",
"FlowIds": [
"yDxxxxxxxxxxxxxxxxxxxxxxxx"
],
"OpenId": "user_open_id"
}
输出示例
{
"Response": {
"SignUrl": "https://embed.test.qian.tencent.cn/console/?channel=PROXYCHANNEL&expiredTime=1695805069&code=xxxxx&menuStatus=ENABLE&token=xxxx",
"ExpiredTime": 0,
"RequestId": "s1695804769054178191"
}
}
示例5 创建企业动态签署领取链接，并且指定要全部领取签署
发起合同指定B端企业员工为动态签署方，通过此接口获取动态领取链接，指定要求全部合同领取进行签署。
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelCreateOrganizationBatchSignUrl
<公共请求参数>
{
"Agent": {
"AppId": "yDwFoUUckpsomwx1UyhWGhIR2RkhOjw2",
"ProxyOrganizationOpenId": "ess_open_organization_1",
"ProxyOperator": {
"OpenId": "kevinlcheng"
}
},
"FlowIds": [
"yDtK2UUckpfmgingU1UyHCZxCSSvzgqj"
],
"RecipientIds": [
"yDtK2UUckpfmgindUyHCZxCEZrJgOW8c"
],
"DynamicSignOption": {
"DynamicReceiveType": 1
},
"CanBatchReject": true
}
输出示例
{
"Response": {
"ExpiredTime": 1767668544,
"SignUrl": "https://embed.qian.tencent.com/contract-batchsign?embed=1&expiredOn=1767668544&code=yDtKzUUjfirlg0UELHh8vSRBXpQy0eNn&shortKey=yDtKzURSnZttci5qlP81&channel=PROXYCHANNEL",
"RequestId": "d21351b2-9733-4cf4-bc41-df22795ac73e"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InternalError.Api | 其他API错误。 |
| InternalError.Db | 数据库错误。 |
| InternalError.DependsDb | 数据库异常。 |
| InvalidParameter | 参数错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |