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

1. 接口描述

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

企业方可以通过此接口查询个人用户自动签开启状态。（处方单场景专用，使用此接口请与客户经理确认）

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeUserAutoSignStatus。
Version	是	String	公共参数，本接口取值：2020-11-11。
Region	否	String	公共参数，本接口不需要传递此参数。
Operator	是	UserInfo	操作人信息，UserId必填
SceneKey	是	String	自动签场景: E_PRESCRIPTION_AUTO_SIGN 电子处方
UserInfo	是	UserThreeFactor	查询开启状态的用户信息

3. 输出参数

参数名称	类型	描述
IsOpen	Boolean	是否已开通自动签
LicenseFrom	Integer	自动签许可生效时间。当且仅当已开通自动签时有值。
LicenseTo	Integer	自动签许可到期时间。当且仅当已开通自动签时有值。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

查看个人自动签开启状态

输入示例

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

{
    "Operator": {
        "UserId": "abc"
    },
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN",
    "UserInfo": {
        "Name": "小明",
        "IdCardNumber": "610000000000000000",
        "IdCardType": "ID_CARD"
    }
}

输出示例

{
    "Response": {
        "IsOpen": true,
        "LicenseFrom": 1684412179,
        "LicenseTo": 1715948179,
        "RequestId": "5beb5fxxxxx-a97c85196a3e"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.Api	第三方接口失败。
InternalError.Cache	缓存错误。
InternalError.CallOpenCloudApiError	调用OpenCloud云api内部错误。
InternalError.Callback	回调错误。
InternalError.Db	数据库异常。
InternalError.DbConnection	数据库连接出错。
InternalError.DbInsert	数据库新增记录出错。
InternalError.DbRead	内部错误,数据库查询失败,请稍后重试。
InternalError.Decryption	解密失败。
InternalError.DependsApi	依赖的第三方API返回错误。
InternalError.DependsDb	数据库执行错误。
InternalError.Encryption	加密失败。
InternalError.JsonMarshal	Json序列化失败。
InternalError.Pdf	Pdf错误。
InternalError.Serialize	序列化错误。
InternalError.System	系统错误，请稍后重试。
InvalidParameter	参数错误。
InvalidParameter.CardNumber	不合法的证件信息，请检查证件号证件类型是否正确。
InvalidParameter.CardType	不合法的证件信息，请检查证件号证件类型是否正确。
InvalidParameter.Name	不合法的用户名称，请修改后重试。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。

1. 接口描述​

2. 输入参数​

3. 输出参数​

4. 示例​

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

输入示例​

输出示例​

5. 开发者资源​

腾讯云 API 平台​

API Inspector​

SDK​

命令行工具​

6. 错误码​