文档

PhoneNumberStatusForVoice - 号码状态查询(语音业务场景)

更新时间:

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

接口说明

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

QPS 限制

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dytns:PhoneNumberStatusForVoiceWrite
  • 全部资源
    acs:dytns:*:{#accountId}:*

请求参数

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

授权码。

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

待查询的号码。

  • 若 Mask 取值为 NORMAL,该字段为 11 位手机号码。
  • 若 Mask 取值为 MD5,该字段为 32 位加密字符串。
  • 若 Mask 取值为 SHA256,该字段为 64 位加密字符串。

注意 加密字符串中字母不区分大小写。

139****1234
Maskstring

加密方式。取值:

  • NORMAL:不加密

  • MD5

  • SHA256

NORMAL

返回参数

名称类型描述示例值
object

结构体

Codestring

请求状态码。取值:

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

返回状态码描述。

OK
RequestIdstring

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

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

结构体。

Statusstring

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

  • NORMAL:正常。
  • SHUTDOWN:停机。
  • POWER_OFF:关机。
  • NOT_EXIST:空号。
  • SUSPECTED_POWER_OFF :疑似关机。
  • DEFECT:异常号码。
  • UNKNOWN:未知。
说明 因运营商系统调整,中国电信的号码不支持返回:忙、疑似关机、关机状态。 详见官网公告
NORMAL
Carrierstring

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

  • CMCC:中国移动
  • CUCC:中国联通
  • CTCC:中国电信
说明 暂不支持中国广电的号码查询。
CTCC

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": "OK",
  "RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
  "Data": {
    "Status": "NORMAL",
    "Carrier": "CTCC"
  }
}

错误码

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.号码与号码类型不匹配
400EncryptTypeIllegalInvalid encryption type.加密类型错误
400isp.UNKNOWNAn error occurred due to unknown reasons.系统返回了未知异常。
500SystemErrorSystem error系统异常
500UnknownUnknown error未知异常

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

变更历史

变更时间变更内容概要操作
2023-05-29OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:200
    删除错误码:400
    删除错误码:500
2023-05-17OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:200
    删除错误码:400
    删除错误码:500
入参OpenAPI 入参发生变更
    删除入参:ExtendFunction
2023-04-28OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:200
    删除错误码:400
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:ExtendFunction
2023-03-02OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:200
    删除错误码:400
    删除错误码:500
2022-09-28OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 500 变更
    删除错误码:200
  • 本页导读 (1)