跳到主要内容

获取企业签署合同web页面

1. 接口描述​

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

使用此接口，您可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。

注：

  • 员工必须需作为批量签署合同的签署方，或者是或签合同的候选人之一。
  • 本方企业签署链接：如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。
  • 他方企业签署链接：传RecipientIds，且必须是合同发起方调用此接口。打开链接后需要他方签署人登录电子签系统。（如果签署人没有加入对方企业则会引导加入；如果对方企业还没有注册认证，会引导企业注册和认证）
  • 只支持待签署、待填写状态的合同生成签署链接。

签署的嵌入页面长相如下： image

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：CreateOrganizationBatchSignUrl。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，此参数为可选参数。
Operator是UserInfo执行本接口操作的员工信息。使用此接口时，必须填写userId。
支持填入集团子公司经办人 userId 代发合同。

注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
FlowIds.N是Array of String请指定需执行批量签署的流程ID，数量范围为1-100。
您可登录腾讯电子签控制台，浏览 "合同"->"合同中心" 以查阅某一合同的FlowId（在页面中显示为合同ID）。
用户将利用链接对这些合同实施批量操作。
Agent否Agent代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
UserId否String员工在腾讯电子签平台的独特身份标识，为32位字符串。
您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的UserId（在页面中显示为用户ID）。
UserId必须是传入合同（FlowId）中的签署人。


  • 1. 若UserId为空，Name和Mobile 必须提供。
  • 2. 若UserId 与 Name，Mobile均存在，将优先采用UserId对应的员工。

Name否String员工姓名，必须与手机号码一起使用。
如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
Mobile否String员工手机号，必须与姓名一起使用。
如果UserId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
RecipientIds.N否Array of String为签署方经办人在签署合同中的参与方ID，必须与参数FlowIds数组一一对应。
您可以通过查询合同接口（DescribeFlowInfo）查询此参数。
若传了此参数，则可以不传 UserId, Name, Mobile等参数

3. 输出参数​

参数名称类型描述
SignUrlString批量签署入口链接，用户可使用这个链接跳转到控制台页面对合同进行签署操作。
ExpiredTimeInteger链接过期截止时间，格式为Unix标准时间戳（秒），默认为7天后截止。
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 根据员工UserId获取批量签署链接​

根据员工UserId获取批量签署链接

输入示例​

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UXXXzjEwg0vjoimj"
    },
    "Agent": {
        "ProxyOrganizationId": ""
    },
    "FlowIds": [
        "yDRIxxxxxxxxxxxxxxxxxxxxxxxxxx0s",
        "yDwFmUUckpstqfvzUxxx3jo1f3cqjkGm",
        "yDwFmUUckpst10i3UxxxSat8PWOt2iQF"
    ],
    "UserId": "yDRCLUUgygq2xun5UXXXzjEwg0vjoimj"
}

输出示例​

{
    "Response": {
        "ExpiredTime": 1706100167,
        "RequestId": "s1705495367413358264",
        "SignUrl": "https://embed.test.qian.tencent.cn/contract-sign?embed=1&expiredOn=1706100167&code=yDCNBUUckpvliyc7UxKACG8SaaySZ0Cq&shortKey=yDCNBUzgv1JtyCflmM2f&channel=TENCENTCLOUD"
    }
}

示例2 参与人不在链接中， 无法生成链接报错​

参与人不在链接中， 无法生成链接报错

输入示例​

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UXXXzjEwg0vjoimj"
    },
    "Agent": {
        "ProxyOrganizationId": ""
    },
    "FlowIds": [
        "yDRIxxxxxxxxxxxxxxxxxxxxxxxxxx0s",
        "yDwFmUUckpstqfvzUxxx3jo1f3cqjkGm",
        "yDwFmUUckpst10i3UxxxSat8PWOt2iQF"
    ],
    "Name": "典子谦",
    "Mobile": "13200000000"
}

输出示例​

