该接口用于设置开启/关闭人员进出聊天室事件通知。

功能描述

在创建聊天室时，可设置开启/关闭人员进出聊天室事件通知。

在聊天室创建成功后，若还需要修改进出聊天室事件的通知状态，可以调用本接口实现。

目前人员进出聊天室事件通知主要包括以下事件：

• 主动退出聊天室
• 聊天室掉线
• 进入聊天室

调用频率

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

请求信息

请求 URL

PATCH https://{endpoint}/im/v2/chatrooms/{room_id}/actions/in_out_notification

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

请求头参数

请求 Header 的参数说明请参考 请求 header。

路径参数

参数名称	类型	是否必选	描述
room_id	Long	是	需要开放/关闭进出通知的聊天室 ID，聊天室创建成功后，网易云信会返回聊天室 ID。

查询参数

参数名称	类型	是否必选	描述
in_out_notification	Boolean	是	是否关闭人员进出聊天室事件通知，false：关闭；true：开启。

响应信息

响应头参数

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

响应体参数

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

响应体示例

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

错误码

本文仅列举部分业务接口错误码，完整列表请参考客户端 API 错误码。

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
416	频率超限	rate limit exceeded
113410	聊天室服务未开通	chatroom service disabled
113308	聊天室成员进出通知功能未开启	notification for joining or leaving chatrooms disabled
113404	聊天室不存在	chatroom not exist
113406	聊天室已关闭	chatroom closed
500	服务端内部错误	internal server error
503	服务器繁忙	server busy