您的位置: 主页 > 常见问题 >

什么是号码检测API

2020-09-09 15:51

云崭数据提供号码检测API接口
都在说API,API到底是什么?对于很多非IT人士而言,API ≈ 听不懂。

其实日常生活中,我们有很多类似API的场景,比如:

电脑需要调用手机里面的信息,这时候你会拿一根数据线将电脑手机连接起来,电脑和手机上连接数据线的接口就是传说中的API接口。

 

但比喻到底是比喻,并非本质。想要真正理解API,还得老老实实去理解API的使用场景。

 

先来一段按惯例放上、但可跳过不看的百科介绍:

API,英文全称Application Programming Interface,翻译为“应用程序编程接口”。是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。——百度百科

 

我们不妨把API的诞生过程用一个小故事展示出来:

研发人员A开发了软件A,研发人员B正在研发软件B。

有一天,研发人员B想要调用软件A的部分功能来用,但是他又不想从头看一遍软件A的源码和功能实现过程,怎么办呢?

研发人员A想了一个好主意:我把软件A里你需要的功能打包好,写成一个函数;你按照我说的流程,把这个函数放在软件B里,就能直接用我的功能了!

其中,API就是研发人员A说的那个函数。

那么API在号码检测中是如何使用的呢?

使用以下API接口文档进行对接,您无需人工上传下载,就可以直接通过您的外呼系统直接对号码进行过滤外呼:

Api文档

公共参数

Authorization:用户身份令牌
 通过header传递
 值为sid:ts的Base64编码
 1小时内有效,可本地缓存50分钟
sid 注册自动生成,不同检测类型sid不同,联系客服获取
ts 当前时间戳,格式为yyyyMMddHHmmss
 
sig:验证参数
值为sid + skey + ts的SHA1加密串
与Authorization缓存策略相同
sid 与Authorization的sid值相同
skey secret_key,安全密钥,与sid成对使用,联系客服获取
ts 与Authorization的ts值相同
 

黑产检测

1.对称加密
请求方式 :POST
请求地址 :https://api.yunzhandata.com/api/darkindustry/v1.0/detect?sig=xxxx
请求 Header :
Authorization 见公共参数说明
Content-Type application/json
请求参数:
sig 见公共参数说明
请求body
{
"mobiles":[
"EE2118FFBA06E7FC02F4C5D2283954F2",
"A0C721007B6A9A027B739F9D04B8D589"
]
}
Body参数说明:
mobiles 字符串数组,单个手机号使用AES对称加密,密钥为sid,不超过2000个
返回body:
{
    "code": 0,
    "message": "成功",
    "requestId": "29a1fa16-fbc0-4234-b432-64e12a099e29",
    "timestamp": "2019-08-27 12:18:26",
    "mobiles": [
        {
            "mobile": "6A26A90ADDBF33F5118CC0299813DDB3",
            "mobileStatus": 0,
            "mobileStatusStr": "黑产"
        },
        {
            "mobile": "A56B27E2BA4BBD64F42D0EE224BC1E20",
            "mobileStatus": 0,
            "mobileStatusStr": "黑产"
        }
    ]
}
返回参数说明
code 返回码,非0即失败
message 返回描述
timestamp 时间戳
requestId 请求id
mobiles 手机号信息,失败时为空
   mobile 检测的手机号,对称加密后的字符串
   mobileSatus 手机号状态,0-黑产,1-疑似,2-真实,3-极度疑似
   mobileStatusStr 手机号状态字符串
 
2.MD5加密
请求方式 :POST
请求地址 :https://api.yunzhandata.com/api/darkindustry/v1.0/detectMD5?sig=xxxx
请求 Header :
Authorization 见公共参数说明
Content-Type application/json
请求参数:
sig 见公共参数说明
请求body
{
"mobiles":[
"0cc0c3d5089e20f448145f2bdefd2cf3",
"cd8b85367ee1e06016656016d823ced4"
]
}
Body参数说明:
mobiles 字符串数组,单个手机号使用MD5加密,不超过2000个
返回body:
{
    "code": 0,
    "message": "成功",
    "requestId": "6573e7e0-b0dc-4da4-b971-8ad084d20d86",
    "timestamp": "2019-09-28 11:56:11",
    "mobiles": [
        {
            "mobile": "cd8b85367ee1e06016656016d823ced4",
            "mobileStatus": 0,
            "mobileStatusStr": "黑产"
        },
        {
            "mobile": "0cc0c3d5089e20f448145f2bdefd2cf3",
            "mobileStatus": 0,
            "mobileStatusStr": "黑产"
        }
    ]
}
返回参数说明
code 返回码,非0即失败
message 返回描述
timestamp 时间戳
requestId 请求id
mobiles 手机号信息,失败时为空
   mobile 检测的手机号,md5字符串
   mobileSatus 手机号状态,0-黑产,1-疑似,2-真实,3-极度疑似
   mobileStatusStr 手机号状态字符串
 
 

