调用DescribePhoneNumberStatus接口获取号码实时在网状态,例如正常、停机、空号状态,支持一次请求查询一个号码实时在网状态。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PhoneNumber | string | 是 | 要查询的手机号码。 | 1511234**** |
返回参数
状态码原因及解决方案
状态码 | 原因 | 解决方案 |
---|---|---|
OK:成功。 | 请求参数符合要求。 | 表示接口调用成功。 |
异常原因及解决方案
状态码 | 原因 | 解决方案 |
---|---|---|
InvalidParameter:传入的手机号错误或参数格式错误。 | 请求参数的手机号格式错误或请求参数不符合API接口的要求。 | 输入正确的手机号或调整请求参数的格式,再重新提交请求。如:删除手机号中的不可见字符、空格、调整为半角字符等。若手机号格式正确仍出现该错误码,请通过工单联系工程师处理。 |
OperatorLimit:运营商禁止查询的手机号。 | 该号码运营商侧禁止查询或查询不出结果。 | 请重试或使用其它号码查询。建议重复查询的次数不要超过3次。 |
isp.UNKNOWN:未知异常。 | 系统返回了未知异常。 | 请尝试重新调用接口,建议重试的次数不要超过3次。如仍存在此异常,请通过工单反馈至工程师处理。 |
API修订记录
本次修订时间为2022-02-10、修订类别为Code枚举值修订、修订内容如下所示:
原有错误码isv.INVALID_PARAMETERS、isv.MOBILE_NUMBER_ILLEGAL,修改为InvalidParameter错误码。
原有错误码isp.OPERATOR_LIMIT,修改为OperatorLimit错误码。
删除isp.SYSTEM_ERROR错误码,改为InternalError异常。
删除isp.QPS_LIMIT错误码,改为System.LimitControl异常。
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47",
"PhoneStatus": {
"Status": "NORMAL",
"SerialId": "1100000000000",
"Carrier": "CMCC"
}
}
错误码
Http code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
200 | InvalidParameter | The specified parameter is invalid. | 非法参数 |
200 | InvalidParameter | The specified mobile phone number is invalid. | 非法号码 |
200 | OperatorLimit | The number is limited by the operator. | 该号码受运营商限制 |
400 | Ram.CheckFailed | You did not pass the ARM permission check. | RAM权限校验失败 |
400 | Ram.PermissionDeny | You are not authorized to perform the operation. | 权限不足 |
400 | Unknown.ResourceOwnerId | The resource does not belong to the current user. | 资源不属于当前用户 |
400 | Product.Unsubscript | You have not subscribed to the specified product. | 未订阅该功能 |
400 | Product.NotOrdered | You have not ordered this product (offer). | 未订购该产品 |
400 | System.LimitControl | The system is under flow control. | 系统限流控制 |
400 | OutOfService | The ISV is out of service. | 业务已停机 |
400 | Insufficient.Balance | You have an insufficient balance. | 余额不足 |
403 | Permission.NotAuthorized | You are not authorized to perform the operation. | 您没有权限执行此操作 |
500 | InternalError | A system error occurred. | 系统异常 |
访问错误中心查看更多错误码。