腾讯电子签获取个人用户自动签的开通链接

1. 接口描述

接口请求域名： ess.tencentcloudapi.com 。

获取个人用户自动签的开通链接。

注意: 处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateUserAutoSignEnableUrl。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，此参数为可选参数。
Operator	是	UserInfo	执行本接口操作的员工信息。注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
SceneKey	是	String	自动签使用的场景值, 可以选择的场景值如下: E_PRESCRIPTION_AUTO_SIGN : 电子处方场景 OTHER : 通用场景示例值：E_PRESCRIPTION_AUTO_SIGN
AutoSignConfig	是	AutoSignConfig	自动签开通配置信息, 包括开通的人员的信息等
UrlType	否	String	生成的链接类型：不传(即为空值) 则会生成小程序端开通链接(默认) H5SIGN : 生成H5端开通链接示例值：H5SIGN
NotifyType	否	String	是否通知开通方，通知类型: 默认为不通知开通方 SMS : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号示例值：SMS
NotifyAddress	否	String	如果通知类型NotifyType选择为SMS，则此处为手机号, 其他通知类型不需要设置此项示例值：13200000000
ExpiredTime	否	Integer	链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。`如果不传，默认过期时间为当前时间往后7天。` 示例值：1693290580
Agent	否	Agent	代理企业和员工的信息。在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
UserData	否	String	调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。在个人自动签的开通、关闭等回调信息场景中，该字段的信息将原封不动地透传给贵方。示例值：自定义数据

3. 输出参数

参数名称	类型	描述
Url	String	个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。示例值：https://essurl.cn/002E4UGi8H
AppId	String	腾讯电子签小程序的 AppID，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用注: `如果获取的是H5链接, 则不会返回此值` 示例值：yDxZtUyKQD2JuqUuO4zjERYG3XNeEJXw
AppOriginalId	String	腾讯电子签小程序的原始 Id, ，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用注: `如果获取的是H5链接, 则不会返回此值` 示例值：gh_39a5d3de69fa
Path	String	腾讯电子签小程序的跳转路径，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用注: `如果获取的是H5链接, 则不会返回此值` 示例值：https://essurl.cn/x9nvWU8fTg
QrCode	String	base64 格式的跳转二维码图片，可通过微信扫描后跳转到腾讯电子签小程序的开通界面。注: `如果获取的是H5链接, 则不会返回此二维码图片` 示例值：UEsDBBQACAAIAAAAAAAAAAAAAAAAAAAAAAANAAAAeGwvc3R5bGVzLnhtbKyYXW==
UrlType	String	返回的链接类型空: 默认小程序端链接 H5SIGN : h5端链接示例值：H5SIGN
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取H5开通跳转链接

将UrlType参数设置为 H5SIGN，即可获得H5页面开通链接

输入示例

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

{
    "Operator": {
        "ClientIp": "1.2.3.4",
        "UserId": "yDRCLUUgygq2xu********Ewg0vjoimj"
    },
    "AutoSignConfig": {
        "UserInfo": {
            "Name": "典子谦",
            "IdCardType": "ID_CARD",
            "IdCardNumber": "620000198802020000"
        },
        "CertInfoCallback": true,
        "UserDefineSeal": true,
        "SealImgCallback": true,
        "VerifyChannels": []
    },
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
    "UrlType": "H5SIGN"
}

输出示例

{
    "Response": {
        "AppId": "",
        "AppOriginalId": "",
        "Path": "",
        "QrCode": "",
        "RequestId": "5beb5f54-cf3d-4c26-a4ee-a97c85196a3e",
        "Url": "https://essurl.cn/q5nQ*CSFBZ",
        "UrlType": "H5SIGN"
    }
}

示例2 获取小程序跳转链接

UrlType参数是用来控制生成链接类型的，如果不传，则默认生成小程序跳转链接

输入示例

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

{
    "Operator": {
        "ClientIp": "1.2.3.4",
        "UserId": "yDRCLUUgygq2xu********Ewg0vjoimj"
    },
    "AutoSignConfig": {
        "UserInfo": {
            "Name": "典子谦",
            "IdCardType": "ID_CARD",
            "IdCardNumber": "620000198802020000"
        },
        "CertInfoCallback": true,
        "UserDefineSeal": true,
        "SealImgCallback": true,
        "VerifyChannels": []
    },
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
    "UrlType": ""
}

输出示例

{
    "Response": {
        "AppId": "wxa023******e1d",
        "AppOriginalId": "gh_da87*******987",
        "Path": "page?abc=123&def=456",
        "QrCode": "EBAQAAAAAAAAAAAQIDBAUGBwgxxxxxwAEEQUSITFBBhNRYQcicRQygZGhCCN",
        "RequestId": "5beb5f54-cf3d-4c26-a4ee-a97c85196a3e",
        "Url": "https://essurl.cn/q5nQ*CSFBZ",
        "UrlType": ""
    }
}

