白名单管理
添加白名单
添加白名单功能
接口地址
POST http://m.icsoc.net/v2/wintelapi/whitelist/add
接口参数
字段 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
phones | String | 是 | 15007157999 | 白号码(多个号码之间逗号分隔) |
trunk_num | String | 是 | 020420001 | 中继号码 |
结果编码说明
code | 说明 |
---|---|
200 | ok |
401 | 企业代码为空 |
402 | 企业代码不存在 |
405 | 号码为空 |
406 | 号码格式不对,要求为多个号码逗号分隔的字符串 |
407 | 中继号码为空 |
408 | 号码中包含非数字字符 |
409 | 添加白名单失败 |
410 | 中继号码不存在 |
结果示例
{"code":200,"message":"ok"}
删除白名单
删除白名单功能
接口地址
POST http://m.icsoc.net/v2/wintelapi/whitelist/delete
接口参数
字段 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
ids | String | 是 | 123 | 白名单ID(多个ID之间逗号分隔) |
结果编码说明
code | 说明 |
---|---|
200 | ok |
401 | 企业代码为空 |
402 | 企业代码不存在 |
403 | 号码ID中包含非数字字符 |
404 | 删除白名单失败 |
407 | 号码ID为空 |
结果示例
{"code":200,"message":"ok"}
获取白名单
查询当前设置的白名单列表
接口地址
POST http://m.icsoc.net/v2/wintelapi/whitelist/list
实例 | |
---|---|
Method | post |
Content-Type | application/x-www-form-urlencoded |
接口参数
字段 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
info | String | 是 | {"pagination":{"rows":20,"page":1},"filter": {"keyword":"1025"},"sort":{"field":"id","order":"desc"}} | 条件(JSON字符串) |
info 参数说明
字段 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
rows | Integer | 是 | 20 | 分页大小 |
page | Integer | 是 | 1 | 页码 |
keyword | String | 否 | 02040001 | 关键字(可查中继号码或黑名单号码) |
field | String | 否 | id | 排序字段 |
order | String | 否 | desc(倒序)或asc(递增) | 排序方式 |
info 参数实例
{
"pagination": {
"rows": 2,
"page": 1
},
"filter": {
"keyword": "18827347363"
},
"sort": {
"field": "id",
"order": "desc"
}
}
结果编码说明
code | 说明 |
---|---|
200 | ok |
401 | 企业代码为空 |
402 | 企业代码不存在 |
405 | info格式非json |
结果示例
{
"code": 200,
"message": "ok",
"data": [
{
"id": 1,
"vcc_id": 1,
"phone_num": "13800001111",
"trunk_num": "02766660001"
},
{
"id": 2,
"vcc_id": 1,
"phone_num": "13811111111",
"trunk_num": "02766660001"
}
]
}
结果字段说明
字段 说 | 明 |
---|---|
id | 白名单Id |
vcc_id | 企业id和企业代码一一对应 |
phone_num | 白名单号码 |