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

概要

号码检测提交接口

单次请求最多提交五千个号码[上限]

并发量建议控制在1秒10次请求[单批次2000以内]，1秒1次请求[单批次2000以上]。单日提交总量控制在400-500w。

请求URL

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

请求方式

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

参数名	必选	类型	说明
phone	是	string	请求检测的号码，需要带国码，例如: 852xxxxxxxxx,8527xxxxxxx [多个号码通过,分隔;并且同一批次中可检测不同国家的号码]
batchNo	否	string	批次号标识同一批检测中的不同号码如果没有则自动生成12位随机码，长度不可超过64位
checkLevel	否	integer	检测类型不填默认为基础版; 1: 基础版 ; 5:HLR版
drUrl	否	string	检测结果回调地址不填默认使用appkey对应的应用配置的回调地址，若应用也未配置回调地址，则不回调检测结果
appkey	是	string	应用appkey

请求示例

{
    "phone": "234800001xxxxx",
    "batchNo": "700265316182",
    "checkLevel": 1,
    "drUrl": "http://my.callback.url/test",
    "appkey": "a1b2c3d4"
}

成功返回不存在错误号码

{
    "code": 0,
    "message": "Success",
    "data": {
        "requestId": "309b8fb7ce694391a17aa35f5b512209",
        "batchNo": "101813108534",
        "failNumber": []
    },
    "traceId": "e8e81d8209164cde9ca509a5c3f241f1"
}

成功返回存在错误号码

{
    "code": 0,
    "message": "Success",
    "data": {
        "requestId": "dc99712066bd483b84b3641c787dab33",
        "batchNo": "100999527241",
        "failNumber": [
            {
                "number": "999***6789",
                "code": 209
            }
        ]
    },
    "traceId": "186c82b63eb449bb9d07866c042e88dd"
}

返回参数说明

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

data

参数名	类型	说明
requestId	string	业务id 唯一标识该条检测任务长度不超过64位
batchNo	string	批次号用户主动输入或者系统自动生成
failNumber	array	错误号码及其错误对应的code

failNumber

参数名	类型	说明
number	string	错误号码
code	integer	错误号码对应的错误原因code

requestId= uuid 或者 requestId= uuid-6位递增码请求返回的requestId和回执接口返回的requestId说明如果一个批次中只有一个号码则请求返回的requestId和回执接口返回的requestId相同如果一个批次中有多个号码则请求返回的requestId= uuid，回执接口返回的 requestId= uuid-6位递增码 [通过-拼接]

失败返回

{
    "code": 203,
    "message": "Appkey not available or incorrect"
}

错误代码

code	message
0	Success
201	Appkey missed
202	Phone missed
203	Appkey not available or incorrect
204	CheckLevel illegal
205	DrUrl length beyond the limit 255
206	BatchNo length beyond the limit 64
207	Phone count beyond the limit 5000
208	Customer app does not have quotation
209	Phone number is invalid
210	Phone number repeat
-1	Failure

回调（Webhook）

请求成功之后，NXCLOUD会排队进行检测，检测结果通过异步推送的方式推到回调地址，回调地址可以通过提交API指定，或者在平台统一配置。回调协议请参考:

号码检测回调