功能说明
该系列接口用于批量的异步检测手机号的状态,使用前需要与客户经理确认AppId及Authorization
接口说明
接口的基础URL为https://api.xiaolanben.com/blue-service/api/v1/open/mobileCheck
在调用接口时需要传入两个header,分别是AppId及Authorization
所有请求默认响应均为JSON数据信息体;默认的编码均为UTF-8
所有接口调用如果成功,则响应http code为200~299;其它http均是错误码
CURL示例
curl -X GET --header 'AppId: xlbTest' --header 'Authorization: testToken' 'https://api.xiaolanben.com/blue-service/api/v1/open/mobileCheck/query?fileId=1023'
上传待检测手机号文件
POST /upload
Content-Type: multipart/form-data
上传指定的文本文件,文件参数名file,每个手机号一行,每次文件至少需要5000个手机号,最多200000个手机号
注意:同一个文件名的文件,1小时内不允许重复上传。如果上传过程中失败,可以通过【查询最近1小时内上传的文件的ID】接口查询一次fileId
响应体
字段 | 类型 | 描述 |
fileId | LONG | 文件的ID |
count | INT | 文件中符合手机号格式的记录数 |
查询最近1小时内上传的文件的ID
GET /fileId
字段 | 类型 | 数据域 | 备注 |
fileName | STRING | query | 上传文件时的文件名,需要通过URLEncode |
响应体
如果查询上传超过1小时的文件时,系统会返回httpCode 404; 如果系统正在处理中还没有生成fileId的,则系统返回httpCode为423
字段 | 类型 | 描述 |
fileId | LONG | 对应的文件的ID |
查询指定的文件是否检测完成
系统一般在1小时内才能处理好一个文件,最快的也需要15分钟以上。因此该状态查询建议间隔在5分钟一次
GET /query
字段 | 类型 | 数据域 | 备注 |
fileId | LONG | query | 文件的ID |
响应体
字段 | 类型 | 描述 |
status | INT | 处理状态描述 仅是3状态时才支持下载 |
desc | STRING | 状态描述 |
下载指定的文件
GET /download
该接口用于下载指定检测结果txt文件,响应每一行为 手机号\t状态;文件最后会多一空行
状态值对应 2 活跃号 3 空号 4沉默号 5风险号 其它为未知
字段 | 类型 | 数据域 | 备注 |
fileId | LONG | query | 文件的ID |