调用DescribePhoneNumberStatus接口获取手机号码实时在网状态,例如正常、停机、空号等状态。
使用说明
- 计费:接口查询返回码为成功(即Code="OK")且号码状态的返回结果字段Status不为UNKNOW时计费。按查询成功次数计费,标准价0.1元/次。
- 不计费:查询失败、查询无结果或者返回结果Status为UNKNOW时不计费。
QPS限制
本接口的单用户QPS限制为300次/秒。若超过该限制,API会被限流,这可能会影响您的业务的使用,请您合理调用。
授权信息
默认仅限阿里云账号使用本接口,RAM用户只有被授予了相关API操作权限后方可使用。具体操作请参见为RAM用户授权。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribePhoneNumberStatus | 系统规定参数。取值:DescribePhoneNumberStatus。 |
| PhoneNumber | String | 是 | 1511234**** | 要查询的手机号码。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Code | String | OK | 请求状态码。取值:
说明 请求状态码详情请参见下表:状态码原因及解决方案。
|
| Message | String | OK | 状态码的描述。 |
| RequestId | String | CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47 | 请求ID。 |
| PhoneStatus | Object | 号码状态。 | |
| Status | String | NORMAL | 手机号码状态。取值:
|
| Carrier | String | CMCC | 对外运营商。取值:
|
状态码原因及解决方案
| 状态码 | 原因 | 解决方案 |
|---|---|---|
| OK:成功。 | 请求参数符合要求。 | 接口调用成功。 |
| InvalidParameter:传入的手机号错误或参数格式错误。 | 请求参数的手机号格式错误或请求参数不符合API接口的要求。 | 输入正确的手机号或调整请求参数的格式,再重新提交请求。如:删除手机号中的不可见字符、空格、调整为半角字符等。若手机号格式正确仍出现该错误码,请通过工单联系工程师处理。 |
| OperatorLimit:运营商禁止查询的手机号。 | 该号码运营商侧禁止查询或查询不出结果。 | 请重试或使用其它号码查询。建议重复查询的次数不要超过3次。 |
| isp.UNKNOWN:未知异常。 | 未知异常。 | 请尝试重新调用接口,建议重试的次数不要超过3次。如仍存在此异常,请通过工单反馈至工程师处理。 |
API修订记录
| 修订时间 | 修订类别 | 修订内容 |
|---|---|---|
| 2022-02-10 | Code枚举值修订 | 原有错误码isv.INVALID_PARAMETERS、isv.MOBILE_NUMBER_ILLEGAL,修改为InvalidParameter错误码。 |
| 原有错误码isp.OPERATOR_LIMIT,修改为OperatorLimit错误码。 | ||
| 删除isp.SYSTEM_ERROR错误码,修改为InternalError异常。 | ||
| 删除isp.QPS_LIMIT错误码,修改为System.LimitControl异常。 |
示例
- 请求示例
http(s)://dytnsapi.aliyuncs.com/?Action=DescribePhoneNumberStatus &PhoneNumber=1511234**** &公共请求参数 - 正常返回示例
- XML格式
HTTP/1.1 200 OK Content-Type:application/xml <DescribePhoneNumberStatusResponse> <Code>OK</Code> <Message>OK</Message> <RequestId>CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47</RequestId> <PhoneStatus> <Status>NORMAL</Status> <SerialId>1100000000000</SerialId> <Carrier>CMCC</Carrier> </PhoneStatus> </DescribePhoneNumberStatusResponse> - JSON格式
HTTP/1.1 200 OK Content-Type:application/json { "Code" : "OK", "Message" : "OK", "RequestId" : "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47", "PhoneStatus" : { "Status" : "NORMAL", "SerialId" : "1100000000000", "Carrier" : "CMCC" } }
- XML格式
错误码
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Ram.CheckFailed | You did not pass the ARM permission check. | RAM权限校验失败。 |
| 400 | Ram.PermissionDeny | You are not authorized to perform the operation. | 权限不足。 |
| 400 | Unknown.ResourceOwnerId | The resource does not belong to the current user. | 资源不属于当前用户。 |
| 400 | Product.Unsubscript | You have not subscribed to the specified product. | 未订阅该功能。 |
| 400 | Product.NotOrdered | You have not ordered this product (offer). | 未订购该产品。 |
| 400 | System.LimitControl | The system is under flow control. | 系统限流控制。 |
| 400 | OutOfService | The ISV is out of service. | 业务已停机。 |
| 400 | Insufficient.Balance | You have an insufficient balance. | 余额不足。 |
| 403 | Permission.NotAuthorized | You are not authorized to perform the operation. | 您没有权限执行此操作。 |
| 500 | InternalError | An error occurred while processing your request. | 系统异常。 |