查询个人用户开通自动签状态

1. 接口描述

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

通过此接口获取个人用户自动签的开通状态。

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

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ChannelDescribeUserAutoSignStatus。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
Agent	是	Agent	关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
SceneKey	是	String	自动签使用的场景值, 可以选择的场景值如下: E_PRESCRIPTION_AUTO_SIGN : 电子处方场景 OTHER : 通用场景
UserInfo	是	UserThreeFactor	要查询状态的用户信息, 包括名字,身份证等
Operator	否	UserInfo	执行本接口操作的员工信息。 注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。

3. 输出参数

参数名称	类型	描述
IsOpen	Boolean	查询用户是否已开通自动签 示例值：true
LicenseFrom	Integer	自动签许可生效时间。当且仅当已通过许可开通自动签时有值。 值为unix时间戳,单位为秒。 示例值：1684412179
LicenseTo	Integer	自动签许可到期时间。当且仅当已通过许可开通自动签时有值。 值为unix时间戳,单位为秒。 示例值：1715948179
LicenseType	Integer	设置用户开通自动签时是否绑定个人自动签账号许可。 0: 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: 不可解绑释放更换他人 1: 不绑定自动签账号许可开通，后续使用合同份额进行合同发起
SealId	String	用户开通自动签指定使用的印章，为空则未设置印章，需重新进入开通链接设置印章。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看个人自动签开启状态

查看个人自动签状态, 同时也会返回自动签license类型，如果是 0 类型，则同时会返回开始和过期时间。

输入示例

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

{
    "Operator": {
        "OpenId": "",
        "ClientIp": "",
        "CustomUserId": "",
        "ProxyIp": "",
        "Channel": ""
    },
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
    "Agent": {
        "ProxyAppId": "c17bdf9c2a7bdcb32611f4d0200fef3d",
        "ProxyOrganizationOpenId": "d7c13a8b81340cce9e3968c0ee248f04",
        "ProxyOperator": {
            "OpenId": "00498cc8500be9cxxxxxxx3aff766cac"
        },
        "AppId": "65fb0c591044be8a1f60aa382cc5ed0e"
    },
    "UserInfo": {
        "Name": "小明",
        "IdCardNumber": "610000000000000000",
        "IdCardType": "ID_CARD"
    }
}

输出示例

{
    "Response": {
        "IsOpen": true,
        "LicenseFrom": 1684411624,
        "LicenseTo": 1715947624,
        "SealId": "yDCbaUUckpwxv0ulUyZJC13u24H1GMOK",
        "RequestId": "5beb5f54-cf3d-4c26-a4ee-a97c85196a3e"
    }
}

5. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError.Db	数据库错误。
InternalError.Encryption	加密错误。
InvalidParameter.CardNumber	证件号码错误。
InvalidParameter.CardType	证件类型错误。
InvalidParameter.Name	姓名不符合要求。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。