本文将介绍如何获取房间的黑名单列表。

请求

URI

httpGET https://{endpoint}/neroom/v1/rooms/:room_archive_id/blacklist?page_number=:page_number&page_size=:page_size

• {endpoint} 为 NERoom 接入地址的域名，默认为 roomkit.netease.im。如果您的应用主要服务于海外用户，请将域名设置为海外数据中心域名（roomkit-sg.netease.im）。
• Content-Type: application/json; charset=utf-8。

Header

请求 Header 的设置请参见 请求结构。

路径参数

参数名称	类型	是否必须	描述
room_archive_id	String	是	房间 ID。
page_number	Number	否	当前页，默认从1开始。
page_size	Number	否	每页展示的黑名单用户数量，默认50，最大1000。

请求体示例

jsonhttps://roomkit.netease.im/neroom/v1/rooms/1***12/blacklist?page_number=1&page_size=10

响应

响应字段

参数名称	类型	示例	描述
code	Integer	0	状态码，0表示成功，具体信息请参见错误码。
msg	String	Operation succeeded.	业务结果描述，Success表示成功。
ts	Long	1648021056815	NERoom 服务器处理该请求的完成时间。 Unix 时间戳，即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数。
cost	String	405ms	处理该请求所消耗的时间。
request_id	String	b3d293d26b******a3d589c9d2366	请求的唯一标识。
data	JsonObject	-	黑名单列表

响应示例

json{
    "code": 0,
    "msg": "Operation succeeded.",
    "ts": 1684374465150,
    "cost": "405ms",
    "request_id": "b3d293d26bf******ca3d589c9d2366",
    "data":
    {
        "total": 1,
        "blacklist":
        [
            {
                "user_uuid": "test01",
                "user_name": "张三"
            }
        ]
    }
}

错误码

错误码	错误信息	说明	处理建议
400	Invalid parameter.	参数错误	检查接口传参
1004	Room not found.	房间不存在或者已经结束。	检查房间ID(room_archive_id)和房间状态。