{
    "Response": {
        "Error": {
            "Code": "OperationDenied",
            "Message": "[yDRIxxxxxxxxxxxxxxxxxxxxxxxxxx0s yDwFmUUckpstqfvzUxxx3jo1f3cqjkGm yDwFmUUckpst10i3UxxxSat8PWOt2iQF]，经办人不是合同的实际签署人;"
        },
        "RequestId": "xxxxxxxxxxxxxxx"
    }
}

示例3 根据员工姓名和手机号获取批量签署链接​

根据员工姓名和手机号获取批量签署链接

输入示例​

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UXXXzjEwg0vjoimj"
    },
    "Agent": {
        "ProxyOrganizationId": ""
    },
    "FlowIds": [
        "yDRIxxxxxxxxxxxxxxxxxxxxxxxxxx0s",
        "yDwFmUUckpstqfvzUxxx3jo1f3cqjkGm",
        "yDwFmUUckpst10i3UxxxSat8PWOt2iQF"
    ],
    "Name": "典子谦",
    "Mobile": "13200000000"
}

输出示例​

{
    "Response": {
        "ExpiredTime": 1706100228,
        "RequestId": "s1705495428038618994",
        "SignUrl": "https://embed.test.qian.tencent.cn/contract-sign?embed=1&expiredOn=1706100228&code=yDCNBUUckpvlibzeUEMbkWeRNyTH5WNK&shortKey=yDCNBUzgvw1blVbE1L7c&channel=TENCENTCLOUD"
    }
}

示例4 UserId和 姓名手机都传递，生成的链接基于UserId生成​

UserId和 姓名手机都传递，生成的链接基于UserId生成

输入示例​

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UXXXzjEwg0vjoimj"
    },
    "Agent": {
        "ProxyOrganizationId": ""
    },
    "FlowIds": [
        "yDRIxxxxxxxxxxxxxxxxxxxxxxxxxx0s",
        "yDwFmUUckpstqfvzUxxx3jo1f3cqjkGm",
        "yDwFmUUckpst10i3UxxxSat8PWOt2iQF"
    ],
    "UserId": "yDRCLUUgygq2xun5UXXXzjEwg0vjoimj",
    "Name": "张三",
    "Mobile": "18888888888"
}

输出示例​

{
    "Response": {
        "ExpiredTime": 1706100107,
        "RequestId": "s1705495307288609862",
        "SignUrl": "https://embed.test.qian.tencent.cn/contract-sign?embed=1&expiredOn=1706100107&code=yDCNBUUckpvlibz6UEMbkWeSzl6YurH0&shortKey=yDCNBUzgvS93aBhXs3ae&channel=TENCENTCLOUD"
    }
}

示例5 基于RecipientIds 生成他方签署链接​

输入示例​

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

{
    "Operator": {
        "UserId": "yDRCLUUgygq2xun5UXXXzjEwg0vjoimj"
    },
    "Agent": {
        "ProxyOrganizationId": ""
    },
    "UserId": "",
    "Name": "",
    "Mobile": "",
    "FlowIds": [
        "yDC5yUUntf6vnnUxxBTyJ8Ps0WGqAuHL",
        "yDC5yUUntf6fccUEgcyeHwPz4wjnDSI4"
    ],
    "RecipientIds": [
        "yDC5yUUntf6vn0UxxBTyJvfv3Xlckcye",
        "yDC5yUUntf6mdgUEgcyeHCpCDmDjbsQJ"
    ]
}

输出示例​

{
    "Response": {
        "ExpiredTime": 1706100107,
        "RequestId": "s1705495307288609862",
        "SignUrl": "https://embed.test.qian.tencent.cn/contract-sign?embed=1&expiredOn=1706100107&code=yDCNBUUckpvlibz6UEMbkWeSzl6YurH0&shortKey=yDCNBUzgvS93aBhXs3ae&channel=TENCENTCLOUD"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
InternalError内部错误。
InternalError.Api第三方接口失败。
InternalError.Db数据库异常。
InvalidParameter参数错误。
MissingParameter缺少参数错误。
OperationDenied操作被拒绝。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062