该接口用于将聊天室设置为整体禁言状态（仅创建者和管理员能发言）。

只有聊天室创建者或管理员才能设置整体禁言。

调用频率

单个应用默认最高调用频率请参考 频控说明。

请求

URL

PATCH https://open.yunxinapi.com/im/v2/chatrooms/:{room_id}/actions/chat_banned

Header

请求 Header 的参数说明请参见请求 Header。

路径参数

参数名称	类型	是否必选	描述
room_id	Long	必选	需要设置整体禁言的聊天室 ID，聊天室创建成功后，云信会返回聊天室 ID。

请求体参数

参数名称	类型	是否必选	描述
operator_account_id	String	必选	操作者（聊天室创建者或管理员）的云信账号 ID。
chat_banned	Boolean	必选	是否将聊天室设置为整体禁言状态（仅管理员和创建者可以发言）。true：整体禁言；false：取消整体禁言。
notification_enabled	Boolean	可选	是否发送禁言聊天室通知。true（默认）：发送；false：不发送。
notification_extension	String	可选	通知事件的扩展字段，长度上限 2048 位字符。

请求体示例

json{
    "notification_enabled": true,
    "chat_banned": true,
    "notification_extension": "culpa tempor labore do",
    "operator_account_id": "yx1"
}

响应

Header

响应 Header 的参数说明请参见响应 Header。

响应体参数

参数名称	类型	描述	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是

响应体示例

json{
  "code": 200,
  "msg": "success",
  "data": {}
}

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
416	频率超限	rate limit exceeded
102404	用户不存在	account not exist
113410	聊天室服务未开通	chatroom service disabled
113409	聊天室重复操作	operation on chatroom repeated
113404	聊天室不存在	chatroom not exist
113406	聊天室已关闭	chatroom closed
113428	仅允许聊天室管理员操作	chatroom manager operation permission required
500	服务端内部错误	internal server error
503	服务器繁忙	server busy