接口文档

2.号码状态同步检测接口

2.1 调用地址

地址http://address:port/void/api/check

请求方法:POST

同步请求接口将在同一个HTTP请求内完成检测并返回结果,每次提交最多10万个号码,大批量数据号码建议拆分成多次检测请求。

2.2 请求包头定义

Accept: application/json

Content-Type: application/json;charset=utf-8

2.3 请求参数

userName

String

帐号用户名

phoneList

[Array]

待检测手机号码,JSON数组格式。

最大数量不得超过10万个号码。

timestamp

Long

当前时间戳,精确到毫秒。

例如2020年8月1日12:00:00 时间戳为:1596254400000

sign

String

由以下参数值组合成字符串并计算MD5值,参考详细规则

计算:MD5(userName + timestamp + MD5(password))

heigtAccuracy

Integer

是否使用高精准模式。可选1:是、0:否。不填默认为0

2.4响应结果

参数名

类型

说明

code

Integer

处理结果,0为成功,其他失败,详细参考响应状态码

message

String

处理结果描述

data

[Array]

当code=0时,系统返回号码检测结果信息,数据格式如下:

[

  {

    "phone": "13000000001",

    "status": 0

  },

  {

    "phone": "13000000002",

    "status": 1

  }

]

phone: 检测的手机号码

status: 检测结果状态具体请参考检测结果状态码

 

2.5 请求示例

批量发送请求:

POST http://address:port/void/api/check

Accept: application/json

Content-Type: application/json;charset=utf-8

 

{

"userName""test",

"phoneList": ["13500000001""13500000002"],

"timestamp"1596254400000,

"sign""e315cf297826abdeb2092cc57f29f0bf"

}

发送响应结果:

{

"code"0,

"message""处理成功",

"data": [

{

"phone""13500000001",

"status"0

},

{

"phone""13500000002",

"status"1

}

]

}