查询手机用户在运营商侧的在网时长。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dytns:DescribePhoneNumberOnlineTime |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| AuthCode |
string |
是 |
授权码。 说明
在号码百科控制台我的申请页面,获取授权 ID 即授权码。 |
QASDW@#** |
| InputNumber |
string |
是 |
待查询的号码。
重要 加密字符串中字母不区分大小写。 |
1390000**** |
| Mask |
string |
是 |
号码的加密方式。取值:
|
NORMAL |
| Carrier |
string |
否 |
对外运营商。取值:
重要 非必填项,阿里云会根据号码归属的运营商类型做自动判断,该字段的取值对查询结果无任何影响。 |
UNICOM |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47 |
| Code |
string |
请求状态码。取值:
说明
当 Code 取值为 OK,且 VerifyResult 值不为-1 时计费,计费文档请参见号码百科定价。 |
OK |
| Message |
string |
号码状态码的描述。 |
OK |
| Data |
object |
结构体。 |
|
| VerifyResult |
string |
在网时长枚举值。枚举值如下:
|
1 |
| CarrierCode |
string |
运营商短信状态码。取值:
|
CMCC |
状态码原因及解决方案
| HttpCode | 状态码 | 原因 | 解决方案 |
| 200 | OK:成功。 | 请求参数符合要求。 | 表示接口调用成功。 |
| 200 | PortabilityNumberNotSupported:不支持的号码查询。 | 有少部分携号转网号码会返回此错误码。 | 建议更换其他号码查询。携号转网的号码在原运营商侧已销户,新运营商侧认为携入的时间为开户时间,因此携号转网的号码无法准确的查询到该号码的真实情况。 |
异常原因及解决方案
| HttpCode | 状态码 | 原因 | 解决方案 |
| 400 | AuthCodeNotExist:授权码不存在。 | 授权码不存在。 | 请先在号码分析服务申请您所需的标签,申请成功并获得授权码后,再发起 DescribePhoneNumberOnlineTime 接口调用。 |
| 400 | CarrierIllegal:运营商类型非法。 | 运营商类型非法。 | 请您填入正确的运营商类型,对于加密的号码,该字段必填且必须为大写字符。 |
| 400 | MobileNumberIllegal:请求参数的手机号格式有误。 | 手机号格式填写有误。 | 若手机号未加密,填入 11 位正确的数字号码即可;若手机号经 MD5 加密处理,该字段为 32 位加密字符串;若手机号经 SHA256 加密处理,该字段为 64 位加密字符串。 |
| 400 | MobileNumberTypeNotMatch:手机号格式与加密类型不匹配。 | 填入的手机号与加密类型不匹配。 | 请您填入正确手机号格式和号码加密类型。 |
| 400 | MobileNumberTypeIllegal:加密方式类型错误。 | 不支持的加密方式或加密类型不规范。 | 加密方式仅支持 NORMAL、MD5、SHA256 三种,且必须为大写字符。 |
| 500 | Unknown:未知异常。 | 系统返回了未知异常。 | 请您尝试重新调用接口,建议重试的次数不要超过 3 次。 |
| 500 | SystemError:网元系统异常。 | 系统错误。 | 请尝试重新调用接口,建议重试次数不要超过 3 次。 |
示例
正常返回示例
JSON格式
{
"RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
"Code": "OK",
"Message": "OK",
"Data": {
"VerifyResult": "1",
"CarrierCode": "CMCC"
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 200 | PortabilityNumberNotSupported | Number portability is not supported | 不支持携号转网 |
| 400 | Insufficient.Balance | You have an insufficient balance. | 余额不足 |
| 400 | Product.Unsubscript | You have not subscribed to the specified product. | 未订阅该功能 |
| 400 | Ram.PermissionDeny | You are not authorized to perform the operation. | 权限不足 |
| 400 | System.LimitControl | The system is under flow control. | 系统限流控制 |
| 400 | Unknown.ResourceOwnerId | The resource does not belong to the current user. | 资源不属于当前用户 |
| 400 | AuthCodeNotExist | Authorization code does not exist | |
| 400 | CarrierIllegal | Illegal carrier type | 运营商类型非法 |
| 400 | MobileNumberIllegal | Wrong format of phone number | 手机号码格式错误 |
| 400 | MobileNumberTypeNotMatch | Phone number and encryption type do not match | |
| 400 | MobileNumberTypeIllegal | Invalid number type. | 号码类型错误 |
| 400 | InvalidParameter | Invalid parameter. | 无效参数 |
| 400 | AuthCodeIllegal | Illegal authCode. | 鉴权时使用的authcode不可用于该接口 |
| 500 | SystemError | System error | 系统异常 |
| 500 | Unknown | Unknown error | 未知异常 |
| 500 | RequestTimeout | Request supplier timed out. | 请求供应商超时 |
| 500 | RequestSupplierError | Request supplier error. | 请求第三方服务异常。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。