| 日期 | 版本 | 修订内容摘要 |
|---|
| 2023-08-18 | v2.0.0 | 更新接口文档 |
一、号码实时基础版
1.1 协议说明
1.2 请求参数
请求参数 Body 以 multipart/form-data 方式提交
1.3 响应参数说明
响应 body 数据为 JSON 格式
| 字段名 | 类型 | 说明 |
|---|
| chargeStatus | Int | 是否收费：1 收费，0 不收费 |
| code | String | 响应 code 码。200000：成功，其他失败。见附录响应 code 码 |
| message | String | 响应 code 码解释 |
| data | Object | 返回对象 |
| orderNo | String | 业务唯一流水号。例：628291418130630 |
| handleTime | String | 查询时间 例：2018-04-09 15:05:01 |
| mobile | String | 手机号 |
| area | String | 归属地 例：北京-北京 |
| numberType | String | 携号转网后的运营商类型 1 移动 2 联通 3 电信 4 广电 |
| status | String | 号码状态，1 正常 2 空号 3 通话中(此状态失效,不返回) 4 不在网(空号) 5 关机 7 在网但不可用 13 停机 10 未知 9 服务器异常 12 不存在的号码 |
| mnpStatus | String | 是否携号转网 1-是 0-否 |
| remark | String | 备注 ，例：中国联通 GSM/3G-正常 |
1.4 响应返回实体 DEMO
{
"chargeStatus":1
"message":"成功"
"data":{
"orderNo":"628291418130630"
"handleTime":"2022-12-08 15:59:18"
"mobile":"13952597111"
"area":"江苏-扬州"
"numberType":"1"
"status":"1"
"mnpStatus":"0"
"remark":"中国移动-OK"
},
"code":"200000"
}
1.5 失败返回实体
{
"chargeStatus":0
"message":"手机号码格式错误"
"code":"500003"
}
1.6 接口调用演示示例
二、号码在网状态（支持 md5/sha256 加密）
2.1 协议说明
2.2 请求参数
请求参数 Body 以 multipart/form-data 方式提交
2.3 请求参数示例
appId:qsAJMBan
appKey:2tCLxxxx
mobile:13767641540
appId:qsAJMBan
appKey:2tCLxxxx
mobile:4b8b9e9b62ceaefade93654a315b7644
encrypt:md5
encryptFields:mobile
2.4 响应内容
响应 body 数据为 JSON 格式
| 字段名 | 类型 | 说明 |
|---|
| chargeStatus | Integer | 是否收费，1 ：收费 0：不收费 |
| message | String | 响应 code 码解释 |
| data | Object | 返回对象 |
| result | Object | 返回结果 |
| provider | Integer | 返回号码当前归属的运营商，正数为非携号转网，负数为携号转网，具体如下： 非携号转网：1 移动、2 电信、3 联通、4 广电； 携号转网：-1 移动、-2 电信、-3 联通、-4 广电。 |
| status | Integer | 1-->正常 2--> 停机 3--> 在网但不可用 4-->销号/空号 |
| msg | String | 结果状态描写 |
| code | Integer | 返回状态码 |
| fee | Integer | 是否收费 0 不收费 1 收费 |
| code | String | 响应 code 码。200000：成功，其他失败。见附录响应 code 码 |
备注（内层code：503“查无”；外层code：500000“号段不支持或服务异常”）
2.5 成功返回结果（示例）
{
"chargeStatus":1,
"message":"成功",
"data":{
"result":{
"provider":1,
"status":1
},
"msg":"请求成功",
"code":"0",
"fee":1
},
"code":"200000"
}
2.6 失败返回结果（示例）
{
"chargeStatus": 0,
"message": "手机号码格式错误",
"code": "500003"
}
2.7 接口调用演示示例
md5加密后字段填写示例
三、号码实时查询（已下架，新接入请看右侧号码实时基础版）
3.1 协议说明
3.2 请求参数
请求参数 Body 以 multipart/form-data 方式提交
3.3 响应参数说明
响应 body 数据为 JSON 格式
| 字段名 | 类型 | 说明 |
|---|
| chargeStatus | Int | 是否收费，枚举值：1 ：收费 0：不收费 |
| code | String | 响应 code 码。200000：成功，其他失败。见附录响应 code 码 |
| message | String | 响应 code 码解释 |
| data | Object | |
| orderNo | String | 业务唯一流水号。例：1670485769100 |
| handleTime | String | 查询时间 例：2018-04-09 15:05:01 |
| mobile | String | 手机号码 |
| area | String | 归属地 例：北京-北京 |
| numberType | String | 携号转网后的运营商类型 1 移动 2 联通 3 电信 4 广电 |
| status | String | 号码状态 numberType 为’1’或‘4’时: 参见： 1.1 号码状态含义对应表（一）numberType 为’2’时: 参见：1.2 号码状态含义对应表（二）numberType 为’3’时: 参见：1.3 号码状态含义对应表（三） |
| mnpStatus | String | 是否携号转网 1-是 0-否 |
| remark | String | 备注 ，例：中国联通 GSM/3G-正常 |
3.4 响应返回实体 DEMO
{
"chargeStatus":1
"message":"成功"
"data":{
"orderNo":"1670485769100"
"handleTime":"2022-12-08 15:49:29"
"mobile":"13952597111"
"area":"江苏-扬州"
"numberType":"1"
"status":"1"
"mnpStatus":"0"
"remark":"中国移动-OK"
},
"code":"200000"
}
3.5 失败返回实体
{
"chargeStatus":0
"message":"手机号码格式错误"
"code":"500003"
}
3.6 接口调用演示示例
1.1 号码状态含义对应表（一）
| 号码状态 | 结果说明 |
|---|
| 1 | (正常) |
| 2 | (停机) |
| 3 | (在网但不可用) |
| 4 | (不在网) |
| 5 | (无短信能力) |
| 6 | (欠费) |
| 7 | (长时间关机) |
| 8 | (销号/未启用) |
| 9 | (服务器异常) |
| 10 | (查询失败) |
1.2 号码状态含义对应表（二）
| 号码状态 | 结果说明 |
|---|
| 1 | (未启用) |
| 2 | (欠费停机） |
| 3 | (正常) |
| 4 | (其它停机) |
| 5 | (已销号) |
| 9 | (服务器异常) |
| 10 | (查询失败) |
| 7 | (关机） |
1.3 号码状态含义对应表（三）
| 号码状态 | 结果说明 |
|---|
| 0 | (在网状态停机) |
| 1 | (在网状态正常) |
| 2 | (在网但不可用) |
| 3 | (销号/未启用) |
| 4 | (无法查询) |
| 9 | (服务器异常) |
| 10 | (查询失败) |
| 7 | (关机） |
附录：响应 code 码
| code 码 | 说明 |
|---|
| 200000 | 请求成功 |
| 400001 | 参数校验异常 |
| 403000 | 用户校验失败 |
| 415000 | 请求数据转换异常 |
| 500000 | 系统异常 |
| 500002 | 数据处理异常 |
| 500003 | 业务操作失败 |
| 500004 | 远程调用失败 |
| 500005 | 账户余额异常 |
| 500006 | 请求外部系统失败 |
| 504000 | 系统超时 |
| 500007 | 请求 IP 不合法 |
| 500008 | 请求速率超限 |
| 500013 | 当前产品未开通 |
| 400101 | 在下游系统中的商户信息不存在 |
| 403101 | 账户被下游系统禁用 |
| 403102 | 账户在下游系统中没有被激活 |
| 510101 | 在下游系统中的用户产品可用数量不足 |
| 400102 | 商户 IP 地址在下游系统中不合法 |
| 400200 | 黑名单列表 |
| 400201 | 手机号码不能为空 |
| 400203 | 最大上传图片为 3 张 |
| 400901 | 账户信息不存在 |
| 400902 | 应用类型信息不存在 |
| 500901 | 邮箱未设置 |
| 500902 | 账户信息已存在 |
| 500903 | 账户相关能力已激活 |
| 500904 | 日消耗统计文件已存在 |
| 500905 | 文件生成失败 |
| 500906 | 更新文件状态失败 |
| 500907 | 删除文件失败 |
| 500908 | url 与文件只能选择一个进行上传 |
没有更多了
