首页 >号码百科 >API参考 >API目录 >号码状态查询 >DescribePhoneNumberStatus - 查询号码状态信息

DescribePhoneNumberStatus - 查询号码状态信息

调用DescribePhoneNumberStatus接口获取号码实时在网状态,例如正常、停机、空号状态,支持一次请求查询一个号码实时在网状态。

接口说明

使用说明

本接口用于获取号码实时在网状态信息。发起调用该接口获取号码状态请求时,系统会根据查询次数计费,详情请参考计费说明

QPS限制

本接口的单用户QPS限制为300次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

授权信息

默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。具体请参见为RAM用户授权

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
PhoneNumberstring

要查询的手机号码。

1511234****

返回参数

名称类型描述示例值
object
Codestring

请求状态码。取值:

  • OK:成功。

  • InvalidParameter:传入的手机号或参数格式错误。

  • OperatorLimit:运营商禁止查询的手机号。

  • isp.UNKNOWN:未知异常。

说明请求状态码详情请参见下表:状态码原因及解决方案、异常原因及解决方案。
OK
Messagestring

状态码的描述。

OK
RequestIdstring

请求ID。

CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
PhoneStatusobject

号码状态。

Statusstring

手机号码状态。取值:

  • NORMAL:正常。

  • SHUTDOWN:停机。

  • NOT_EXIST:空号。

NORMAL
SerialIdstring

请求流水号。

1100000000000
Carrierstring

对外运营商。取值:

  • CMCC:中国移动。

  • CUCC:中国联通。

  • CTCC:中国电信。

  • UNKNOW:未知。

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异常。

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": "OK",
  "RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
  "PhoneStatus": {
    "Status": "NORMAL",
    "SerialId": "1100000000000",
    "Carrier": "CMCC"
  }
}

错误码

Http code错误码错误信息描述
200InvalidParameterThe specified parameter is invalid.非法参数
200InvalidParameterThe specified mobile phone number is invalid.非法号码
200OperatorLimitThe number is limited by the operator.该号码受运营商限制
400Ram.CheckFailedYou did not pass the ARM permission check.RAM权限校验失败
400Ram.PermissionDenyYou are not authorized to perform the operation.权限不足
400Unknown.ResourceOwnerIdThe resource does not belong to the current user.资源不属于当前用户
400Product.UnsubscriptYou have not subscribed to the specified product.未订阅该功能
400Product.NotOrderedYou have not ordered this product (offer).未订购该产品
400System.LimitControlThe system is under flow control.系统限流控制
400OutOfServiceThe ISV is out of service.业务已停机
400Insufficient.BalanceYou have an insufficient balance.余额不足
403Permission.NotAuthorizedYou are not authorized to perform the operation.您没有权限执行此操作
500InternalErrorA system error occurred.系统异常

访问错误中心查看更多错误码。

阿里云首页 号码百科 相关技术圈