网易云信 IM 聊天室采用多层架构设计，可以实现真正意义上的大型聊天室，参与人数无上限，又可满足消息到达的实时性要求，主要应用于娱乐直播、教育直播等场景。

• 聊天室是一项付费拓展能力，需要在选购 IM 基础功能的情况下增购。
• 网易云信 IM 仅在服务端支持创建聊天室。

功能描述

用户可以在服务端创建聊天室，聊天室人数无上限，默认可以自由进出（可以设置黑名单不允许进入），人员进出聊天室默认触发事件通知。

创建聊天室时，可设置开启或关闭人员进出聊天室的事件通知，默认开启。创建聊天室完成后，若需要修改进出聊天室事件的通知状态，可以参考开启/关闭进出聊天室事件通知。

URL

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

请求参数

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

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

参数	类型	必填	说明
creator	String	是	聊天室属主的 IM 账号（accid），最大长度 32 字符
name	String	是	聊天室名称，最大长度 128 字符
announcement	String	否	聊天室公告，最大长度 4096 字符
broadcasturl	String	否	直播地址，最大长度 1024 字符
ext	String	否	扩展字段，最大长度 4096 字符
queuelevel	Integer	否	队列管理权限。0：所有人都有权限变更队列，1：只有主播管理员才能操作变更。默认 0
bid	String	否	反垃圾业务 ID，JSON 字符串，{"textbid":"","picbid":""}，若不填则使用原来的反垃圾配置
delayClosePolicy	Integer	否	聊天室定时关闭方式。0：不开启定时关闭，1：固定时间关闭（不管聊天室中是否还有用户），2：空闲关闭（等聊天室中没有用户后固定时间关闭） 聊天室定时关闭功能，需要先开通后才能使用。如未开通，请先联系商务经理或技术支持开通该功能。 仅该功能开通后创建的聊天室支持定制关闭。开通前创建的聊天室不支持定时关闭。
delaySeconds	Long	否	聊天室定时关闭时间 若设置 delayClosePolicy=1 或 2，同时未传定时时间，则采用应用默认的定时时间（7*24*3600 秒）
inOutNotification	Integer	否	是否关闭人员进出聊天室事件通知 0：关闭；1：开启（默认）

返回参数

参数	类型	说明
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）

curl -X POST -i 'https://api.netease.im/nimserver/chatroom/create.action' -H "Nonce: 12345" -H "CheckSum: eaaf8dc8d**cefa8ce3ccf73" -H "AppKey: 2bd025c57731**efcadb" -H "CurTime: 1666595100" -d 'creator=test100&name=test1-chatroom&delayClosePolicy=1&delaySeconds=180&announcement=&broadcasturl=xxxxxx'

请求成功返回示例

"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": 1600849145,
    "queuelevel": 0,
    "delayInfo": {
      "delaySeconds": 180,
      "delayCloseEnable": true,
      "startTime": 1666595100158,
      "delayClosePolicy": 1,
      "status": 2
      }
    }
}

请求失败返回示例

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

状态码

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

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