1. 接口描述
接口请求域名： faceid.tencentcloudapi.com 。
用于轮询E证通H5场景EidToken验证状态。
默认接口请求频率限制：2000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CheckEidTokenStatus。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-01。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| EidToken | 是 | String | E证通流程的唯一标识，调用GetEidToken接口时生成。 示例值：2B3B265E-2C91-5A62-B32D-D0CA5C3F1A15 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 状态。 - init：EidToken未验证。 - doing: EidToken验证中。 - finished: EidToken验证完成。 - timeout: EidToken已超时。 示例值：init |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取E证通Token状态成功示例
输入示例
POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckEidTokenStatus
<公共请求参数>
{
"EidToken": "2B3B265E-2C91-5A62-B32D-D0CA5C3F1A15"
}输出示例
{
"Response": {
"RequestId": "dd4e965c-5a6f-43ee-7764-8272e16b85a3",
"Status": "doing"
}
}示例2 获取E政通Token状态失败示例
输入示例
POST / HTTP/1.1
Host: faceid.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CheckEidTokenStatus
<公共请求参数>
{
"EidToken": "3B3B265E-3C91-5A62-B32D-D0CA5C3F1A15"
}输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameterValue.BizTokenIllegal",
"Message": "BizToken不合法。"
},
"RequestId": "9ad38b82-7b5c-4bb1-b6c0-44ce86bc148e"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.DbError | 数据库异常。 |
| FailedOperation.UnKnown | 内部未知错误。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.BizTokenExpired | BizToken过期。 |
| InvalidParameterValue.BizTokenIllegal | BizToken不合法。 |
| UnauthorizedOperation.Arrears | 账号已欠费。 |
| UnauthorizedOperation.Nonactivated | 未开通服务。 |
