风控

概述

主要页面提供风控相关业务接口。

所有接口如果是 POST 方式进行交互，则通讯格式为 application/json

服务器返回格式均为 JSON。

一、号码是否黑名单

1.1 接口

GET/POST https://openapi.icsoc.net/router/api/v3/risk/is-phone-in-blacklist

1.2 入参

参数名称	类型	说明	是否必须
phone	string	号码	是

1.3 出参

参数名称	类型	说明	是否必须
code	int	0为成功，其他均为不成功，请参考 message	是
message	string		是
data	object		是
data.result	bool	true 为在黑名单内，false 不在黑名单内	是

1.4 举例

curl -X GET -H 'Authorization: Bearer a24e562a877c17f9a594c7ea7916bdbe807e23f711' "https://openapi.icsoc.net/router/api/v3/risk/is-phone-in-blacklist?phone=18512345678"

{
    "code": 0,
    "message": "success",
    "request_id": "Bzl6tkwKgFoum0qY25UhvRVXdJrR64dp",
    "data": {
        "result": false
    }
}

二、主被叫号码是否被风控

2.1 接口

POST https://openapi.icsoc.net/router/api/v3/risk/call-center

2.2 入参

参数名称	类型	说明	是否必须
caller	Caller	号码	是
called	Called	号码	是

2.2.1 Caller

参数名称	类型	说明	是否必须
caller	string	号码	是
code	string	区号	否
city	string	城市	否
type	string	号码类型	否
vendor	string	运营商	否

2.2.2 Called

参数名称	类型	说明	是否必须
called	string	号码	是
code	string	区号	否
city	string	城市	否
type	string	号码类型	否
vendor	string	运营商	否

2.3 出参

参数名称	类型	说明	是否必须
code	int	0为成功，其他均为不成功，请参考 message	是
message	string		是
data	object		是
data.risk	bool	true 为被风控，false 未被风控	是

2.4 举例

2.4.1 入参

{
    "caller": {
        "caller": "01012345678",
        "code": "010",
        "city": "北京 北京",
        "type": "TEL",
        "vendor": ""
    },
    "called": {
        "called": "18512345678",
        "code": "010",
        "city": "北京 北京",
        "type": "MOBILE",
        "vendor": "unicom"
    }
}

2.4.2 出参

{
    "code": 0,
    "message": "success",
    "request_id": "Bzl6tkwKgFoum0qY25UhvRVXdJrR64dp",
    "data": {
        "risk": false
    }
}

三、批量查询多个主被叫号码是否被风控

如果有多个号码查询，建议优先以并发的方式调用 「二、主被叫号码是否被风控」 接口，此接口仅在并发不可行的情况下使用。

3.1 接口

POST https://openapi.icsoc.net/router/api/v3/risk/call-center-batch

3.2 入参

参数名称	类型	说明	是否必须
/	Request[]	请求列表	是

3.2.1 Request

参数名称	类型	说明	是否必须
caller	Caller	号码	是
called	Called	号码	是

3.2.1.1 Caller

参数名称	类型	说明	是否必须
caller	string	号码	是
code	string	区号	否
city	string	城市	否
type	string	号码类型	否
vendor	string	运营商	否

3.2.1.2 Called

参数名称	类型	说明	是否必须
called	string	号码	是
code	string	区号	否
city	string	城市	否
type	string	号码类型	否
vendor	string	运营商	否

3.3 出参

参数名称	类型	说明	是否必须
code	int	0为成功，其他均为不成功，请参考 message	是
message	string		是
data	object[]	响应顺序与请求顺序一致	是
data.risk	bool	true 为被风控，false 未被风控	是

3.4 举例

3.4.1 入参

[
    {
        "caller": {
            "caller": "01012345678",
            "code": "010",
            "city": "北京 北京",
            "type": "TEL",
            "vendor": ""
        },
        "called": {
            "called": "18512345678",
            "code": "010",
            "city": "北京 北京",
            "type": "MOBILE",
            "vendor": "unicom"
        }
    }
]

3.4.2 出参

{
    "code": 0,
    "message": "success",
    "request_id": "Bzl6tkwKgFoum0qY25UhvRVXdJrR64dp",
    "data": [
        {
            "risk": false
        }
    ]
}