跳到主要内容

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

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
EndPoint否String

要跳转的链接类型

  • HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ，此时返回长链
  • HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
  • APP： 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型


示例值：HTTP

3. 输出参数​

参数名称类型描述
AppIdString

腾讯电子签小程序的AppId，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。


示例值：yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw
AppOriginalIdString

腾讯电子签小程序的原始Id，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。


示例值：gh_da88f6188665
UrlString

个人用户自动签的开通链接, 短链或者长链接形式。过期时间受 ExpiredTime 参数控制。


示例值：https://essurl.cn/001uSHUNDy
PathString

腾讯电子签小程序的跳转路径，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。


示例值：pages/home/index
QrCodeString

base64格式的跳转二维码图片，可通过微信扫描后跳转到腾讯电子签小程序的开通界面。


示例值：UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAANAAAAeGwvc3R5bGVzLnhtbKyYXW==
RequestIdString唯一请求 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"
    }
}

示例3 获取设置自动签印章的小程序长链接。​

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

输入示例​

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

{
    "Operator": {
        "UserId": "yDwgGUUckp1pgi0zUEfxo8AB2PEWmWZL"
    },
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
    "UserInfo": {
        "Name": "刘付彩文",
        "IdCardType": "ID_CARD",
        "IdCardNumber": "440982199707195371"
    },
    "EndPoint": "HTTP"
}

输出示例​

{
    "Response": {
        "AppId": "",
        "AppOriginalId": "",
        "Path": "",
        "QrCode": "",
        "Url": "https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=KA_AUTO_ESIGN_MODIFY&channel=autoSign&identityChange=0&organizationId=yDwf3UUckpshchk9Uuan1OkFOE0qLixm&sceneKey=E_PRESCRIPTION_AUTO_SIGN&confToken=yD3JcUUckpepfv1yU0WZWMpDKfYS68Wu",
        "RequestId": "2c2a4cff-ce6f-4e77-95f8-69588569aab4"
    }
}

5. 错误码​

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

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