房间解禁

更新时间: 2025/08/18 17:06:39

调用该接口解除房间内成员的禁言,并允许开启音频或视频功能。

功能说明

解除房间全体禁言功能可以:

  • 解除房间内所有成员的聊天禁言状态
  • 解除房间内所有成员的音频禁用状态
  • 解除房间内所有成员的视频禁用状态
  • 同时解禁房间中已经被单独禁言/禁音/禁视频的成员(可选)

请求信息

请求 URI

PATCH https://{endpoint}/neroom/v1/rooms/:room_archive_id/cancel_mute

请求 URI 中的 {endpoint} 代表服务地址域名,您可以根据用户服务区域选择中国大陆和海外服务地址,并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

请求 Header 的参数说明请参考 请求结构

请求路径参数

参数名称 类型 是否必选 示例 说明
room_archive_id String 123456789 房间 ID。

请求体参数

参数名称 类型 是否必选 示例 说明
unmute_individual Boolean true 是否同时解禁房间中已经被单独禁言/禁音/禁视频的成员。true 表示解禁,false 或不传表示不处理单独禁言的成员
chat Boolean true 是否解禁聊天功能。true 表示解禁聊天功能,false 或不传表示不改变当前状态
video Boolean true 是否解禁视频功能。true 表示解禁视频功能,false 或不传表示不改变当前状态
audio Boolean true 是否解禁音频功能。true 表示解禁音频功能,false 或不传表示不改变当前状态
notify_ext String "operation_info" 扩展信息,在消息里透传给客户端,最大 2048 个字符
operator_user_uuid String "test01" 操作人的用户 ID。该参数可以设置为空。
如果您需要通知客户端操作人信息,您可以设置该参数。如果传入了该参数,则会校验操作人的角色是否具备对应的 操作权限 的权限。角色的权限可通过控制台的模板里设置,具体信息请参考 如何修改角色的权限

请求体示例

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

响应信息

响应参数

参数名称 类型 说明 是否必返回
code Integer 状态码,0 表示成功,具体信息请参考 错误码
msg String 业务结果描述,Success 表示成功
ts Long NERoom 服务器处理该请求的完成时间。Unix 时间戳,即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的毫秒数
cost String 处理该请求所消耗的时间
request_id String 请求的唯一标识
data Object 响应数据,此接口返回为空

响应体示例

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

错误码

本文仅列举部分业务接口错误码,完整列表请参考 错误码

错误码 错误信息 说明 处理建议
400 Invalid parameter. 参数错误 检查接口传参
403 Access denied. 操作人没有权限 检查操作人(operator_user_uuid)角色的权限或者在 网易云信控制台 给角色配置对应的操作权限
1004 Room not found. 房间不存在或者已经结束 检查房间 ID(room_archive_id)和房间状态
1015 Member does not exist. 被操作的成员不存在或者不在房间内 检查被操作的成员 ID(user_uuid)
此文档是否对你有帮助?
有帮助
去反馈
  • 功能说明
  • 请求信息
  • 请求 URI
  • 请求头参数
  • 请求路径参数
  • 请求体参数
  • 请求体示例
  • 响应信息
  • 响应参数
  • 响应体示例
  • 错误码