获取号码分析返回结果。
接口说明
QPS 限制
本接口的单用户 QPS 限制为 1000 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。
授权信息
默认仅限阿里云账号使用本接口，RAM 用户只有在被授予了相关 API 操作权限后方可使用。具体请参见为 RAM 用户授权。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dytns:DescribePhoneNumberAnalysis |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AuthCode |
string |
是 |
授权码。 说明
在号码百科控制台我的申请页面，获取授权 ID 即授权码。 |
QASDW@#** |
| InputNumber |
string |
是 |
待查询的号码。 |
187****5620 |
| NumberType |
integer |
否 |
号码类型。取值：
|
0 |
| Mask |
string |
否 |
号码的加密方式。取值：
|
NORMAL |
| Rate |
integer |
否 |
号码分数阈值。取值范围：0~100。 重要
是否接受指定的分数阈值由服务端决定。当不接受指定分数阈值时，此字段输入的数据无效。 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| AccessDeniedDetail |
string |
访问被拒绝详细信息；只有 RAM 校验失败才会返回此字段。 |
- |
| RequestId |
string |
请求 ID。 |
CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47 |
| Message |
string |
号码状态的描述。 |
OK |
| Data |
object |
号码分析返回结果信息。 |
|
| List |
array<object> |
数据列表 |
|
|
object |
|||
| Number |
string |
传入的手机号。 |
187****5620 |
| Code |
string |
返回的结果编码。
|
NO |
| Code |
string |
请求状态码。取值： OK：成功。 |
OK |
状态码原因及解决方案
HttpCode | 返回码 | 描述 | 解决方案 |
200 | OK | 成功。 | 表示接口调用成功。 |
异常原因及解决方案
HttpCode | 错误码 | 描述 | 解决方案 |
400 | MobileNumberIllegal | 手机号非法。 | 若手机号未加密，填入 11 位正确的数字号码即可；若手机号经 MD5 加密处理，该字段为 32 位加密字符串；若手机号经 SHA256 加密处理，该字段为 64 位加密字符串。 |
400 | EncyrptTypeIllegal | 加密类型非法。 | 加密方式仅支持 NORMAL、MD5、SHA256 三种，且必须为大写字符。 |
400 | MobileNumberTypeNotMatch | 手机号码与加密类型不匹配。 | 请您填入正确手机号格式和号码加密类型。 |
400 | AuthCodeNotExist | 授权码不存在或不可用。 | 授权码不存在或授权码未通过审核，请您核实授权码的正确性。 |
400 | TagNotExist | 标签或业务资源不存在。 | 标签不存在或业务资源不存在，请核实标签的可用性。 |
400 | RateIllegal | 阈值参数非法。 | 阈值参数非法，请检查阈值参数是否合规。 |
400 | InvalidParameter | 非法参数。 | 请求参数错误，请检查参数是否正确。 |
400 | System.LimitControl | 流控错误。 | 请将查询频率限制在正常范围内，对于出现该错误码的号码适当进行重查，建议重复查询的次数不要超过 3 次。 |
500 | SystemError | 系统异常。 | 系统错误，请稍后重试。 |
示例
正常返回示例
JSON格式
{
"AccessDeniedDetail": "-",
"RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
"Message": "OK",
"Data": {
"List": [
{
"Number": "187****5620",
"Code": "NO"
}
]
},
"Code": "OK"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Product.Unsubscript | You have not subscribed to the specified product. | 未订阅该功能 |
| 400 | Ram.PermissionDeny | You are not authorized to perform the operation. | 权限不足 |
| 400 | System.LimitControl | The system is under flow control. | 系统限流控制 |
| 400 | Unknown.ResourceOwnerId | The resource does not belong to the current user. | 资源不属于当前用户 |
| 400 | MobileNumberIllegal | Wrong format of phone number | 手机号码格式错误 |
| 400 | EncyrptTypeIllegal | The encryption type of the mobile phone number is illegal | |
| 400 | MobileNumberTypeNotMatch | Phone number and encryption type do not match | |
| 400 | CarrierIllegal | Illegal carrier type | 运营商类型非法 |
| 400 | RateIllegal | Illegal threshold parameter | 阈值参数非法 |
| 400 | InvalidParameter | invalid parameter | |
| 400 | AuthCodeNotExist | The authorization code application failed and cannot be used. | 授权码申请失败，不可使用 |
| 400 | TagNotExist | The label does not exist. | 标签不存在 |
| 400 | AuthCodeIllegal | Illegal authCode. | 鉴权时使用的authcode不可用于该接口 |
| 500 | InternalError | A system error occurred. | 系统异常 |
| 500 | SystemError | A system error occurred. | 系统错误 |
| 500 | RequestTimeout | Request supplier timed out. | 请求供应商超时 |
| 500 | RequestSupplierError | Request supplier error. | 请求第三方服务异常。 |
| 403 | Permission.NotAuthorized | You are not authorized to perform the operation. | 您没有权限执行此操作 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。