| 日期 | 版本 | 修订内容摘要 |
|---|
| 2023-11-07 | v2.0.0 | 更新接口文档 |
1、号码状态检测
1.1 协议说明
1.2 请求参数
请求参数 Body 以 multipart/form-data 方式提交
| 参数名 | 是否必须 | 说明 |
|---|
| appId | 是 | 请在https://www.chuanglan.com/ 登录后获取 |
| appKey | 是 | 请在https://www.chuanglan.com/ 登录后获取 |
| mobiles | 是 | 检测手机号，多个手机号码用英文半角逗号隔开,最多 50 个 |
| type | 否 | 查询类型 1：MD5(32 位小写)，0：普通手机号；默认 0 |
| sceneType | 否 | 1：高精度 ，0：高覆盖，默认 1。 高覆盖：覆盖数据 17 亿，准确度 92%，号码支持的数量多； 高精度：覆盖数据 13 亿，准确度 95%，号码支持的数量少。 |
| statusType | 否 | 默认 0 |
1.3 响应内容
响应 body 数据为 JSON 格式。
| 字段名 | 类型 | 说明 |
|---|
| chargeStatus | int | 1:收费；0：不收费 |
| chargeCount | int | 计费条数 |
| code | String | 响应 code 码。200000：成功，其他失败。 |
| message | String | 响应 code 码解释 |
| data | Object | |
| mobile | String | 手机号 |
| lastTime | String | 订单号 |
| area | String | 手机号所属区域。样例：省-市 |
| numberType | String | 手机号运营商类型。样例：中国移动/联电/电信/虚拟运营商 |
| status | int | 检测结果 0：空号 1：实号 3：库无 4：沉默号 |
1.4 请求成功
{
"chargeStatus": 1,
"chargeCount": 2,
"message": "成功",
"data": [{
"mobile": "12999389292",
"lastTime": "1668319189121",
"area": "河北-石家庄",
"numberType": "中国联通",
"chargesStatus": "1",
"status": "1"
},
{
"mobile": "19877277222",
"lastTime": "1668616648148",
"area": "湖北-武汉",
"numberType": "中国联通",
"chargesStatus": "1",
"status": "1"
}
],
"code": "200000"
}
1.5 失败返回实体
{
"chargeStatus": 0,
"message": "手机号码格式错误或无效的手机号码md5值",
"code": "500000"
}
2、手机归属地查询
已下架，此接口不查携号转网后运营商。请看右侧第六个接口
2.1 协议说明
2.2 请求参数
2.3 响应内容
响应 body 数据为 JSON 格式。
| 字段名 | 类型 | 说明 |
|---|
| tradeNo | String | 交易号 |
| chargeStatus | int | 1:收费；0：不收费 |
| code | String | 响应 code 码。200000：成功，其他失败。 |
| message | String | 响应 code 码解释 |
| data | Object | |
| orderNo | String | 业务唯一流水号。例：628291418130630 |
| handleTime | String | 查询时间 例：2018-04-09 15:05:01 |
| province | String | 省份 |
| city | String | 城市 |
| provinceCode | String | 省份编码 |
| cityCode | String | 市区编码 |
| isp | String | 运营商 |
| mobile | String | 手机号 |
| postCode | String | 邮编 |
2.4 请求成功示例
{
"tradeNo": "1050409476651356160",
"chargeStatus": 1,
"message": "成功",
"data": {
"orderNo": "15533675739001",
"handleTime": "2022-12-08 13:52:14",
"province": "河北",
"city": "石家庄",
"provinceCode": "0311",
"cityCode": "130100",
"isp": "联通",
"mobile": "15533675739",
"postCode": "050000"
},
"code": "200000"
}
2.5 失败返回实体
{
"message": "参数[orderNo]不能为空",
"code": "400001"
}
3、二次号
3.1 协议说明
3.2 请求参数
请求参数 Body 以 multipart/form-data 方式提交
3.3 响应内容
响应 body 数据为 JSON 格式。
| 字段名 | 类型 | 说明 |
|---|
| chargeStatus | int | 1:收费；0：不收费 |
| code | String | 响应 code 码。200000：成功，其他失败。 |
| message | String | 响应 code 码解释 |
| data | Object | |
| orderNo | String | 透传订单返回 |
| hanleTime | String | 时间示例 "2022-12-10 00:00:00" |
| mobile | String | 手机号 |
| area | String | 归属地 例：北京-北京（加密查询时不返回） |
| numberType | String | 运营商类型 样例：中国移动 |
| status | String | 1 是二次号 2 不是二次号 3 已销号 9 服务器异常 10 查询失败 |
| Remark | String | 结果备注 |
3.4 返回成功示例（非加密返回）
{
chargeStatus: 1,
message: "成功",
data: {
orderNo: "透传数据（请求参数orderNo字段）",
handleTime: "2022-12-10 16:44:24",
mobile: "15912341234",
area: "湖北-武汉",
numberType: "1",
status: "2",
remark: "中国移动-OK"
},
code: "200000"
}
3.5 返回成功示例（加密返回）
{
chargeStatus: 1,
message: "成功",
data: {
orderNo: "透传数据（请求参数orderNo字段）",
handleTime: "2022-12-10 16:53:41",
mobile: "0a06a6d30219fcccbd570e9946d85ca4",
numberType: "1",
status: "2",
remark: "1-OK"
},
code: "200000"
}
3.6 返回失败示例
{
code: "500000",
success: false,
message: "系统异常",
chargeStatus: 0
}
4、话费定制接口
4.1 协议说明
4.2 请求参数
4.3 响应内容
| 字段名 | 类型 | 说明 |
|---|
| chargeStatus | int | 1:收费；0：不收费 |
| chargeCount | int | 计费条数 |
| code | String | 响应 code 码。200000：成功，其他失败。 |
| message | String | 响应 code 码解释 |
| data | Object | |
| orderNo | String | 业务唯一流水号。例：628291418130630 |
| handleTime | String | 查询时间 例：2018-04-09 15:05:01 |
| mnpStatus | String | 是否为携号转网，1-是 0-否 |
| area | String | 归属地 例：北京-北京 |
| numberType | String | 运营商类型 1 移动 2 联通 3 电信 |
| status | String | 号码状态，1-实号 0-非实号 当号码状态为 0，且 isUseReal 为 1 时，号码状态为号码实时基础版接口的状态 |
| remark | String | 备注 ，例：OK |
| mobile | String | 手机号 |
| postCode | String | 邮编 |
4.4 请求示例
{
"chargeStatus": 1,
"chargeCount": 1,
"message": "成功",
"code": "200000",
"data": {
"mobile": "15533675739",
"area": "河北-石家庄",
"numberType": "中国联通",
"status": "1",
"orderNo": "15533675739001",
"handleTime": "2022-12-08 14:46:35",
"remark": "OK",
"mnpStatus": "0"
}
}
4.5 失败返回实体
{
"message": "校验异常：流水号不能为空",
"code": "400001"
}
5、号码状态检测 2000 型
5.1 协议说明
5.2 请求参数
请求参数 Body 以 multipart/form-data 方式提交
5.3 响应内容
响应 body 数据为 JSON 格式。
| 字段名 | 类型 | 说明 |
|---|
| chargeStatus | int | 1:收费；0：不收费 |
| chargeCount | String | 计费条数 |
| code | String | 响应 code 码。200000：成功，其他失败。 |
| message | String | 响应 code 码解释 |
| data | Object | |
| mobile | String | 手机号 |
| lastTime | String | 订单号 |
| area | String | 手机号所属区域。样例：省-市 |
| numberType | String | 手机号运营商类型。样例：中国移动 GSM |
| status | int | 检测结果 0：空号 1：实号 3：库无 4：沉默号 |
5.4 返回成功示例
{
"chargeStatus": 1,
"chargeCount": 2,
"message": "成功",
"data": [{
"mobile": "12999389292",
"lastTime": "1669029980902",
"area": "河北-石家庄",
"numberType": "中国联通",
"chargesStatus": "1",
"status": "1"
},
{
"mobile": "19877277222",
"lastTime": "1669029980902",
"area": "湖北-武汉",
"numberType": "中国联通",
"chargesStatus": "1",
"status": "1"
}
],
"code": "200000"
}
5.5 返回失败示例
{
code: "500000",
success: false,
message: "系统异常",
chargeStatus: 0
}
6、手机号码归属地（升级版）
6.1 协议说明
6.2 请求参数
请求参数 Body 以 multipart/form-data 方式提交
6.3 响应内容
响应 body 数据为 JSON 格式。
| 字段名 | 类型 | 说明 |
|---|
| tradeNo | String | 交易号 |
| chargeStatus | int | 1:收费；0：不收费 |
| code | String | 响应 code 码。200000：成功，其他失败。 |
| message | String | 响应 code 码解释 |
| data | Object | |
| orderNo | String | 业务唯一流水号。例：628291418130630 |
| handleTime | String | 查询时间 例：2018-04-09 15:05:01 |
| province | String | 省份 |
| city | String | 城市 |
| provinceCode | String | 省份编码 |
| cityCode | String | 市区编码 |
| mobile | String | 手机号 |
| postCode | String | 邮编 |
| originalIsp | String | 原来运营商 |
| latestIsp | String | 现在运营商 |
6.4 请求成功示例
{
"tradeNo": "1185251037020160000",
"chargeStatus": 1,
"message": "成功",
"data": {
"originalIsp": "移动",
"orderNo": "123",
"handleTime": "2023-12-15 16:04:28",
"city": "扬州",
"provinceCode": "0514",
"cityCode": "321000",
"mobile": "13952597117",
"province": "江苏",
"latestIsp": "移动",
"postCode": "225000"
},
"code": "200000"
}
6.5 失败返回实体
{
"message": "参数[orderNo]不能为空",
"code": "400001"
}
7、号码状态融合版（外呼场景）
7.1 协议说明
7.2 请求参数
请求参数 Body 以 multipart/form-data 方式提交
| 参数名 | 类型 | 是否必须 | 说明 |
|---|
| appId | String | 是 | 请在https://www.chuanglan.com/ 登录后获取 |
| appKey | String | 是 | 请在https://www.chuanglan.com/ 登录后获取 |
| mobile | String | 是 | 用户手机号 |
| strategy | String | 是 | 策略 id 1：仅号码状态检测; 2：先号码状态检测，未命中则实时检测; 3：仅实时检测 |
| factor | String | 否 | 离线号码精度敏感系数（策略 id 为 1 或 2 的时候必填） 1000：90 精度，覆盖 15 亿，比较适合在策略 1 中使用，用于 AI 外呼场景; 1001：95 精度，覆盖 12 亿，比较适合在策略 2 中使用，用于坐席外呼场景; 1002：98 精度，覆盖 8 亿，比较适合在策略 2 中使用，用于坐席外呼场景; 1003：暂未开发 |
| type | String | 否 | 查询类型 1：MD5(32 位小写)，0：普通手机号；默认 0 |
7.3 响应内容
响应 body 数据为 JSON 格式。
| 字段名 | 类型 | 说明 |
|---|
| code | String | 响应 code 码。200000：成功，其他失败。 |
| message | String | 响应 code 码解释 |
| data | Array | 返回对象（数组） |
| mobile | String | 业务唯一流水号。例：628291418130630 |
| area | String | 归属地域 |
| numberType | String | 归属运营商，中国移动、中国联通、中国电信 |
| status | String | 状态 1:正常（离线判断）、2:空号（离线判断）、3:沉默号（离线判断，仅在策略 1）、4: 正常（实时检测）、5: 停机（实时检测）、6:关机（实时检测）、7:空号（实时检测）、8:未知（实时检测） |
7.4 请求成功示例
{
"code": "200000",
"message": "请求成功",
"data": {
"mobile": "13926252622",
"area": "广东-广州",
"numberType": "中国移动",
"status": "3"
}
}
7.5 失败返回实体
{
"message": "手机格式错误",
"code": "400001"
}
7.6 检测工具
使用说明
1.请确认确激活空号检测和号码实时查询，并且有响应余额。
2.在IP白名单中，绑定本机所在的公网IP(绑定后5分钟生效)。
3.appid和appkey在接口详情处获取。
4.输入的文件格式为csv或者txt格式，每行一个号码(仅需包含号码)。
5.单次检测的号码数量请控制在1万内。
6.每测试1次"测试连接”将后可能会消耗一次查询。
7.每次独立的检测，对应的文件名不要与历史检测的文件名重合。
操作步骤
1 输入appid和appkey，点击测试连接，待提示连接成功方可下一步。
2 输入待检测文件的地址，点击预览，待提示成功后方可下一步。
3 选择检测的模式等级，以及在涉及需要空号检测时，对空号检测的精度要求(1000,1001,1002)。
3.1 空号检测，仅会通过空号检测对号码进行核验。
3.2 融合版，先进行空号检测，若在空号检测中没有明确结果，将进行实时查询。
3.3 实时查询，仅通过实时查询对号码进行核验。
3.4 1000.1001,1002 分别代表空号检测90%6、95%和98%精度。
4 点击执行，并观察进度条(执行期间请勿关闭该窗口)。
5 若执行中断，重新打开软件，重复1到4步，将继续中断前的检测。
示例
附录：响应 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 与文件只能选择一个进行上传 |
没有更多了
