Loading...

    一、拉黑用户

    功能说明

    拉黑用户

    实现方法

    REST URL

    POST /api/rest/external/v1/enterprise/blacklist/account

    请求参数说明

    参数

    参数类型

    参数位置

    必须

    默认值

    说明

    初始平台

    enterpriseId

    String

    Query

    企业 ID

    5.2-20260928

    公有云不存在

    signature

    String

    Query

    请求签名

    5.2-20260928

    公有云不存在

    phone

    String

    Body

    phone 与 externalUserId 二选一

    5.2-20260928

    公有云不存在

    externalUserId

    String

    Body

    phone 与 externalUserId 二选一

    5.2-20260928

    公有云不存在

    示例代码

    请求示例

    {
    "phone": "123456"
    }

    响应示例

    响应为空。以 http 200 来判断成功。

    二、把用户放出黑名单

    功能说明

    把用户放出黑名单

    实现方法

    REST URL

    POST /api/rest/external/{version}/enterprise/blacklist/account/remove

    请求参数说明

    参数

    参数类型

    参数位置

    必须

    默认值

    说明

    初始平台

    enterpriseId

    String

    Query

    企业 ID

    5.2-20260928

    公有云不存在

    signature

    String

    Query

    请求签名

    5.2-20260928

    公有云不存在

    phone

    String

    Body

    phone 与 externalUserId 二选一

    5.2-20260928

    公有云不存在

    externalUserId

    String

    Body

    phone 与 externalUserId 二选一

    5.2-20260928

    公有云不存在

    示例代码

    请求示例

    {
    "phone": "123456"
    }

    响应示例

    响应为空。以 http 200 来判断成功。


    三、分页查询用户黑名单

    功能说明

    把用户放出黑名单

    实现方法

    REST URL

    GET /api/rest/external/{version}/enterprise/blacklist/account/page

    请求参数说明

    参数

    参数类型

    参数位置

    必须

    默认值

    说明

    初始平台

    enterpriseId

    String

    Query

    企业 ID

    5.2-20260928

    公有云不存在

    signature

    String

    Query

    请求签名

    5.2-20260928

    公有云不存在

    pageIndex

    int

    Query

    0

    页码,默认为0

    5.2-20260928

    公有云不存在

    pageSize

    int

    Query

    20

    每页大小,默认为10,最大不能超过100

    5.2-20260928

    公有云不存在

    示例代码

    响应示例

    {
    "page": 0,
    "pageTotal": 17,
    "rowsTotal": 34,
    "rows": 2,
    "list": [
    {
    "userDisplayName": "xxxx",
    "joinReason": "xxxx",
    "userProfileId": "1234",
    "usePhone":"123456",
    "email":"33@123.com",
    "joinTime":1769887777388
    },
    ]
    }


    返回参数说明:

    参数

    说明

    userDisplayName

    姓名

    joinReason

    来黑原因

    userProfileId

    用户id

    usePhone

    账号

    email

    邮箱

    joinTime

    拉黑时间(时间戳)