查询手机用户在运营商侧的在网时长。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dytns:DescribePhoneNumberOnlineTime | create |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AuthCode | string | 是 | 授权码。 说明
在号码百科控制台我的申请页面，获取授权 ID 即授权码。
| QASDW@#** |
| InputNumber | string | 是 | 待查询的号码。
注意 加密字符串中字母不区分大小写。 | 1390000**** |
| Mask | string | 是 | 号码的加密方式。取值：
| NORMAL |
| Carrier | string | 否 | 对外运营商。取值：
注意 非必填项，阿里云会根据号码归属的运营商类型做自动判断，该字段的取值对查询结果无任何影响。 | UNICOM |
返回参数
状态码原因及解决方案
| 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 | MobileNumberTypeIllegal | 号码类型错误 | 号码类型错误 |
| 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. | 请求第三方服务异常。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-09-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-09-11 | OpenAPI 错误码发生变更 | 查看变更详情 |
| 2023-05-17 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-04-28 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |