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

概要

号码检测提交接口

请求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: 基础版; 4: 呼叫版 ; 5:HLR版
drUrl	否	string	检测结果回调地址不填默认使用appkey对应的应用配置的回调地址，若应用也未配置回调地址，则不回调检测结果
appkey	是	string	应用appkey

请求示例

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

成功返回

{
    "msg": "success",
    "code": 0,
    "data": {
        "messageId": "301ef45b8de54d8aad95c5264c3756be",
        "batchNo":"20220901"
    }
}

返回参数说明

参数名	类型	说明
data	json	请求结果
messageId	string	业务id 唯一标识该条检测任务长度不超过64位
batchNo	string	批次号用户主动输入或者系统自动生成
msg	string	请求结果说明
code	integer	结果编码

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

失败返回

{
    "msg": "应用不可用或appkey错误",
    "code": 202,
    "data": {
        "messageId": "",
        "batchNo": ""
    }
}

错误代码

code	msg
0	成功
201	参数错误或为空
202	应用不可用或appkey错误
203	该号码未识别出国家运营商信息
204	客户扣费接口异常
205	未查询到应用报价
206	请求检测业务接口异常
207	检测类型不合法
210	鉴权机制对应的客户信息与appkey对应的客户信息不一致
211	客户余额不足
212	批次号长度不能超过64位
288	请求失败
299	系统错误

回调（Webhook）

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

号码检测回调