本文将介绍如何将房间中的指定成员添加到黑名单中。每个房间的黑名单成员数量上限是1000。

请求

URI

httpPATCH https://{endpoint}/neroom/v1/rooms/{room_archive_id}/add_blacklist

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

Header

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

路径参数

参数名称	类型	是否必须	描述
room_archive_id	String	是	房间ID。

请求体参数

请求 Body 的字段如下：

参数名称	类型	是否必须	描述
user_uuid	string	是	添加到黑名单的用户ID。
operator_user_uuid	String	否	操作人的用户ID。该参数可以设置为空。 如果您需要通知客户端操作人信息，您可以设置该参数。如果传入了该参数，则会校验操作人的角色是否具备对应的黑名单管理的权限。角色的权限可通过控制台的模版里设置，具体信息请参见如何修改角色的权限。
notify_ext	String	否	扩展信息，在消息里透传给客户端，最大2048字符。

请求体示例

json{
  "user_uuid":"test02",
  "operator_user_uuid":"test01",
  "notifyExt":"ext"
}

响应

响应字段

参数名称	类型	示例	描述
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	-	-	无。

响应示例

json{
    "code": 0,
    "msg": "Operation succeeded.",
    "ts": 1684374465150,
    "cost": "405ms",
    "request_id": "b3d293d26b******a3d589c9d2366",
    "data": null
}

错误码

错误码	错误信息	说明	处理建议
403	Access denied.	操作人没有权限。	检查操作人(operator_user_uuid)角色的权限或者在控制台给角色加上黑名单管理的权限。
1004	Room not found.	房间不存在或者已经结束。	检查房间ID(room_archive_id)和房间状态。
1015	Member does not exist.	被变更角色的成员不存在或者不在房间内。	检查被变更角色的成员ID(user_uuid)。
601012	The members of blacklist over limit.	黑名单数量超过上限	减少房间黑名单内的人数