API 中心

文档中心 API 中心腾讯电子签可嵌入页面相关接口获取企业签署合同web页面

获取企业签署合同web页面

最近更新时间：2024-04-15 01:41:03

我的收藏

本页目录：

1. 接口描述

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

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

附注：

员工必须需作为批量签署合同的签署方，or或签合同的候选人之一。
对于本方企业：如有UserId，应以UserId为主要标识；如果没有UserId，则必须填写Name和Mobile信息。
若要生成他发企业签署链接：应传RecipientIds，且制定的合同必须是接口调用方发起的。
支持待签署、待填写状态的合同生成签署链接。

默认接口请求频率限制：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. 输出参数

参数名称	类型	描述
SignUrl	String	批量签署入口链接，用户可使用这个链接跳转到控制台页面对合同进行签署操作。
ExpiredTime	Integer	链接过期截止时间，格式为Unix标准时间戳（秒），默认为7天后截止。
RequestId	String	唯一请求 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. 开发者资源

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

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.Api	第三方接口失败。
InternalError.Db	数据库异常。
InvalidParameter	参数错误。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。

上一篇: 创建发起流程web页面下一篇: 获取其他可嵌入web页面

获取企业签署合同web页面

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

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

输入示例

输出示例

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

输入示例

输出示例

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

输入示例

输出示例

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

输入示例

输出示例

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

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码

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

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