跳到主要内容

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

1. 接口描述

接口请求域名: essbasic.tencentcloudapi.com 。

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

注意:

  • 需要企业开通自动签后使用。
  • 仅支持已经开通了自动签的个人更换自动签印章。
  • 链接有效期默认7天,最多30天
  • 该接口的链接适用于小程序端。
  • 该接口不会扣除您的合同套餐,暂不参与计费。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称必选类型描述
ActionString公共参数,本接口取值:ChannelCreateUserAutoSignSealUrl。
VersionString公共参数,本接口取值:2021-05-26。
RegionString公共参数,此参数为可选参数。
AgentAgent渠道应用相关信息。
SceneKeyString自动签使用的场景值, 可以选择的场景值如下:
  • E_PRESCRIPTION_AUTO_SIGN : 电子处方场景
  • OTHER : 通用场景

示例值:E_PRESCRIPTION_AUTO_SIGN
UserInfoUserThreeFactor自动签开通个人用户信息,包括名字,身份证等。
OperatorUserInfo执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
ExpiredTimeInteger链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。如果不传,默认过期时间为当前时间往后7天。

3. 输出参数

参数名称类型描述
AppIdString腾讯电子签小程序的AppId,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
AppOriginalIdString腾讯电子签小程序的原始Id,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
UrlString个人用户自动签的开通链接, 短链形式。过期时间受 ExpiredTime 参数控制。
示例值:https://essurl.cn/001uSHUNDy
PathString腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
QrCodeStringbase64格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
RequestIdString唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取设置个人自动签印章的小程序链接。

  1. 企业已经开通自动签功能。
  2. 个人已经开通自动签。

输入示例

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

{
"Agent": {
"AppId": "65fb0c591044be8a1f60aa382cc5ed0e",
"ProxyOperator": {
"OpenId": "00498cc8500be9cxxxxxxx3aff766cac"
},
"ProxyOrganizationOpenId": "d7c13a8b81340cce9e3968c0ee248f04"
},
"SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
"UserInfo": {
"IdCardNumber": "1xxxxxxxxxxxxxx0",
"IdCardType": "ID_CARD",
"Name": "小明"
}
}

输出示例

{
"Response": {
"AppId": "wxa023******e1d",
"AppOriginalId": "gh_da87*******987",
"Path": "page?abc=123&def=456",
"QrCode": "EBAQAAAAAAAAAAAQIDBAUGBwgxxxxxwAEEQUSITFBBhNRYQcicRQygZGhCCN",
"RequestId": "s1695****69",
"Url": "https://essurl.cn/vg****6YYG"
}
}

示例2 错误示例-获取设置个人自动签印章链接,个人没有开通自动签。

  1. 企业开通自动签。
  2. 个人没有开通自动签。

输入示例

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

{
"Agent": {
"AppId": "65fb0c591044be8a1f60aa382cc5ed0e",
"ProxyOperator": {
"OpenId": "00498cc8500be9cxxxxxxx3aff766cac"
},
"ProxyOrganizationOpenId": "d7c13a8b81340cce9e3968c0ee248f04"
},
"SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
"UserInfo": {
"IdCardNumber": "1xxxxxxxxxxxxxx0",
"IdCardType": "ID_CARD",
"Name": "小明"
}
}

输出示例

{
"Response": {
"Error": {
"Code": "FailedOperation",
"Message": "用户未开通自动签"
},
"RequestId": "s169***148251031"
}
}

5. 错误码

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

错误码描述
FailedOperation操作失败。
InternalError.Db数据库错误。
InternalError.Decryption解密错误。
InternalError.DependsApi依赖的其他api出错。
InternalError.Encryption加密错误。
InvalidParameter参数错误。
MissingParameter缺少参数错误。
OperationDenied操作被拒绝。
购买咨询
4006-808-062
4006-808-062