示例3 设置用户开通认证校验方式

通过 AutoSignConfig.VerifyChannels 参数，可以控制用户在开通的时候所使用的认证方式。以下例子为生成用户短信验证开通的链接为例，链接类型为H5跳转链接。

输入示例

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

{
    "Operator": {
        "ClientIp": "1.2.3.4",
        "UserId": "yDRCLUUgygq2xu********Ewg0vjoimj"
    },
    "AutoSignConfig": {
        "UserInfo": {
            "Name": "典子谦",
            "IdCardType": "ID_CARD",
            "IdCardNumber": "620000198802020000"
        },
        "CertInfoCallback": true,
        "UserDefineSeal": true,
        "SealImgCallback": true,
        "VerifyChannels": [
            "TELECOM"
        ]
    },
    "NotifyType": "SMS",
    "NotifyAddress": "13200000000",
    "ExpiredTime": 1693290580,
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
    "UrlType": "H5SIGN"
}

输出示例

{
    "Response": {
        "AppId": "",
        "AppOriginalId": "",
        "Path": "",
        "QrCode": "",
        "RequestId": "5beb5f54-cf3d-4c26-a4ee-a97c85196a3e",
        "Url": "https://essurl.cn/q5nQ*CSFBZ",
        "UrlType": "H5SIGN"
    }
}

示例4 通知对应开通用户以及设置过期时间

可以使用短信通知用户点击链接进行开通，短信中的链接跳转到小程序或者H5取决于UrlType参数。下面的例子将使用H5跳转链接为例。
过期时间需要使用时间戳类型进行设置，要求请参考 "ExpiredTime" 参数。

输入示例

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

{
    "Operator": {
        "ClientIp": "1.2.3.4",
        "UserId": "yDRCLUUgygq2xu********Ewg0vjoimj"
    },
    "AutoSignConfig": {
        "UserInfo": {
            "Name": "典子谦",
            "IdCardType": "ID_CARD",
            "IdCardNumber": "620000198802020000"
        },
        "CertInfoCallback": true,
        "UserDefineSeal": true,
        "SealImgCallback": true,
        "VerifyChannels": []
    },
    "NotifyType": "SMS",
    "NotifyAddress": "13200000000",
    "ExpiredTime": 1693290580,
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
    "UrlType": "H5SIGN"
}

输出示例

{
    "Response": {
        "AppId": "",
        "AppOriginalId": "",
        "Path": "",
        "QrCode": "",
        "RequestId": "5beb5f54-cf3d-4c26-a4ee-a97c85196a3e",
        "Url": "https://essurl.cn/q5nQ*CSFBZ",
        "UrlType": "H5SIGN"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.CallOpenCloudApiError	调用OpenCloud云api内部错误。
InternalError.System	系统错误，请稍后重试。
InvalidParameter	参数错误。
InvalidParameter.CardNumber	不合法的证件信息，请检查证件号证件类型是否正确。
InvalidParameter.CardType	不合法的证件信息，请检查证件号证件类型是否正确。
InvalidParameter.Name	不合法的用户名称，请修改后重试。
InvalidParameter.ParamError	参数错误。
InvalidParameterValue.Mask	需要屏蔽的告警。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
OperationDenied.Forbid	禁止此项操作。
OperationDenied.InvalidApproverAge	签署人年龄限制无法使用电子签服务。

近期搜索热词

云服务器

云硬盘

容器服务

弹性伸缩

负载均衡

私有网络

云函数

API 网关

专线接入

批量计算

微服务平台 TSF

对象存储

文件存储

全站加速网络

消息队列 CKafka 版

日志服务

云数据库 MySQL

云数据库 MariaDB

云数据库 SQL Server

云数据库 PostgreSQL

内容分发网络 CDN

云数据库 Redis®

云数据库 Memcached

云数据库 MongoDB

TDSQL MySQL版

全球应用加速

数据传输服务

腾讯云可观测平台

腾讯云区块链服务平台 TBaaS

云拨测

访问管理

主机安全

DDoS 防护

标签

密钥管理系统

Web 应用防火墙

域名注册

操作审计

SSL 证书

短信

数据万象

NLP 技术

云点播

云市场

云加密机

云安全中心

云开发 CloudBase

集团账号管理

Elasticsearch Service

腾讯云数据仓库 TCHouse-P

图像识别

口语评测（基础版）

文字识别

人脸识别

流计算 Oceanus

媒体处理

云直播

云联络中心

机器翻译

物联网通信

人脸融合

游戏数据库 TcaplusDB

弹性 MapReduce

腾讯云 BI

游戏多媒体引擎

实时音视频

渠道合作伙伴

TI-ONE 训练平台

数据安全审计

数据安全治理中心

智能视图计算平台

计费相关

消息队列 RocketMQ 版

微瓴同业开放平台

数学作业批改

商场客留大数据

声音复刻

文旅客情大数据

实时互动-工业能源版