1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
本接口(CreateSealPolicy)用于对企业员工进行印章授权
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateSealPolicy。 |
| Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| Operator | 是 | UserInfo | 执行本接口操作的员工信息。 |
| Users.N | 是 | Array of UserInfo | 用户在电子文件签署平台标识信息,具体参考UserInfo结构体。可跟下面的UserIds可叠加起作用, |
| SealId | 是 | String | 电子印章ID,为32位字符串。 示例值:yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw |
| Expired | 是 | Integer | 授权有效期,时间戳秒级。可以传0,代表有效期到2099年12月12日23点59分59秒。 示例值:1736478409 |
| UserIds.N | 否 | Array of String | 需要授权的用户UserId集合。跟上面的SealId参数配合使用。选填,跟上面的Users同时起作用。 示例值:["yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84"] |
| Policy | 否 | String | 印章授权内容,最多300 个字符。 示例值:印章授权内容 |
| Agent | 否 | Agent | 代理企业和员工的信息。 |
| Options.N | 否 | Array of Option | 个性化配置字段,默认不传。 |
| AuthorizationFlows | 否 | SealPolicyAuthorizationFlows | 针对用印的合同/合同组授权。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| UserIds | Array of String | 最终授权成功的用户ID,在腾讯电子签平台的唯一身份标识,为32位字符串。 示例值:["yDR1dUUgygj77gh6UuO4zjEvSXYRnQ84"] |
| SealOperatorVerifyPath | String | 人脸验证操作人链接,用法可以参考"跳转电子签小程序配置",默认为空。 示例值:/pages/guide/index?to=FACE_IDENTIFY&request_token=yDXXXXXXXXXXXXXX&expired_time=1758888888 |
| SealOperatorVerifyQrcodeUrl | String | 人脸验证操作人二维码链接,扫码后会跳转到腾讯电子签小程序进行人脸验证,默认为空。 示例值:https://file.test.ess.tencent.cn/bresource/resource/resource/0/0.JPG?hkey=xxxxxxxxxxxxxxxxxxxxxxxxxxx |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 印章授权申请下发
给指定人员下发印章授权
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSealPolicy
<公共请求参数>
{
"SealId": "yDxbNUyKQDx3oAUuO4zjEBQGidlGe4hP",
"Policy": "",
"Operator": {
"UserId": "yDRCLUUgygq2xun5UuO4zjEwg0vjoimj"
},
"Expired": 1736906734,
"Users": [
{
"UserId": "yDRSRUUgygj6rqouUuO4zjESlnSFPcIE"
}
]
}
输出示例
{
"Response": {
"RequestId": "49500cb4-ca5e-4da0-93fb-e15f3a710ed7 ",
"UserIds": []
}
}
示例2 针对用印的合同授权
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateSealPolicy
<公共请求参数>
{
"Operator": {
"UserId": "yDtT9UUckp9fjxkfUu1yXuRSuJNQ0bO6"
},
"Users": [
{
"UserId": "yDtT9UUckp9fjxkfUu1yXuRSuJNQ0bO6"
}
],
"SealId": "yDClqUUckpaj38v1UmGrVdB8iMEXjdyR",
"Expired": 1789442071,
"UserIds": [
"yDtT9UUckp9fjxkfUu1yXuRSuJNQ0bO6"
],
"Policy": "测试*******",
"AuthorizationFlows": {
"FlowIds": [
"yD3a2UUckpmwknasU1Uy3T8nlBwEDRxj"
]
}
}
输出示例
{
"Response": {
"SealOperatorVerifyPath": "",
"SealOperatorVerifyQrcodeUrl": "",
"UserIds": [
"yDtT9UUckp9fjxkfUu1yXuRSuJNQ0bO6"
],
"RequestId": "3add2dda-bd7b-471a-9bbf-85e814de2dab"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| InternalError | 内部错误。 |
| InternalError.DependsDb | 数据库执行错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.ParamError | 参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.OrganizationClosing | 企业注销中 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation | 未授权操作。 |