添加黑名单
添加黑名单功能
接口地址
POST http://m.icsoc.net/v2/wintelapi/blacklist/add
接口参数
参数 | 说明 | 备注 |
phones | 要设置为黑名单的号码,多个号码之间逗号分隔 | 必需 |
black_type | 号码类型1固定号码2模糊匹配)默认为固定号码,模糊匹配的号码格式:138********表示以138开头的总长度为11位的号码, 每一个星号代表一位号码 | 必需 |
trunk_num | 中继号码,为空时匹配全部中继号码 | 可选 |
结果编码说明
code | 说明 |
200 | ok |
401 | 企业代码为空 |
402 | 企业代码不存在 |
403 | 固定号码中包含非数字字符 |
404 | 添加黑名单失败 |
406 | 号码格式不对,要求为多个号码逗号分隔的字符串 |
407 | 模糊匹配号码中包含除*外的非数字字符 |
408 | 中继号码不存在 |
410 | 企业ID不存在 |
411 | 号码为空 |
结果示例
{"code":200,"message":"ok"}
删除黑名单
删除黑名单功能
接口地址
POST http://m.icsoc.net/v2/wintelapi/blacklist/delete
接口参数
参数 | 说明 | 备注 |
ids | 要删除的黑名单的号码ID,多个ID之间逗号分隔 | 必需 |
结果编码说明
code | 说明 |
200 | ok |
401 | 企业代码为空 |
402 | 企业代码不存在 |
403 | 号码ID为空 |
404 | 号码ID中包含非数字字符 |
405 | 删除黑名单失败 |
结果示例
{"code":200,"message":"ok"}
获取黑名单
查询当前设置的黑名单列表
接口地址
POST http://m.icsoc.net/v2/wintelapi/blacklist/list
接口参数
参数 | 说明 | 备注 |
info | info:{"pagination":{"rows":20,"page":"5"},"filter": {"keyword":"1025"},"sort":{"field":"id","order":"desc"}} rows: 每页显示条数,page: 第几页field: 想要排序的字段order: 排序方式(asc,desc) filter: 搜索信息 | 必需 |
结果编码说明
code | 说明 |
200 | ok |
401 | 企业代码为空 |
402 | 企业代码不存在 |
403 | info格式非json |
结果示例
{
"code": 200,
"message": "ok",
"total": "5",
"data": [{
"id": 1,
"vcc_id": 1,
"phone_num": "13800001111",
"black_type": 1
}, {
"id": 2,
"vcc_id": 1,
"phone_num": "138****1111",
"black_type": 2
}]
}
结果字段说明
字段 | 说明 |
id | 黑名单Id |
vcc_id | 企业id和企业代码一一对应 |
phone_num | 黑名单号码 |
black_type | 黑名单类型(1固定号码2模糊匹配) |