1. 接口描述
接口请求域名： faceid.tencentcloudapi.com 。
本接口用于验证手机号的状态，您可以输入手机号进行查询。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：MobileStatus。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-01。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Mobile | 是 | String | 手机号码。 示例值：16137688175 |
| Encryption | 否 | Encryption | 敏感数据加密信息。 - 对传入信息（手机号）有加密需求的用户可使用此参数，详情请点击左侧链接。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | String | 认证结果码，收费情况如下。 - 收费结果码： 0：成功。 - 不收费结果码： -1：未查询到结果。 -2：手机号格式不正确。 -3：验证中心服务繁忙。 -4：认证次数超过当日限制，请次日重试。 示例值：0 |
| Description | String | 业务结果描述。 示例值：成功 |
| StatusCode | Integer | 状态码。 - 取值范围： 0：正常。 1：停机。 2：销号。 3：空号。 4：不在网。 99：未知状态。 示例值：1 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 核验成功
验证手机号的状态。
输入示例
https://faceid.tencentcloudapi.com/?Action=MobileStatus
&Mobile=13800138000
&<公共请求参数>输出示例
{
"Response": {
"Result": "0",
"Description": "成功",
"StatusCode": 1,
"RequestId": "f893bfcf-167d-45df-99aa-60a23fe5809d"
}
}示例2 异常示例
验证手机号的状态，输入异常手机号。
输入示例
https://faceid.tencentcloudapi.com/?Action=MobileStatus
&Mobile=16137688175
&<公共请求参数>输出示例
{
"Response": {
"Description": "手机号格式不正确",
"RequestId": "7411a5fc-0ba6-431d-9e8a-5f6537fb8701",
"Result": "-2",
"StatusCode": 99
}
}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.DecryptSystemError | 解密失败。 |
| FailedOperation.StsUnAuthErrError | STS未授权。 |
| FailedOperation.UnKnown | 内部未知错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.UnsupportEncryptField | 存在不加密的字段，请参考文档修改。 |
| InvalidParameterValue | 参数取值错误。 |
| UnauthorizedOperation.Arrears | 账号已欠费。 |
| UnauthorizedOperation.ChargeStatusException | 计费状态异常。 |
| UnauthorizedOperation.NonAuthorize | 账号未实名。 |
| UnauthorizedOperation.Nonactivated | 未开通服务。 |
