1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
获取设置自动签印章小程序链接。
注意:
- 需要
企业开通自动签
后使用。 - 仅支持
已经开通了自动签的个人
更换自动签印章。 - 链接有效期默认7天,
最多30天
。 - 该接口的链接适用于
小程序
端。 - 该接口不会扣除您的合同套餐,暂不参与计费。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateUserAutoSignSealUrl。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Operator | 是 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 |
SceneKey | 是 | String | 自动签使用的场景值, 可以选择的场景值如下:
示例值:E_PRESCRIPTION_AUTO_SIGN |
UserInfo | 是 | UserThreeFactor | 自动签开通个人用户信息, 包括名字,身份证等。 |
Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 |
ExpiredTime | 否 | Integer | 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。如果不传,默认过期时间为当前时间往后7天。 示例值:1693290580 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AppId | String | 腾讯电子签小程序的AppId,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。 示例值:yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw |
AppOriginalId | String | 腾讯电子签小程序的原始Id,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。 示例值:gh_da88f6188665 |
Url | String | 个人用户自动签的开通链接, 短链形式。过期时间受 ExpiredTime 参数控制。示例值:https://essurl.cn/001uSHUNDy |
Path | String | 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。 示例值:pages/home/index |
QrCode | String | base64格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。 示例值:UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAANAAAAeGwvc3R5bGVzLnhtbKyYXW== |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取设置自动签印章的小程序链接。
- 用户已经开通自动签。
- 获取设置自动签印章的小程序链接。
输入示例
输出示例
示例2 错误示例-获取设置自动签印章的小程序链接。
- 用户没有开通自动签。
输入示例
输出示例
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError.Db | 数据库异常。 |
InternalError.Decryption | 解密失败。 |
InternalError.DependsApi | 依赖的第三方API返回错误。 |
InternalError.Encryption | 加密失败。 |
InvalidParameter | 参数错误。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |