首页 号码百科 API参考 API目录 号码状态查询 PhoneNumberStatusForSms - 号码状态查询(短信业务场景)

PhoneNumberStatusForSms - 号码状态查询(短信业务场景)

获取手机号码实时在网状态,例如正常、停机、空号等状态。支持明文、MD5/SHA256加密方式的号码查询。

接口说明

  • 请确保在使用本接口前,您已充分了解号码百科产品定价
  • 默认仅阿里云账号使用本接口,RAM用户只有在被授予相关API操作权限后才可使用。相关操作,请参见为RAM用户授权
  • 使用本接口前,请登录号码百科控制台,在标签广场页面,找到对应的标签,单击申请开通,填写申请资料,审批通过后即可使用。

QPS限制

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

调试

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

调试

授权信息

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

请求参数

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

授权码。

说明号码百科控制台我的申请页面,获取授权ID即授权码。
zf08***pi6
InputNumberstring

待查询的号码。

  • 若Mask取值为NORMAL,该字段为11位手机号码。
  • 若Mask取值为MD5,该字段为32位加密字符串。
  • 若Mask取值为SHA256,该字段为64位加密字符串。
注意 加密字符串中字母不区分大小写。
181****1234
Maskstring

号码的加密方式。取值:

  • NORMAL:不加密

  • MD5

  • SHA256

NORMAL

返回参数

名称类型描述示例值
object

结构体

Codestring

请求状态码。取值:

  • OK:请求成功。
  • OperatorLimit:运营商禁止查询的手机号。
  • RequestFrequencyLimit:因运营商限制,禁止在短时间内高频对同一个号码进行反复查询,如返回此错误码,请您稍后再试。
OK
Messagestring

状态码的描述。

OK
RequestIdstring

公共参数,每个请求返回的ID都是唯一的,可用于排查和定位问题。

68A40250-50CD-034C-B728-0BD135850177
Dataobject

结构体

Statusstring

检测手机号返回状态。取值:

  • NORMAL:正常。
  • SHUTDOWN:停机。
  • POWER_OFF:关机。
  • NOT_EXIST:空号。
  • DEFECT:异常号码。
  • UNKNOWN:未知。
注意 中国电信的号码不支持返回状态:异常号码。
NORMAL
Carrierstring

号码当前归属的基础运营商。如果查询的号码存在携号转网,则返回携号转网后的基础运营商。取值:

  • CMCC:中国移动
  • CUCC:中国联通
  • CTCC:中国电信
  • CBN:中国广电
CMCC

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": "OK",
  "RequestId": "68A40250-50CD-034C-B728-0BD135850177",
  "Data": {
    "Status": "NORMAL",
    "Carrier": "CMCC"
  }
}

错误码

HTTP status code错误码错误信息描述
200OperatorLimitThe number is limited by the operator.该号码受运营商限制
400MobileNumberIllegalWrong format of phone number手机号码格式错误
400CarrierIllegalIllegal carrier type运营商类型非法
400AuthCodeNotExistThe label application form does not exist, please replace the authorization code.该标签申请单不存在,请重新更换授权码
400MobileNumberTypeIllegalInvalid number type.号码类型错误
400MobileNumberTypeNotMatchThe number and number type do not match.号码与号码类型不匹配
400isp.UNKNOWNAn error occurred due to unknown reasons.系统返回了未知异常。
500SystemErrorSystem error系统异常
500UnknownUnknown error未知异常
500EncyrptTypeIllegalThe encryption type of the mobile phone number is illegal手机号加密类型非法

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

变更历史

变更时间变更内容概要操作
2022-07-13新增 OpenAPI
阿里云首页 号码百科 相关技术圈