文档

DescribePhoneNumberOnlineTime - 在网时长查询

更新时间:

查询手机用户在运营商侧的在网时长。

接口说明

  • 使用本接口前,请登录号码百科控制台,在标签广场页面,找到对应的标签,单击申请开通,填写申请资料,审批通过后即可使用。
  • 请确保在使用本接口前,您已充分了解号码百科产品定价

QPS 限制

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

调试

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

调试

授权信息

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

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

请求参数

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

授权码。

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

待查询的号码。

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

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

1390000****
Maskstring

号码的加密方式。取值:

  • NORMAL:不加密
  • MD5
  • SHA256
NORMAL
Carrierstring

对外运营商。取值:

  • MOBILE:中国移动。
  • UNICOM:中国联通。
  • TELECOM:中国电信。

注意 非必填项,阿里云会根据号码归属的运营商类型做自动判断,该字段的取值对查询结果无任何影响。

UNICOM

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

请求状态码。取值:

  • OK:请求成功。
  • PortabilityNumberNotSupported:不支持的携号转网号码。
  • RequestFrequencyLimit:因运营商限制,禁止在短时间内高频对同一个号码进行反复查询,如返回此错误码,请您稍后再试。
说明 当 Code 取值为 OK,且 VerifyResult 值不为-1 时计费,计费文档请参见号码百科定价
OK
Messagestring

号码状态码的描述。

OK
Dataobject

结构体。

VerifyResultstring

在网时长枚举值。枚举值如下:

  • -1:查无时长。
  • 0:手机状态异常,例如空号。
  • 1:[0-3)月。
  • 2:[3-6]月。
  • 3:(6-12]月。
  • 4:(12-24]月。
  • 5:(24,+)月
1
CarrierCodestring

运营商短信状态码。取值:

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

状态码原因及解决方案

HttpCode状态码原因解决方案
200OK:成功。请求参数符合要求。表示接口调用成功。
200PortabilityNumberNotSupported:不支持的号码查询。有少部分携号转网号码会返回此错误码。建议更换其他号码查询。携号转网的号码在原运营商侧已销户,新运营商侧认为携入的时间为开户时间,因此携号转网的号码无法准确的查询到该号码的真实情况。

异常原因及解决方案

HttpCode状态码原因解决方案
400AuthCodeNotExist:授权码不存在。授权码不存在。请先在号码分析服务申请您所需的标签,申请成功并获得授权码后,再发起 DescribePhoneNumberOnlineTime 接口调用。
400CarrierIllegal:运营商类型非法。运营商类型非法。请您填入正确的运营商类型,对于加密的号码,该字段必填且必须为大写字符。
400MobileNumberIllegal:请求参数的手机号格式有误。手机号格式填写有误。若手机号未加密,填入 11 位正确的数字号码即可;若手机号经 MD5 加密处理,该字段为 32 位加密字符串;若手机号经 SHA256 加密处理,该字段为 64 位加密字符串。
400MobileNumberTypeNotMatch:手机号格式与加密类型不匹配。填入的手机号与加密类型不匹配。请您填入正确手机号格式和号码加密类型。
400MobileNumberTypeIllegal:加密方式类型错误。不支持的加密方式或加密类型不规范。加密方式仅支持 NORMAL、MD5、SHA256 三种,且必须为大写字符。
500Unknown:未知异常。系统返回了未知异常。请您尝试重新调用接口,建议重试的次数不要超过 3 次。
500SystemError:网元系统异常。系统错误。请尝试重新调用接口,建议重试次数不要超过 3 次。

示例

正常返回示例

JSON格式

{
  "RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
  "Code": "OK",
  "Message": "OK",
  "Data": {
    "VerifyResult": "1",
    "CarrierCode": "CMCC"
  }
}

错误码

HTTP status code错误码错误信息描述
200PortabilityNumberNotSupportedNumber portability is not supported不支持携号转网
400Insufficient.BalanceYou have an insufficient balance.余额不足
400Product.UnsubscriptYou have not subscribed to the specified product.未订阅该功能
400Ram.PermissionDenyYou are not authorized to perform the operation.权限不足
400System.LimitControlThe system is under flow control.系统限流控制
400Unknown.ResourceOwnerIdThe resource does not belong to the current user.资源不属于当前用户
400AuthCodeNotExistAuthorization code does not exist-
400CarrierIllegalIllegal carrier type运营商类型非法
400MobileNumberIllegalWrong format of phone number手机号码格式错误
400MobileNumberTypeNotMatchPhone number and encryption type do not match-
400MobileNumberTypeIllegalInvalid number type.号码类型错误
400MobileNumberTypeIllegal号码类型错误号码类型错误
500SystemErrorSystem error系统异常
500UnknownUnknown error未知异常

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

变更历史

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