获取手机号码实时在网状态,例如正常、停机、空号等状态。支持明文、MD5/SHA256加密方式的号码查询。
接口说明
- 请确保在使用本接口前,您已充分了解号码百科产品定价。
- 默认仅阿里云账号使用本接口,RAM 用户只有在被授予相关 API 操作权限后才可使用。相关操作,请参见为 RAM 用户授权。
- 使用本接口前,请登录号码百科控制台,在标签广场页面,找到对应的标签,单击申请开通,填写申请资料,审批通过后即可使用。
QPS 限制
本接口的单用户 QPS 限制为 300 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dytns:PhoneNumberStatusForAccount | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AuthCode | string | 是 | 授权码。 说明
在号码百科控制台我的申请页面,获取授权 ID 即授权码。
| Dd1r***4id |
InputNumber | string | 是 | 待查询的号码。
注意 加密字符串中字母不区分大小写。 | 139****1234 |
Mask | string | 是 | 加密方式。取值:
| NORMAL |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
"Data": {
"Status": "NORMAL",
"Carrier": "CMCC"
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
200 | OperatorLimit | The number is limited by the operator. | 该号码受运营商限制 |
400 | MobileNumberIllegal | Wrong format of phone number | 手机号码格式错误 |
400 | CarrierIllegal | Illegal carrier type | 运营商类型非法 |
400 | AuthCodeNotExist | The label application form does not exist, please replace the authorization code. | 该标签申请单不存在,请重新更换授权码 |
400 | MobileNumberTypeIllegal | Invalid number type. | 号码类型错误 |
400 | MobileNumberTypeNotMatch | The number and number type do not match. | 号码与号码类型不匹配 |
400 | InvalidParameter | Invalid parameter. | 无效参数 |
400 | AuthCodeIllegal | Illegal authCode. | 鉴权时使用的authcode不可用于该接口 |
500 | SystemError | System error | 系统异常 |
500 | Unknown | Unknown error | 未知异常 |
500 | EncyrptTypeIllegal | The encryption type of the mobile phone number is illegal | 手机号加密类型非法 |
500 | RequestTimeout | Request supplier timed out. | 请求供应商超时 |
500 | RequestSupplierError | Request supplier error. | 请求第三方服务异常。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-05-29 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-05-17 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-04-28 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2022-07-13 | 新增 OpenAPI | 查看变更详情 |