这里是黑红名单接口v2

注意,本接口的使用需要进行接口鉴权

增加黑红名单接口

  • HTTP请求方式:POST

  • 鉴权方式:接口鉴权

  • 请求链接:{HOST}/v20160818/blacknum/saveBlackList/accountId?sig=sig

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

请求频次限制:

20次/分钟

请求体

字段 类型 是否必须 备注
PBX String 单pbx账号非必须,多pbx账号必须 账户所在服务器地址可从对接数据查询
BlackNum String 号码集合,号码间用逗号分隔,如133xxxxxxxx,187xxxxxxxx,.......
Type String 名单类型:
0:呼入红名单 1:呼入黑名单
2:外呼黑名单

注意:BlackNum中最多放1000个号码。

请求体示例

{
    "BlackNum": "133xxxxxxxx,187xxxxxxxx”,
    "Type": "2"
}

返回值:

字段 含义
code 响应码
message 响应信息
goodmessage 请求成功时,返回已成功操作的数据
badmessage 请求成功时,返回未成功操作的数据

code:

代码 含义
200 请求成功
400 请求体参数错误
402 参数错误
403 接口访问频次达到上限或者鉴权失败
500 服务器错误

返回200示例

{
    "code": 200,
    "message": "success!",
    "goodmessage": "18585858585 is ok !"
}
{
    "code": 200,
    "message": "success!",
    "badmessage": "18103481234 BlackNum is Exist!",
    "goodmessage": "18585858585 is ok !"
}

返回400示例:

{
    "code": 400,
    "message": "Please check your parameters"
}

返回402示例:

{
    "code": 402,
    "message": "Account or PBX is not found!"
}

返回403示例:

{
    "code": 403,
    "message": "Server is busy, max request frequency is 20/min"
}

返回500示例:

{
    "code": 500,
    "message": {
        "code": "ENOTFOUND",
        "errno": "ENOTFOUND",
        "syscall": "getaddrinfo"
    }
}

删除黑红名单接口

  • HTTP请求方式:POST

  • 请求url:{HOST}/v20160818/blacknum/delBlackList/accountId?sig=SIG

  • 请求时请将{HOST}换成对接数据查询中获取到的请求域名,ACCOUNTID替换为账户编号,SIG是根据鉴权规则生成的,请看鉴权文档,查看具体的生成规则

  • 鉴权文档:接口鉴权

示例:

http://apis.7moor.com/v20160818/blacknum/delBlackList/N00000000421?sig=DBD2D28F3D895AAD1572925AAE50AEA8

请求频次限制:

20次/分钟

请求体

字段 类型 是否必须 备注
PBX String 单pbx账号非必须,多pbx账号必须 账户所在服务器地址可从对接数据查询
BlackNum String 号码集合,号码间用逗号分隔,如133xxxxxxxx,187xxxxxxxx,.......
Type String 名单类型 值0-2 0:呼入红名单 1:呼入黑名单 2:外呼黑名单

注意:BlackNum中最多放1000个号码。

请求体示例

{
    "BlackNum": "133xxxxxxxx,187xxxxxxxx”,
    "Type": "2"
}

返回值:

字段 含义
code 响应码
message 响应信息
goodmessage 请求成功时,返回已成功操作的数据
badmessage 请求成功时,返回未成功操作的数据

code:

代码 含义
200 请求成功
400 请求体参数错误
402 参数错误
403 接口访问频次达到上限或者鉴权失败
500 服务器错误

返回200示例

{
    "code": 200,
    "message": "success!",
    "goodmessage": "18585858585 is ok !"
}
{
    "code": 200,
    "message": "success!",
    "badmessage": "18103481234 BlackNum not Exist!",
    "goodmessage": "18585858585 is ok !"
}

返回400示例:

{
    "code": 400,
    "message": "Please check your parameters"
}

返回402示例:

{
    "code": 402,
    "message": "Account or PBX is not found!"
}

返回403示例:

{
    "code": 403,
    "message": "Server is busy, max request frequency is 20/min"
}

返回500示例:

{
    "code": 500,
    "message": {
        "code": "ENOTFOUND",
        "errno": "ENOTFOUND",
        "syscall": "getaddrinfo"
    }
}

查询黑红名单

请求url:

http://apis.7moor.com/v20160818/blacknum/queryRedOrBlackNum/N00000000422 ?sig=sig

示例:

http://apis.7moor.com/v20160818/blacknum/queryRedOrBlackNum/N00000000422
?sig=3E92F146297FCA751F63493877EC9719

请求体示例

{"pbx":"test.ali.1.0",”type” : “1”}

type 1为查呼入黑名单 0 为查红名单 2 为查外呼黑名单

pbx 为必传 type非必传 不传查所有

返回示例:

{
  "Succeed": true,
  "Response": "queryRedOrBlackNum",
  "list": [
    {
      "_id": "ea8fe02b-f13e-4235-8517-2ba86e42bc85",
      "Type": "callInBlackNum",//呼入黑名单
      "Num": "057128070127"
    },
    {
      "_id": "2a8ae623-3e31-4634-b1ed-193e62643e2d",
      "Type": "redNum",//红名单
      "Num": "15010457346"
    },
    {
      "_id": "6b379f82-485a-4e82-b0b1-ad48b4929d22",
      "Type": "callInBlackNum",
      "Num": "13836953645"
    },
    {
      "_id": "6dc5a331-ab41-475a-88c2-0401365df4ee",
      "Num": "13836953644",
      "Type": "callOutNum"//外呼黑名单
    }
  ]
}