Number Check API query - nxtele/http-api-document GitHub Wiki

概要

• 号码检测结果批量查询接口[分页查询]
• 频率限制 每3秒一次请求

请求URL

http://api2.nxcloud.com/api/number/query

请求方式

• Method: POST
• Content-Type: application/json

鉴权机制

鉴权规则请参考地址：API接口调用约定

请求Header

参数名称	参数类型	是否必填	示例值	参数描述
accessKey	String	是	fme2na3kdi3ki	用户身份标识
ts	String	是	1655710885431	当前请求的时间戳（单位是毫秒），牛信服务端允许用户端请求最大时间误差为60秒
bizType	String	是	1	[业务类型] 固定值 用来标识号码检测
action	String	是	numbercheck	固定值 用来标识号码检测
sign	String	是	6e9506557d1f289501d333ee2c365826	API入参参数签名，签名算法

请求Body

参数名	必选	类型	说明
page	是	integer	当前页号
pageSize	是	integer	当前页数 ，每页最多100条
date	是	string	日期 yyyy-MM-dd ，最多查询14天内的检测记录
requestId	否	string	查询检测结果的requestId，业务id, 客户回执中推送 [精确查找]
batchNo	否	string	批次号，批次号batchNo和requestId不能同时为空 [批量查找]
phone	否	string	手机号

批次号batchNo和requestId不能同时为空

请求示例

{
    "requestId": "fa019f186b4c4419ba3b264dd5f1b3b2",
    "date": "2023-09-14",
    "pageSize": 10,
    "page": 1
}

返回参数说明

参数名	类型	说明
data	object	请求结果 说明如下
msg	string	请求结果说明
code	integer	结果编码

data

参数名	类型	说明
page	integer	当前页号
pageSize	integer	当前页数
totalPage	integer	总页数
totalSize	integer	总条数
result	array[object]	检测结果 说明如下

result

参数名	类型	说明
country	string	区号 iso
numberType	string	号码类型。mobile:移动号码 , others：其他号码,invalid：无效号码
operator	string	运营商
requestId	string	requestId
batchNo	string	批次号
checkLevel	Integer	检测类型
country	string	区号 iso
price	number	费用。精确到四位小数
currency	string	币种

HRL检测额外字段返回

参数名	类型	说明
mcc	string	mcc
mnc	string	mnc
ported	string	是否携号转网 "YES": 是; "NO": 否; "UNKNOWN": 未知
active	string	是否活跃 "YES": 是; "NO": 否; "UNKNOWN": 未知

成功返回1

{
    "code": 0,
    "message": "Success",
    "data": {
        "result": [
            {
                "country": "IN",
                "batchNo": "101601624663",
                "numberType": "mobile",
                "mnc": "98",
                "active": "YES",
                "mcc": "404",
                "operator": "Bharti Airtel - Gujarat (98)",
                "ported": "NO",
                "checkLevel": 5,
                "phone": "886968****",
                "requestId": "fa019f186b4c4419ba3b264dd5f1b3b2",
                "price": 0.2740,
                "currency": "USD"
            }
        ],
        "totalSize": 1,
        "totalPage": 1,
        "pageSize": 10,
        "page": 1
    }
}

成功返回2

{
    "code": 0,
    "message": "Success",
    "data": {
        "result": [],
        "totalSize": 0,
        "totalPage": 0,
        "pageSize": 10,
        "page": 1
    }
}

失败返回

{
    "code": 9000,
    "message": "date format incorrect [yyyy-MM-dd]"
}

错误代码

code	msg
0	Success
-1	Failure
9000	date format incorrect [yyyy-MM-dd]
211	Request frequency limited to once every 3 seconds