跳到主要内容

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

1. 接口描述​

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

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

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

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：ChannelCreateUserAutoSignEnableUrl。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
Agent是Agent关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
SceneKey是String自动签使用的场景值, 可以选择的场景值如下:
  • E_PRESCRIPTION_AUTO_SIGN : 电子处方场景
  • OTHER : 通用场景

示例值：E_PRESCRIPTION_AUTO_SIGN
Operator否UserInfo执行本接口操作的员工信息。
注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
AutoSignConfig否AutoSignConfig自动签开通配置信息, 包括开通的人员的信息等
UrlType否String生成的链接类型：
  • 不传(即为空值) 则会生成小程序端开通链接(默认)
  • H5SIGN : 生成H5端开通链接

示例值：H5SIGN
NotifyType否String是否通知开通方，通知类型:
  • 默认不设置为不通知开通方
  • SMS : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号
NotifyAddress否String如果通知类型NotifyType选择为SMS，则此处为手机号, 其他通知类型不需要设置此项
示例值：13200000000
ExpiredTime否Integer链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。如果不传，默认过期时间为当前时间往后7天。
UserData否String调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。 在个人自动签的开通、关闭等回调信息场景中，该字段的信息将原封不动地透传给贵方。

3. 输出参数​

参数名称类型描述
UrlString个人用户自动签的开通链接, 短链形式。过期时间受 ExpiredTime 参数控制。
示例值：https://essurl.cn/002E4UGi8H
AppIdString腾讯电子签小程序的 AppID，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用

注: 如果获取的是H5链接, 则不会返回此值
AppOriginalIdString腾讯电子签小程序的原始 Id, ，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用

注: 如果获取的是H5链接, 则不会返回此值
PathString腾讯电子签小程序的跳转路径，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用

注: 如果获取的是H5链接, 则不会返回此值
QrCodeStringbase64 格式的跳转二维码图片，可通过微信扫描后跳转到腾讯电子签小程序的开通界面。

注: 如果获取的是H5链接, 则不会返回此二维码图片
UrlTypeString返回的链接类型
  • 空: 默认小程序端链接
  • H5SIGN : h5端链接
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

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

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

输入示例​

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

{
    "Operator": {
        "OpenId": "",
        "ClientIp": "",
        "CustomUserId": "",
        "ProxyIp": "",
        "Channel": ""
    },
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
    "Agent": {
        "ProxyOperator": {
            "OpenId": "test_open_id"
        },
        "ProxyOrganizationOpenId": "test_org_open_id",
        "AppId": "yDxbWUyKQ*******4zjEB8mxCcDjAyF"
    },
    "AutoSignConfig": {
        "UserInfo": {
            "Name": "小明",
            "IdCardType": "ID_CARD",
            "IdCardNumber": "1xxxxxxxxxxxxxx0"
        },
        "CertInfoCallback": true,
        "UserDefineSeal": false,
        "SealImgCallback": false
    },
    "NotifyType": "SMS",
    "NotifyAddress": "13200000000",
    "ExpiredTime": 1693290580,
    "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: essbasic.tencentcloudapi.com
Content - Type: application / json
X - TC - Action: ChannelCreateUserAutoSignEnableUrl <
    公共请求参数 >

{
    "Operator": {
        "OpenId": "",
        "ClientIp": "",
        "CustomUserId": "",
        "ProxyIp": "",
        "Channel": ""
    },
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
    "Agent": {
        "ProxyOperator": {
            "OpenId": "test_open_id"
        },
        "ProxyOrganizationOpenId": "test_org_open_id",
        "AppId": "yDxbWUyKQ*******4zjEB8mxCcDjAyF"
    },
    "AutoSignConfig": {
        "UserInfo": {
            "Name": "小明",
            "IdCardType": "ID_CARD",
            "IdCardNumber": "1xxxxxxxxxxxxxx0"
        },
        "CertInfoCallback": true,
        "UserDefineSeal": false,
        "SealImgCallback": false
    },
    "NotifyType": "SMS",
    "NotifyAddress": "13200000000",
    "ExpiredTime": 1693290580,
    "UrlType": ""
}

输出示例​

{
    "Response": {
        "AppId": "wxa02378y4jruwye1d",
        "AppOriginalId": "gh_da87293fsd87987",
        "Path": "page?abc=123&def=456",
        "QrCode": "EBAQAAAAAAAAAAAQIDBAUGBwgJCgsQAAIBAwMCBAMFBQQEAAABfQECAwAEEQUSITFBBhNRYQcicRQygZGhCCN",
        "RequestId": "5beb5f54-cf3d-4c26-a4ee-a97c85196a3e",
        "Url": "https://xxx.xxx/abc123",
        "UrlType": ""
    }
}

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

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

输入示例​

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

{
    "Operator": {
        "OpenId": "",
        "ClientIp": "",
        "CustomUserId": "",
        "ProxyIp": "",
        "Channel": ""
    },
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
    "Agent": {
        "ProxyOperator": {
            "OpenId": "test_open_id"
        },
        "ProxyOrganizationOpenId": "test_org_open_id",
        "AppId": "yDxbWUyKQ*******4zjEB8mxCcDjAyF"
    },
    "AutoSignConfig": {
        "UserInfo": {
            "Name": "小明",
            "IdCardType": "ID_CARD",
            "IdCardNumber": "1xxxxxxxxxxxxxx0"
        },
        "CertInfoCallback": true,
        "UserDefineSeal": false,
        "SealImgCallback": false,
        "VerifyChannels": [
            "TELECOM"
        ]
    },
    "NotifyType": "SMS",
    "NotifyAddress": "13200000000",
    "ExpiredTime": 1693290580,
    "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: essbasic.tencentcloudapi.com
Content - Type: application / json
X - TC - Action: ChannelCreateUserAutoSignEnableUrl <
    公共请求参数 >

{
    "Operator": {
        "OpenId": "",
        "ClientIp": "",
        "CustomUserId": "",
        "ProxyIp": "",
        "Channel": ""
    },
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
    "Agent": {
        "ProxyOperator": {
            "OpenId": "test_open_id"
        },
        "ProxyOrganizationOpenId": "test_org_open_id",
        "AppId": "yDxbWUyKQ*******4zjEB8mxCcDjAyF"
    },
    "AutoSignConfig": {
        "UserInfo": {
            "Name": "小明",
            "IdCardType": "ID_CARD",
            "IdCardNumber": "1xxxxxxxxxxxxxx0"
        },
        "CertInfoCallback": true,
        "UserDefineSeal": false,
        "SealImgCallback": false,
        "VerifyChannels": [
            "TELECOM"
        ]
    },
    "NotifyType": "SMS",
    "NotifyAddress": "13200000000",
    "ExpiredTime": 1693290580,
    "UrlType": "H5SIGN"
}

输出示例​

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

5. 错误码​

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

错误码描述
AuthFailureCAM签名/鉴权错误。
FailedOperation操作失败。
InternalError.Db数据库错误。
InternalError.Encryption加密错误。
InvalidParameter参数错误。
InvalidParameter.CardNumber证件号码错误。
InvalidParameter.CardType证件类型错误。
InvalidParameter.Name姓名不符合要求。
InvalidParameter.ParamError参数错误。
MissingParameter缺少参数错误。
OperationDenied操作被拒绝。
OperationDenied.InvalidApproverAge签署人未达到合法年龄。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062