创建聊天室后，聊天室默认处于开放状态，所有用户可自由进入聊天室。如需暂停所有用户可自由进入聊天室的权限，可通过 IM 服务端 API 关闭聊天室。

功能描述

创建聊天室后，创建者可将 valid 参数设置为 false 关闭聊天室。关闭后，调用此 API 并将 valid 参数设置为 true 可重新开放聊天室。

在开启房间的同时，可以一并设置聊天室定时关闭。

如果关闭聊天室，那么所有在线成员将被强制踢下线。

URL

httpPOST https://api.netease.im/nimserver/chatroom/toggleCloseStat.action HTTP/1.1
Content-Type:application/x-www-form-urlencoded;charset=utf-8

请求参数

• POST 请求中 Headers 的设置请参考API调用方式。

• POST 请求中 Body 的设置如下：

参数	类型	必填	说明
roomid	Long	是	聊天室 ID
operator	String	是	操作者账号，必须是创建者才可以操作如果操作者的 IM 账号被封禁，那么该操作者修改聊天室的开发/关闭状态将报错。
valid	Boolean	是	false：关闭聊天室，true：开放聊天室
delayClosePolicy	Integer	否	聊天室定时关闭方式。0：不开启定时关闭，1：固定时间关闭（不管聊天室中是否还有用户），2：空闲关闭（等聊天室中没有用户后固定时间关闭）
delaySeconds	Long	否	聊天室定时关闭时间 若设置 delayClosePolicy=1 或 2，同时未传定时时间，则采用应用默认的定时时间（7*24*3600 秒）

返回参数

参数	类型	说明
code	Integer	状态码
roomid	Long	聊天室 ID
valid	Boolean	false：聊天室关闭，true：聊天室开放
announcement	String	聊天室公告
name	String	聊天室名称
broadcasturl	String	直播地址
ext	String	扩展字段
queuelevel	Integer	队列管理权限。0：所有人都有权限变更队列，1：只有主播管理员才能操作变更
muted	Boolean	聊天室是否处于全体禁言状态，全体禁言时仅管理员和创建者可以发言，false：未禁言，ture：禁言
creator	String	聊天室创建者 ID
delayInfo	String	定时关闭信息
delayCloseEnable	Boolean	是否开启了定时关闭聊天室，true：开启，false：未开启
delayClosePolicy	Integer	聊天室定时关闭方式。0：不开启定时关闭，1：固定时间关闭，2：空闲关闭
delaySeconds	Long	聊天室定时关闭时间，最大时间（7*24*3600 秒）
status	Integer	当前状态，1：开启任务，初始状态，2：等待状态，3：任务完成状态，4：任务被取消
startTime	Long	开始时间戳

示例

cURL请求示例

curlcurl -X POST -i 'https://api.netease.im/nimserver/chatroom/toggleCloseStat.action' -H "Nonce: 12345" -H "CheckSum: bbecaa4b278bc745**0ae38b082" -H "AppKey: 2bd025c**2dcefcadb" -H "CurTime: 1666597407" -d 'roomid=1600849147&operator=test100&valid=true&delayClosePolicy=1&delaySeconds=60'

请求成功返回示例

json"Content-Type": "application/json; charset=utf-8"
{
  "code": 200,
  "desc": {
    "valid": true,
    "ext": "",
    "creator": "test100",
    "name": "test1-chatroom",
    "muted": false,
    "announcement": null,
    "broadcasturl": "xxxxxx",
    "roomid": 1600849147,
    "queuelevel": 0,
    "delayInfo": {
      "delaySeconds": 60,
      "delayCloseEnable": true,
      "startTime": 1666597407137,
      "delayClosePolicy": 1,
      "status": 2
    }
  }
}

请求失败返回示例

"Content-Type": "application/json; charset=utf-8"
{
    "code": 414, 
    "desc": "owner not register" 
}

状态码

该接口在 HTTPS Body 中返回请求的状态码，以下仅列出与接口业务相关的状态码。完整状态码请参见状态码。

状态码	说明	处理建议
200	请求成功	-
414	参数错误	根据提示信息，检查传入参数的格式和限制条件
403	禁止操作	app 没有开启/关闭聊天室的权限
419	聊天室数量超出	-
404	聊天室不存在	检查聊天室 ID
417	重复操作	已经关闭的不能再次关闭，已经打开不能再次打开
13002	聊天室无效	聊天室状态异常，请检查其状态