查询黑/白名单

1、请求地址:

/base/{account}/getBlackNums?sign={sign}

2、请求参数:

属性 类型 约束 说明
blackNum String 可选 主叫黑名单号码
timelimit String 可选 黑名单时限 格式为“yyyy-MM-dd HH:mm:ss”,黑名单在该时间内有效
appId String 必选 应用标识
type int 可选 类型 1 白名单 2黑名单
size int 可选 每页展示的数据量,用于分页展示,默认为50
page int 可选 页码,用于分页展示,默认1

3、请求实例:

POST base/{account}/getBlackNums?sig=31safacadffgaga121cdagavaf
HTTP/1.1
Host: 192.168.0.1:8888
content-length: 139
Accept: application/json;
Content-Type: application/json; charset=utf-8;
Authorization: ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTA2MzA

{
    "blackNum" : "13912345676",
    "timelimit" : "2020-01-01 01:01:01",
    "appId" : "tdlxtestapp",
    "type" : "1",
    "size" : "100",
    "page" : "1"
}

4、响应结果:

属性 类型 约束 说明
code String 必选 请求状态码,取值200(成功),可参考Rest 错误代码。
msg String 可选 错误原因描述
data String 必选 正确返回数据

5、响应示例:

正确返回:

{
    "
code" : "200",
    "
msg" : null,
    "
data" : {
        "
value" : [{
            "
blacknum" : "13912345676",
            "
limittime":"2099-12-31 00:00:00,
            "
subtime": "2016-10-14 16:52:31",
            "
appId": "tdlxtestapp",
            "
type": "1"
        }]
    }
}

返回参数说明:

属性 说明
blacknum 黑名单号码
limittime 时限
subtime 提交时间
appId 所属应用标识
type 类型 1白名单 2黑名单

错误返回:

{
    "
code" : "201",
    "
msg" : "xxxxx",
    "
data" : null
}

code对应不同错误码 msg,对应不同的错误信息提示