本文介绍如何设置房间内指定成员禁言，禁止开关音频和视频功能。

请求信息

请求 URI

HTTPPATCH https://{endpoint}/neroom/v1/rooms/:room_archive_id/users/:user_uuid/mute

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

请求头参数

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

请求路径参数

参数名称	类型	是否必须	说明
room_archive_id	Boolean	是	房间 ID。
user_uuid	Boolean	是	被禁言的用户 ID。

请求体参数

请求 Body 的字段如下：

参数名称	类型	是否必须	说明
chat	Boolean	否	true 表示禁用聊天功能。 false 或不传表示不改变当前状态。
video	Boolean	否	true 表示禁用视频功能。 false 或不传表示不改变当前状态。
audio	Boolean	否	true 表示禁用音频功能。 false 或不传表示不改变当前状态。
duration	Int	否	被禁言的时长，不传入表示永久禁言，单位为秒。 最短禁言时长 1 秒 最长禁言时长 30 天（2 592 000 秒）
notify_ext	String	否	扩展信息，在消息里透传给客户端，最大 2048 个字符。
operator_user_uuid	String	否	操作人的用户 ID。该参数可以设置为空。 如果您需要通知客户端操作人信息，您可以设置该参数。如果传入了该参数，则会校验操作人的角色是否具备对应的操作权限。角色的权限可通过控制台的模板里设置，具体信息请参考 如何修改角色的权限。

请求体示例

JSON{
    "audio": "true",
    "video": "true",
    "chat": "true",
    "notify_ext": "ext",
    "operator_user_uuid": "test01"
}

响应信息

响应字段

参数名称	类型	示例	说明
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	7c4b6d9c3e9d42*****cc6e3a4d995	请求的唯一标识。
data	Object		-

响应示例

JSON{
    "code": 0,
    "msg": "Operation succeeded.",
    "ts": 1684374465150,
    "cost": "405ms",
    "request_id": "7c4b6d9c3e9d42*****cc6e3a4d995",
    "data": null
}

错误码

错误码	错误信息	说明	处理建议
0	Success	请求成功	无需处理
403	Access denied.	操作人没有权限。	检查操作人(operator_user_uuid)角色的权限或者在 网易云信控制台 给角色加上 黑名单管理 的权限。
1004	Room not found.	房间不存在或者已经结束。	检查房间 ID(room_archive_id)和房间状态。
1015	Member does not exist.	被变更角色的成员不存在或者不在房间内。	检查被变更角色的成员 ID(user_uuid)。