文档中心>API 中心>腾讯电子签>个人账号管理相关接口>获取设置自动签印章小程序链接

获取设置自动签印章小程序链接

最近更新时间:2025-03-20 11:33:03

我的收藏

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 : 电子处方场景
  • OTHER : 通用场景

示例值: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 获取设置自动签印章的小程序链接。

  1. 用户已经开通自动签。
  2. 获取设置自动签印章的小程序链接。

输入示例

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

{
    "Operator": {
        "ClientIp": "1.2.3.4",
        "UserId": "yDRCLUUgygq2xu********Ewg0vjoimj"
    },
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
    "UserInfo": {
        "IdCardNumber": "620000198802020000",
        "IdCardType": "ID_CARD",
        "Name": "典子谦"
    }
}

输出示例

复制
复制成功
{
    "Response": {
        "AppId": "wxa023******e1d",
        "AppOriginalId": "gh_da87*******987",
        "Path": "page?abc=123&def=456",
        "QrCode": "EBAQAAAAAAAAAAAQIDBAUGBwgxxxxxwAEEQUSITFBBhNRYQcicRQygZGhCCN",
        "RequestId": "s169563****093",
        "Url": "https://essurl.cn/dKd**6ZCh"
    }
}

示例2 错误示例-获取设置自动签印章的小程序链接。

  1. 用户没有开通自动签。

输入示例

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

{
    "Operator": {
        "ClientIp": "1.2.3.4",
        "UserId": "yDRCLUUgygq2xu********Ewg0vjoimj"
    },
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
    "UserInfo": {
        "IdCardNumber": "37000019890303000X",
        "IdCardType": "ID_CARD",
        "Name": "张三"
    }
}

输出示例

复制
复制成功
{
    "Response": {
        "Error": {
            "Code": "FailedOperation",
            "Message": "用户未开通自动签"
        },
        "RequestId": "s16***55712"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError.Db 数据库异常。
InternalError.Decryption 解密失败。
InternalError.DependsApi 依赖的第三方API返回错误。
InternalError.Encryption 加密失败。
InvalidParameter 参数错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。

如果遇到产品相关问题,您可咨询 在线客服 寻求帮助。

返回顶部
可通过正文划词反馈文档内容问题,我们会快速处理并更新文档内容。