所有api接口都需要鉴权规则,具体详情前往鉴权规则查看

黑红名单管理接口目录

黑红名单管理接口

1.添加黑红名单

请求参数

字段名称 字段类型 是否必传 字段描述
type string 需要查询的黑红名单类型 呼入黑名单:callInBlackNum,呼出黑名单:callOutBlackNum,红名单:redNum,黑名单:blackNum
numbers string[] 号码列表

请求示例

curl --location --request POST 'http://v7openapi.7moor.com/openapi/v1/blacknum/addRedOrBlackNum' \
--header 'm7-appkey: 2000143' \
--header 'm7-nonce: 025513' \
--header 'm7-sign: 77iIqkeVA8v7FnYQnlpzvGFMBEpXaT9+30+iMtN6L0g=' \
--header 'm7-timestamp: 1604580737' \
--header 'content-type: application/json' \
--data-raw '{
    "type": "blackNum",
    "numbers": ["18616379628"]
}'

返回示例

{
    "success": true,
    "code": "200",
    "message": "requestSuccess",
    "requestInfo": {
        "requestId": "ebd8fa50fff811ebbfe661d95d71f0ed",
        "url": "/openapi/v1/blacknum/addRedOrBlackNum",
        "proxyUrl": "http://v7-call/call/openapi/v1/blacknum/addRedOrBlackNum",
        "body": {
            "type": "blackNum",
            "numbers": [
                "18616379628"
            ]
        },
        "span": {
            "requestStartTime": 1629273013878,
            "proxyStartTime": 1629273013879,
            "proxyEndTime": 1629273013917,
            "reqEndTime": 1629273013917,
            "bizSpan": "38ms",
            "latency": "1ms"
        }
    }
}

2.删除黑红名单

请求参数

字段名称 字段类型 是否必传 字段描述
type string 需要查询的黑红名单类型 呼入黑名单:callInBlackNum,呼出黑名单:callOutBlackNum,红名单:redNum,黑名单:blackNum
numbers string[] 号码列表

请求示例

curl --location --request POST 'http://v7openapi.7moor.com/openapi/v1/blacknum/deleteRedOrBlackNum' \
--header 'm7-appkey: 2000143' \
--header 'm7-nonce: 025513' \
--header 'm7-sign: 77iIqkeVA8v7FnYQnlpzvGFMBEpXaT9+30+iMtN6L0g=' \
--header 'm7-timestamp: 1604580737' \
--header 'content-type: application/json' \
--data-raw '{
    "type": "blackNum",
    "numbers":["18616379628"]
}'

返回示例

{
    "success": true,
    "code": "200",
    "message": "requestSuccess",
    "requestInfo": {
        "requestId": "01f14220fff911eb9235b9049666ce00",
        "url": "/openapi/v1/blacknum/deleteRedOrBlackNum",
        "proxyUrl": "http://v7-call/call/openapi/v1/blacknum/deleteRedOrBlackNum",
        "body": {
            "type": "blackNum",
            "numbers": [
                "18616379628"
            ]
        },
        "span": {
            "requestStartTime": 1629273050946,
            "proxyStartTime": 1629273050947,
            "proxyEndTime": 1629273051013,
            "reqEndTime": 1629273051013,
            "bizSpan": "66ms",
            "latency": "1ms"
        }
    }
}

3.查询黑红名单

请求参数

字段名称 字段类型 是否必传 字段描述
page number 页码 最小为1
pageSize number 条数 最小为1
types string[] 黑红名单类型

请求示例

curl --location --request POST 'http://v7openapi.7moor.com/openapi/v1/blacknum/queryRedOrBlackNum' \
--header 'm7-appkey: 2000143' \
--header 'm7-nonce: 025513' \
--header 'm7-sign: 77iIqkeVA8v7FnYQnlpzvGFMBEpXaT9+30+iMtN6L0g=' \
--header 'm7-timestamp: 1904580737' \
--header 'content-type: application/json' \
--data-raw '{
    "page":1,
    "pageSize":20,
    "types":["blackNum"]
}'

返回参数

字段名称 字段类型 是否必传 字段描述
_id string 号码主键
number string 号码
accountId string 账户编号
createTime string 创建时间
updateTime string 更新时间
memo string 号码备注
type string 号码类型

返回示例

{
    "success": true,
    "code": "200",
    "message": "requestSuccess",
    "data": {
        "list": [
            {
                "_id": "611bc1f5272458001109b7bf",
                "number": "17319132391",
                "accountId": "2000143",
                "createTime": "2021-08-17 22:04:37",
                "updateTime": "2021-08-17 22:04:37",
                "memo": "",
                "type": "blackNum",
                "__v": 0
            }
        ],
        "total": 1
    },
    "requestInfo": {
        "requestId": "73a2c9c0fff911ebbfe661d95d71f0ed",
        "url": "/openapi/v1/blacknum/queryRedOrBlackNum",
        "proxyUrl": "http://v7-call/call/openapi/v1/blacknum/queryRedOrBlackNum",
        "body": {
            "page": 1,
            "pageSize": 20,
            "types": [
                "blackNum"
            ]
        },
        "span": {
            "requestStartTime": 1629273241692,
            "proxyStartTime": 1629273241694,
            "proxyEndTime": 1629273241712,
            "reqEndTime": 1629273241713,
            "bizSpan": "18ms",
            "latency": "3ms"
        }
    }
}