查询手机号码的归属信息,包括:所属省份、所属城市、所属基础运营商(中国移动、中国联通、中国电信、中国广电)、移动转售企业(阿里通信等)、是否携号转网、归属号码段等。
接口说明
-
请确保在使用本接口前,您已充分了解号码百科产品计费。
-
默认仅阿里云账号使用本接口,RAM 用户只有在被授予相关 API 操作权限后才可使用。相关操作,请参见为 RAM 用户授权。
-
本接口用于获取号码当前服务运营商、归属地和携号转网信息,支持明文、MD5、SHA256 加密手机号码的查询。
-
使用本接口前,请登录号码百科控制台,在标签广场页面,找到对应的标签,单击申请开通,填写申请资料,审批通过后即可使用。
QPS 限制
本接口的单用户 QPS 限制为 2000 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dytns:DescribePhoneNumberOperatorAttribute | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InputNumber | string | 是 | 待查询的号码。
注意 加密字符串中字母不区分大小写。 | 139****1234 |
AuthCode | string | 是 | 授权码。 说明
在号码百科控制台我的申请页面,获取授权 ID 即授权码。
| Dd1r***4id |
Mask | string | 是 | 号码的加密方式。取值:
注意 字符串中所有字母必须大写。 | MD5 |
FlowName | string | 否 | 系统参数,无需填写 | - |
ResultCount | string | 否 | 系统参数,无需填写 | - |
返回参数
状态码原因及解决方案
状态码 | 原因 | 解决方案 |
---|---|---|
OK:成功。 | 请求参数符合要求。 | 表示接口调用成功。 |
InvalidParameter:传入的手机号错误或参数格式错误。 | 请求参数的手机号格式错误或请求参数不符合 API 接口的要求。 | 输入正确的手机号或调整请求参数的格式,再重新提交请求。如:删除手机号中的不可见字符、空格、调整为半角字符等。 |
PhoneNumberNotfound:传入的手机号查不到归属结果。 | 传入的手机号查不到归属结果。 | 请更换其他手机号查询。 |
isp.UNKNOWN:未知异常。 | 系统返回了未知异常。 | 请尝试重新调用接口,建议重试的次数不要超过 3 次。 |
BasicCarrier 和 Carrier 字段含义:
手机号段归属 | 是否有携号转网 | BasicCarrier 字段返回结果 | Carrier 字段返回结果 |
---|---|---|---|
基础运营商号段 | 是 | 携转后基础运营商(中国移动、中国联通、中国电信、中国广电) | 携转后基础运营商(中国移动、中国联通、中国电信、中国广电) |
基础运营商号段 | 否 | 基础运营商(中国移动、中国联通、中国电信、中国广电) | 基础运营商(中国移动、中国联通、中国电信、中国广电) |
虚拟运营商号段 | 暂不支持 | 基础运营商(中国移动、中国联通、中国电信、中国广电) | 虚拟运营商(如:阿里云通信等) |
示例
正常返回示例
JSON
格式
{
"AccessDeniedDetail": "-",
"Message": "OK",
"RequestId": "68A40250-50CD-034C-B728-0BD135850177",
"Data": {
"BasicCarrier": "中国移动",
"NumberSegment": 139,
"IsNumberPortability": false,
"Carrier": "中国移动",
"City": "杭州",
"Province": "浙江"
},
"Code": "OK"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | EncyrptTypeIllegal | The encryption type of the mobile phone number is illegal | 手机号加密类型非法 |
400 | InvalidParameter | The specified mobile phone number is invalid. | 非法号码 |
400 | PhoneNumberNotfound | The queried number is not found. | 传入的手机号未查到归属结果 |
400 | InvalidParameter | The specified parameter is invalid. | 参数异常 |
400 | MobileNumberTypeNotMatch | The number and number type do not match. | 号码与号码类型不匹配 |
400 | AuthCodeNotExist | The authorization code application failed and cannot be used. | 授权码申请失败,不可使用 |
400 | AuthCodeNotExist | The authorization code does not exist. | 授权码不存在 |
400 | AuthCodeNotExist | The authorization code is being applied and cannot be used. | 授权码申请中,暂不可使用 |
400 | MobileNumberIllegal | Wrong format of phone number | 手机号码格式错误 |
400 | AuthCodeNotExist | The label application form does not exist, please replace the authorization code. | 该标签申请单不存在,请重新更换授权码 |
400 | InvalidParameter | Invalid parameter. | 无效参数 |
400 | AuthCodeIllegal | Illegal authCode. | 鉴权时使用的authcode不可用于该接口 |
500 | InternalError | A system error occurred. | 系统异常 |
500 | RequestTimeout | Request supplier timed out. | 请求供应商超时 |
500 | RequestSupplierError | Request supplier error. | 请求第三方服务异常。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-07-08 | OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-09-11 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-05-17 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-05-10 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2022-06-28 | 新增 OpenAPI | 查看变更详情 |