API文档

# 添加全局黑名单

# 接口说明

项 值
URL /openapi/v1/live/globalBlackList/add.json
描述 添加全局黑名单
请求方式 POST
需要登录 是
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
type integer 拉黑内容类型。0-客户编号 1-手机号 2-微信unionId 3-微信openId 4-IP地址 是
contentList array<string> 拉黑对象列表，与 type 对应，支持批量 是
reason string 拉黑原因 否

# 请求数据

{
    "type": 0,
    "contentList": ["HbXuqPHv8h"],
    "reason": ""
}

# 返回数据

{
    "code": 200,
    "msg": "",
    "data": null
}

# 移除全局黑名单

# 接口说明

项 值
URL /openapi/v1/live/globalBlackList/remove.json
描述 移除全局黑名单记录
请求方式 POST
需要登录 是
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
id string 黑名单记录唯一编码 是

# 请求数据

{
    "id": "xxxx"
}

# 返回数据

{
    "code": 200,
    "msg": "",
    "data": null
}

# 全局黑名单列表查询

# 接口说明

项 值
URL /openapi/v1/live/globalBlackList/list.json
描述 查询全局黑名单列表
请求方式 POST
需要登录 是
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
type integer 拉黑内容类型，按类型过滤 否
query string 按拉黑对象模糊查询 否
pageDto object 分页参数：pageNum、pageSize 是

# 请求数据

{
    "type": 0,
    "query": "",
    "pageDto": {"pageNum": 1, "pageSize": 20}
}

# 返回数据

{
    "code": 200,
    "msg": "",
    "data": [
        {
            "id": "xxxx",
            "content": "HbXuqPHv8h",
            "type": 0,
            "typeDesc": "客户编号",
            "reason": "",
            "source": "",
            "blackTime": 1721000000000
        }
    ],
    "pageDto": {"pageNum": 1, "pageSize": 20, "total": 1}
}
字段名 字段类型 说明
id string 黑名单记录唯一编码
content string 被拉黑的内容
type integer 拉黑内容类型
typeDesc string 拉黑内容类型描述
reason string 拉黑原因
source string 拉黑来源
blackTime long 拉黑时间戳

# 批量查询是否在黑名单

# 接口说明

项 值
URL /openapi/v1/live/globalBlackList/exist.json
描述 批量查询指定内容是否在全局黑名单中
请求方式 POST
需要登录 是
注意事项 无
其他 无

# 请求参数说明

字段名 字段类型 说明 是否必传
contentList array<string> 待查询的内容列表 是

# 请求数据

{
    "contentList": ["HbXuqPHv8h", "13800000000"]
}

# 返回数据

{
    "code": 200,
    "msg": "",
    "data": ["HbXuqPHv8h"]
}

data 为 contentList 中命中黑名单的内容子集。

← 优惠券 →