空号检测

1.对称加密方式
请求方式 :POST
请求地址 :https://api.yunzhandata.com/api/ deadnumber/v1.0/detect?sig=xxxx
请求 Header :
Authorization 见公共参数说明
Content-Type application/json
请求参数:
sig 见公共参数说明
请求body
{
"mobiles":[
"EE2118FFBA06E7FC02F4C5D2283954F2",
"A0C721007B6A9A027B739F9D04B8D589"
]
}
Body参数说明:
mobiles 字符串数组,单个手机号使用AES对称加密,密钥为sid,不超过2000个
返回body:
{
    "code": 0,
    "message": "成功",
    "requestId": "29a1fa16-fbc0-4234-b432-64e12a099e29",
    "timestamp": "2019-08-27 12:18:26",
    "mobiles": [
        {
            "mobile": "6A26A90ADDBF33F5118CC0299813DDB3",
            "mobileStatus": 0,
            "mobileStatusStr": "空号"
        },
        {
            "mobile": "A56B27E2BA4BBD64F42D0EE224BC1E20",
            "mobileStatus": 0,
            "mobileStatusStr": "空号"
        }
    ]
}
返回参数说明
code 返回码,非0即失败
message 返回描述
timestamp 时间戳
requestId 请求id
mobiles 手机号信息,失败时为空
   mobile 检测的手机号,对称加密后的字符串
   mobileSatus 手机号状态,0-空号,1-疑似,2-实号
   mobileStatusStr 手机号状态字符串
 
2.MD5加密方式
请求方式 :POST
请求地址 :https://api.yunzhandata.com/api/ deadnumber/v1.0/detectMD5?sig=xxxx
请求 Header :
Authorization 见公共参数说明
Content-Type application/json
请求参数:
sig 见公共参数说明
请求body
{
"mobiles":[
"81297b49adbd1b5adff82d303258203a",
"e9cd0ca81d7eac16183040d5742853fa"
]
}
Body参数说明:
mobiles 字符串数组,单个手机号使用AES对称加密,密钥为sid,不超过2000个
返回body:
{
    "code": 0,
    "message": "成功",
    "requestId": "29a1fa16-fbc0-4234-b432-64e12a099e29",
    "timestamp": "2019-08-27 12:18:26",
    "mobiles": [
        {
            "mobile": "81297b49adbd1b5adff82d303258203a ",
            "mobileStatus": 0,
            "mobileStatusStr": "空号"
        },
        {
            "mobile": "e9cd0ca81d7eac16183040d5742853fa ",
            "mobileStatus": 0,
            "mobileStatusStr": "空号"
        }
    ]
}
返回参数说明
code 返回码,非0即失败
message 返回描述
timestamp 时间戳
requestId 请求id
mobiles 手机号信息,失败时为空
mobile 检测的手机号,MD5加密后的字符串
mobileSatus 手机号状态,0-空号,1-疑似,2-实号
mobileStatusStr 手机号状态字符串
 
 

返回码说明:

0 成功
1000 参数非法
1001 Authorization参数错误
1002 签名过期
1003 缺少认证参数
1004 HTTP方法错误
1005 签名错误
1006 Content-Type参数错误
1008 Authorization格式错误
1009 Authorization时间过期
2001 secretid与验证类型不匹配
2002 账户剩余次数不足
2003 secretid无效
2004 资金账户无效
3000 手机号为空
3001 手机号超过2000
3002 手机号不正确
9000 系统错误

上一篇:用空号检测有什么好处
下一篇:没有了