房间解禁
更新时间: 2024/11/04 15:22:15
本文将介绍如何解除房间内所有成员的禁言,并允许开启音频或视频功能。
请求
URI
httpPATCH https://{endpoint}/neroom/v1/rooms/:room_archive_id/cancel_mute
- {endpoint} 为 NERoom 接入地址的域名,默认为
roomkit.netease.im
。如果您的应用主要服务于海外用户,请将域名设置为海外数据中心域名(roomkit-sg.netease.im
)。 - Content-Type: application/json; charset=utf-8。
Header
请求 Header 的设置请参见 请求结构。
路径参数
参数名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
room_archive_id | String | 是 | 房间ID。 |
请求体参数
请求 Body 的设置如下:
参数名称 | 类型 | 是否必须 | 描述 |
---|---|---|---|
chat | Boolean | 否 | true 表示禁用聊天功能,false 或不传表示不改变当前状态。 |
video | Boolean | 否 | true 表示禁用视频功能,false 或不传表示不改变当前状态。 |
audio | Boolean | 否 | true 表示禁用音频功能,false 或不传表示不改变当前状态。 |
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
}
错误码
错误码 | 错误信息 | 说明 | 处理建议 |
---|---|---|---|
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)。 |
此文档是否对你有帮助?