调用DescribePhoneNumberStatus接口获取号码实时在网状态,例如正常、停机、空号状态。

概述

DescribePhoneNumberStatus接口是号码状态查询接口,支持在一次请求中获取一个号码实时在网状态,例如正常、停机、空号状态。 调用该接口获取号码状态时,请注意: 该请求会根据查询次数计费,价格请参考计费说明。在使用接口前,请参见公共参数调用方式等公共信息。

使用说明

本接口用于获取号码实时在网状态信息。

QPS限制

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

授权信息

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribePhoneNumberStatus

系统规定参数。取值:DescribePhoneNumberStatus

PhoneNumber String 1511234****

要查询的手机号码。

返回数据

名称 类型 示例值 描述
Code String OK

请求状态码。取值:

  • OK:成功。
  • isv.INVALID_PARAMETERS:非法参数。
  • isv.MOBILE_NUMBER_ILLEGAL:手机号码格式错误。
  • isp.QPS_LIMIT:触发QPS限制。
  • isp.OPERATOR_LIMIT:运营商限制。
  • isp.UNKNOWN:未知异常。
  • isp.SYSTEM_ERROR:网元系统异常。
说明 请求状态码详情请参见下表:状态码原因及解决方案。
Message String OK

状态码的描述。

RequestId String CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47

请求ID。

PhoneStatus Object

号码状态。

Status String NORMAL

手机号码状态。取值:

  • NORMAL:正常。
  • SHUTDOWN:停机。
  • NOT_EXIST:空号。
SerialId String 1100000000000

请求流水号。

Carrier String CMCC

对外运营商。取值:

  • CMCC:中国移动。
  • CUCC:中国联通。
  • CTCC:中国电信。
  • UNKNOW:未知。

状态码原因及解决方案

状态码

原因

解决方案

OK:成功。

请求参数符合要求。

表示接口调用成功。

isv.INVALID_PARAMETERS:非法参数。

请求参数不符合API接口的要求。

调整请求参数的格式,再重新提交请求。例如:删除请求参数中的不可见字符、空格、调整为半角字符等。

isv.MOBILE_NUMBER_ILLEGAL:手机号码格式错误。

请求参数的手机号格式错误。

输入正确的手机号,再重新提交请求。如:删除手机号中的不可见字符、空格、调整为半角字符等。若手机号格式正确仍出现该错误码,请通过工单联系工程师处理。

isp.QPS_LIMIT:触发QPS限制。

当前查询频率已达系统上限。

请将查询频率限制在正常范围内,对于出现该错误码的号码适当进行重查,建议重复查询的次数不要超过3次。若的确有大并发的场景和需求,请创建工单联系工程师处理。

isp.OPERATOR_LIMIT:运营商限制。

该号码运营商侧禁止查询或查询不出结果。

请重试或使用其它号码查询。建议重复查询的次数不要超过3次。

isp.UNKNOWN:未知异常。

系统返回了未知异常。

请尝试重新调用接口,建议重试的次数不要超过3次。如仍存在此异常,请通过工单反馈至工程师处理。

isp.SYSTEM_ERROR:网元系统异常。

系统错误。

请尝试重新调用接口,建议重试的次数不要超过3次。如仍存在此异常,请通过工单反馈至工程师处理。

示例

请求示例

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"
  }
}

错误码

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 InvalidParameter The specified parameter is invalid. 非法参数
400 Product.NotOrdered You have not ordered this product (offer). 未订购该产品
400 InvalidParameter The specified mobile phone number is invalid. 非法号码
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. 余额不足
400 OperatorLimit The number is limited by the operator. 该号码受运营商限制
403 Permission.NotAuthorized You are not authorized to perform the operation. 您没有权限执行此操作

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