日期 | 版本 | 修订内容摘要 |
---|
2023-08-18 | v2.0.0 | 更新接口文档 |
1.1 协议说明
1.2 请求参数
请求参数 Body 以 multipart/form-data 方式提交。
字段名称 | 类型 | 是否必填 | 说明 |
---|
appId | String | 是 | 请在 https://chuanglan.com/ 登录后获取 |
appKey | String | 是 | 请在 https://chuanglan.com/ 登录后获取 |
mobile | String | 是 | 检测手机号,限单个,仅支持11位国内号码预验证11 位手机号码,和加密数据字段二选一 |
ip | String | 否 | 手机IP地址:重要参数;不传或将对检测结果产生影响,不能传入10,192,172等开头的内网IP地址 |
type | String | 否 | 查询类型 1:MD5(32位小写),0:普通手机号;默认0 |
1.3 响应内容
响应 body 数据为 JSON 格式。
字段名 | 类型 | 说明 |
---|
code | String | 响应 code 码。200000:成功,其他失败。见附录响应 code 码 |
message | String | 响应 code 码解释 |
chargeStatus | String | 是否收费,枚举值:1 :收费 0:不收费 |
data | Object | |
mobile | String | 手机号,仅支持国内号码,11 位 |
tradeNo | String | 交易号,唯一。样例:18041109215057630 |
status | String | 检测结果,枚举值:W1:白名单 B1 :黑名单 B2 :可信用度低 N:库无 |
1.4 查询响应示例
成功示例
{
"chargeStatus": "1",
"message": "成功",
"data": {
"tradeNo": "18041216552768336",
"mobile": "18236****10",
"status": "W1"
},
"code": "200000"
}
失败示例:
{
"code": "500000",
"success": false,
"message": "系统异常",
"chargeStatus": 0
}
没有更多了