API 中心
有奖：语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心 > 腾讯电子签 > 个人账号管理相关接口 > 获取个人用户自动签的开通状态

获取个人用户自动签的开通状态

最近更新时间：2024-03-13 15:09:14

我的收藏

本页目录：

1. 接口描述

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

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeUserAutoSignStatus。
Version 是 String 公共参数，本接口取值：2020-11-11。
Region 否 String 公共参数，此参数为可选参数。
Operator 是 UserInfo 执行本接口操作的员工信息。
注: 在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
SceneKey 是 String 自动签使用的场景值, 可以选择的场景值如下:
  • E_PRESCRIPTION_AUTO_SIGN : 电子处方场景
  • OTHER : 通用场景

示例值：E_PRESCRIPTION_AUTO_SIGN
UserInfo 是 UserThreeFactor 要查询状态的用户信息, 包括名字,身份证等
Agent 否 Agent 代理企业和员工的信息。
在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。

3. 输出参数

参数名称 类型 描述
IsOpen Boolean 查询用户是否已开通自动签
LicenseFrom Integer 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。

值为unix时间戳,单位为秒。
示例值：1684412179
LicenseTo Integer 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。

值为unix时间戳,单位为秒。
示例值：1715948179
LicenseType Integer 设置用户开通自动签时是否绑定个人自动签账号许可。

  • 0: 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: 不可解绑释放更换他人
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

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

输入示例

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

{
    "Operator": {
        "ClientIp": "1.2.3.4",
        "UserId": "yDRCLUUgygq2xu********Ewg0vjoimj"
    },
    "UserInfo": {
        "Name": "典子谦",
        "IdCardType": "ID_CARD",
        "IdCardNumber": "620000198802020000"
    },
    "SceneKey": "E_PRESCRIPTION_AUTO_SIGN"
}

输出示例

{
    "Response": {
        "IsOpen": true,
        "LicenseFrom": 1684412179,
        "LicenseTo": 1715948179,
        "LicenseType": 0,
        "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。

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InternalError.CallOpenCloudApiError 调用OpenCloud云api内部错误。
InternalError.Callback 回调错误。
InternalError.Decryption 解密失败。
InternalError.DependsApi 依赖的第三方API返回错误。
InternalError.DependsDb 数据库执行错误。
InternalError.Encryption 加密失败。
InternalError.System 系统错误，请稍后重试。
InvalidParameter 参数错误。
InvalidParameter.CardNumber 不合法的证件信息，请检查证件号证件类型是否正确。
InvalidParameter.CardType 不合法的证件信息，请检查证件号证件类型是否正确。
InvalidParameter.Name 不合法的用户名称，请修改后重试。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
中国站