创建聊天室 - IM 即时通讯

参数名称	类型	是否必选	描述
`creator`	String	是	聊天室创建者的 IM 账号 ID。
`room_name`	String	是	聊天室名称。长度上限 128 位字符。需要通过反垃圾审核。
`announcement`	String	否	聊天室公告。长度上限 4096 位字符。需要通过反垃圾审核。
`live_url`	String	否	直播地址，长度上限 1024 位字符。
`extension`	String	否	自定义扩展字段，第三方可以跟据此属性自定义扩展，建议封装成 JSON 格式，{key:value}。长度上限 4096 位字符。需要通过反垃圾审核。
`queue_level`	Integer	否	聊天室队列管理权限。 0（默认）：所有人都有权限变更队列；1：只有管理员才能变更队列。
`delay_close_policy`	Integer	否	聊天室定时关闭方式。 0（默认）：不开启定时关闭；1：固定时间关闭（不管聊天室中是否还有用户）；2：空闲关闭（等聊天室中没有用户后固定时间关闭）。如果需要使用聊天室定时关闭功能（聊天室自动销毁机制），需要先在网易云信控制台开启（具体请参考开通和配置聊天室功能）。开启该功能后，自动销毁机制的策略可以直接通过该字段进行配置，也可以在网易云信控制台配置（优先以该参数传入的策略为准，若未传入该参数，则以控制台配置的策略为准）。仅该功能开通后创建的聊天室支持定时关闭，开通前创建的聊天室不支持定时关闭。
`delay_seconds`	Long	否	聊天室定时关闭的时间，单位秒，最大值为 7x24x3600 秒。当不开启定时关闭功能（delay_close_policy = 0）时，该参数不生效。当选择固定时间关闭或空闲关闭策略时（delay_close_policy = 1 或 2）：若该参数不为空，则以传入的定时时间为准；若未传入该参数，则以控制台的定时时间为准。
`in_out_notification`	Boolean	否	是否关闭人员进出聊天室事件通知。false：关闭；true（默认）：开启。
- `antispam_configuration`	Object	否	安全通相关配置项。
`enabled`	Boolean	否	是否开启安全通，默认为 `true`，即默认启用安全通功能。如果需要关闭安全通检测，请设置为 false。该字段只针对在网易云信控制台开通了安全通业务的应用生效。若未开启安全通业务，该字段无效。
- `business_id_map`	Array of objects	否	安全通业务列表。
`type`	Integer	是	检测类型。1：文本；2：图片。
`business_id`	String	是	安全通业务 ID，可以指定当前群组信息过安全通某个检测策略。默认情况下网易云信控制台会生成默认业务，开通安全通后，客户端不需要配置业务 ID 就能默认走该策略，若需要自定义检测策略，请提交工单联系网易云信技术支持工程师进行配置，配置好后传入对应的安全通业务 ID，表示当前群组信息过安全通的指定检测策略。

请求体示例

JSON{
  "announcement": "announcement",
  "creator": "user",
  "extension": "extension",
  "room_name": "room_name",
  "live_url": "broadcast_url",
  "queue_level": 0,
  "delay_close_policy": 0,
  "delay_seconds": 10000,
  "in_out_notification": true,
  "antispam_configuration": {
    "enabled": true,
    "business_id_map": [
      {
        "type": 1,
        "business_id": "spam_detection_1"
      },
      {
        "type": 2,
        "business_id": "image_detection_1"
      }
    ]
  }
}

响应信息

响应头参数

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

响应体参数

参数名称	类型	说明	是否必返回
`code`	Integer	状态码，200 表示请求成功。	是
`msg`	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- `data`	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
`valid`	Boolean	聊天室状态。true：开放；false：关闭。	是
`creator`	String	聊天室创建者。	是
`room_name`	String	聊天室名称。	是
`announcement`	String	聊天室公告。	否
`live_url`	String	直播地址。	否
`extension`	String	自定义扩展字段。	否
`chat_banned`	Boolean	聊天室是否处于全体禁言状态，全体禁言时仅管理员和创建者可以发言，false：未禁言，true：禁言。	是
`room_id`	Long	聊天室 ID。	是
`queue_level`	Integer	聊天室队列管理权限。0：所有人都有权限变更队列；1：只有管理员才能变更队列。	是
- `delay_info`	Object	定时关闭信息。	否
`delay_seconds`	Long	聊天室定时关闭的时间，单位秒。只有当 delay_close_policy = 1 或 2 时，该参数才生效，且最大值和默认值为 7x24x3600 秒。	否
`delay_close_enable`	Boolean	是否开启了定时关闭聊天室功能，true：开启；false：关闭。	否
`start_time`	Long	聊天室开启时间戳。	否
`delay_close_policy`	Integer	聊天室定时关闭方式。 0（默认）：不开启定时关闭；1：固定时间关闭（不管聊天室中是否还有用户）；2：空闲关闭（等聊天室中没有用户后固定时间关闭）。	否
`status`	Integer	聊天室当前状态，1：初始状态（开启任务）；2：等待状态；3：任务完成状态；4：任务被取消。	否

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
        "valid": true,
        "extension": "extension",
        "creator": "user",
        "announcement": "announcement",
        "room_name": "room_name",
        "chat_banned": false,
        "live_url": "broadcast_url",
        "room_id": 1605537148,
        "queue_level": 0,
        "delay_info": {
            "status": 2,
            "delay_seconds": 10000,
            "delay_close_enable": true,
            "start_time": 1698997692278,
            "delay_close_policy": 1
        }
    }
}

错误码

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

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
416	频率超限	rate limit exceeded
102404	用户不存在	account not exist
113410	聊天室服务未开通	chatroom service disabled
113434	聊天室数量超过限制	chatroom count limit exceeded
113451	未通过反垃圾审核	chatroom info hit antispam
500	服务端内部错误	internal server error
503	服务器繁忙	server busy

此文档是否对你有帮助？

有帮助

去反馈

功能描述
调用频率
请求信息
请求 URL
请求头参数
请求体参数
请求体示例
响应信息
响应头参数
响应体参数
响应体示例
错误码