调用DescribePhoneNumberAttribute接口获取号码当前服务运营商、归属地和携号转网信息。
使用说明
本接口用于获取号码当前服务运营商、归属地和携号转网信息。
QPS限制
本接口的单用户QPS限制为2000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
授权信息
默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。具体请参见为RAM用户授权。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PhoneNumber | string | 是 | 要查询的手机号码。 | 1511234**** |
返回参数
状态码原因及解决方案
状态码 | 原因 | 解决方案 |
---|---|---|
OK:成功。 | 请求参数符合要求。 | 表示接口调用成功。 |
InvalidParameter:传入的手机号错误或参数格式错误。 | 请求参数的手机号格式错误或请求参数不符合API接口的要求。 | 输入正确的手机号或调整请求参数的格式,再重新提交请求。如:删除手机号中的不可见字符、空格、调整为半角字符等。若手机号格式正确仍出现该错误码,请通过工单联系工程师处理。 |
PhoneNumberNotfound:传入的手机号查不到归属结果。 | 传入的手机号查不到归属结果。 | 请更换其他手机号查询。如有疑问,请通过工单反馈至工程师处理。 |
isp.UNKNOWN:未知异常。 | 系统返回了未知异常。 | 请尝试重新调用接口,建议重试的次数不要超过3次。如仍存在此异常,请通过工单反馈至工程师处理。 |
BasicCarrier和Carrier字段含义:
手机号段归属 | 是否有携号转网 | BasicCarrier字段返回结果 | Carrier字段返回结果 |
---|---|---|---|
基础运营商号段 | 是 | 携转后基础运营商(中国移动、中国联通、中国电信) | 携转后基础运营商(中国移动、中国联通、中国电信) |
基础运营商号段 | 否 | 基础运营商(中国移动、中国联通、中国电信) | 基础运营商(中国移动、中国联通、中国电信) |
虚拟运营商号段 | 暂不支持 | 基础运营商(中国移动、中国联通、中国电信) | 虚拟运营商(如:阿里云通信等) |
API修订记录
本次修订时间为2022-02-10、修订类别为Code枚举值修订、修订内容如下所示:
原有错误码isv.INVALID_PARAMETERS、isv.MOBILE_NUMBER_ILLEGAL,修改为InvalidParameter错误码。
原有错误码isp.NUMBER_NON_EXISTENT,修改为PhoneNumberNotfound错误码。
删除isp.SYSTEM_ERROR错误码,改为InternalError异常。
删除isp.QPS_LIMIT错误码,改为System.LimitControl异常。
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
"PhoneNumberAttribute": {
"BasicCarrier": "中国移动",
"Carrier": "中国移动",
"IsNumberPortability": false,
"NumberSegment": 1511234,
"City": "杭州",
"Province": "浙江"
}
}
XML
格式
<DescribePhoneNumberAttributeResponse>
<Code>OK</Code>
<Message>OK</Message>
<RequestId>CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47</RequestId>
<PhoneNumberAttribute>
<BasicCarrier>中国移动</BasicCarrier>
<Carrier>中国移动</Carrier>
<IsNumberPortability>false</IsNumberPortability>
<NumberSegment>1511234</NumberSegment>
<City>杭州</City>
<Province>浙江</Province>
</PhoneNumberAttribute>
</DescribePhoneNumberAttributeResponse>
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
200 | InvalidParameter | The specified parameter is invalid. | 非法参数 |
200 | PhoneNumberNotfound | The queried number is not found. | 传入的手机号未查到归属结果 |
200 | InvalidParameter | The specified mobile phone number is invalid. | 非法号码 |
400 | OutOfService | The ISV is out of service. | 业务已停机 |
400 | Product.Unsubscript | You have not subscribed to the specified product. | 未订阅该功能 |
400 | Queries.Repeated | You can only query phoneNumber once every 60 seconds. | 60秒内重复查询 |
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 | Ram.CheckFailed | You did not pass the ARM permission check. | RAM权限校验失败 |
400 | Product.NotOrdered | You have not ordered this product (offer). | 未订购该产品 |
500 | InternalError | An error occurred while processing your request. | 系统异常 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-04-12 | 新增 OpenAPI |