网易云信 IM 支持通过设置聊天室定时关闭方式来自动关闭聊天室。

用户可在创建聊天室时设置定时关闭，也可以调用本文介绍的接口来设置聊天室定时关闭。

功能描述

目前聊天室定时关闭的方式包括以下两种：

• 固定时间后关闭（delayClosePolicy = 1）：创建聊天室后 N 小时，直接自动关闭，不管聊天室中是否还有用户。
• 空闲后固定时间关闭（delayClosePolicy = 2）：等聊天室中没有用户存在后 N 小时，自动关闭聊天室。

• 上述的 N 小时，通过 API 中的 delaySeconds 参数来定义，但是单位不同，参数中以秒为单位，请注意换算。
• 定时关闭不保证实时性（一般是实时的），可能会存在些许误差。

调用该接口即视为需要修改/创建聊天室定时关闭方式，调用成功后，从当前时间重新开始计算。

前提条件

• 聊天室定时关闭功能，需要先开通后才能使用。如未开通，请先登录云信控制台开通聊天室自动销毁机制功能，具体请参考开通和配置聊天室功能。
• 仅该功能开通后创建的聊天室支持定时关闭。开通前创建的聊天室不支持定时关闭。

URL

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

请求参数

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

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

参数	类型	必填	说明
roomid	Long	是	聊天室 ID
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：未禁言，true：禁言
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/updateDelayClosePolicy.action' -H "Nonce: 12345" -H "CheckSum: 54871a1f9a695bba5**7e6423c87fa728" -H "AppKey: 2bd025c577313e**d2dcefcadb" -H "CurTime: 1666597250" -d 'roomid=1600849147&delayClosePolicy=2&delaySeconds=60'

请求成功返回示例

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

请求失败返回示例

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

状态码

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

状态码	说明	处理建议
200	请求成功	-
414	参数错误	根据提示信息，检查传入参数的格式和限制条件
403	禁止操作	聊天室名称等违规，未过审核或者未开启聊天室权限
404	聊天室不存在	检查聊天室 ID
419	聊天室数量超出	-
13009	未开启聊天室定时关闭（聊天室自动销毁）功能	建议开启聊天室定时关闭功能（聊天室自动销毁）
13002	聊天室已经关闭	建议开启或者重新创建聊天室