API 参考
在线调试

创建聊天室

更新时间: 2024/07/17 17:10:03

功能描述

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

  • 聊天室功能单独开通后才能使用,具体请参见 开通和配置聊天室功能
  • 聊天室的创建只能通过服务端 API 实现,暂不支持在客户端创建。

该接口用于创建聊天室。聊天室人数无上限,默认可以自由进出(可以设置黑名单不允许进入),人员进出聊天室默认触发事件通知。

创建聊天室完成后,若需要修改进出聊天室事件的通知状态,可以参考 开启/关闭进出聊天室事件通知

调用频率

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

请求

URL

POST https://open.yunxinapi.com/im/v2/chatrooms

请求 Header 的参数说明请参见 请求 Header

请求体参数

参数名称 类型 是否必选 描述
creator String 必选 聊天室创建者的云信账号 ID。
room_name String 必选 聊天室名称。
  • 长度上限 128 位字符。
  • 需要通过反垃圾审核。
  • announcement String 可选 聊天室公告。
  • 长度上限 4096 位字符。
  • 需要通过反垃圾审核。
  • live_url String 可选 直播地址,长度上限 1024 位字符。
    extention String 可选 自定义扩展字段,第三方可以跟据此属性自定义扩展,建议封装成 JSON 格式,{key:value}。
  • 长度上限 4096 位字符。
  • 需要通过反垃圾审核。
  • queue_level Integer 可选 聊天室队列管理权限。
    0(默认):所有人都有权限变更队列;1:只有主播管理员才能变更队列。
    delay_close_policy Integer 可选 聊天室定时关闭方式。
    0(默认):不开启定时关闭;1:固定时间关闭(不管聊天室中是否还有用户);2:空闲关闭(等聊天室中没有用户后固定时间关闭)。聊天室定时关闭功能(聊天室自动销毁机制),需要在控制台先开通后才能使用,具体请参考 开通和配置聊天室功能。仅该功能开通后创建的聊天室支持定时关闭,开通前创建的聊天室不支持定时关闭。
    delay_seconds Long 可选 聊天室定时关闭的时间,单位秒。只有当 delay_close_policy = 1 或 2 时,该参数才生效,且最大值和默认值都为 7243600 秒。
    in_out_notification Boolean 可选 是否关闭人员进出聊天室事件通知。false:关闭;true(默认):开启。
    antispam_configuration Object 可选 安全通相关配置项。

    请求体示例

    json{
        "announcement": "announcement",
        "creator": "yx29",
        "extension": "extension",
        "room_name": "room_name",
        "live_url": "broadcast_url",
        "queue_level": 0,
        "delay_close_policy": 0,
        "delay_seconds": 0,
        "in_out_notification": true
    }
    

    响应

    Header

    响应 Header 的参数说明请参见 响应 Header

    响应体参数

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

    响应体示例

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

    错误码

    错误码 错误码描述 错误信息示例
    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
    • Header
    • 请求体参数
    • 请求体示例
    • 响应
    • Header
    • 响应体参数
    • 响应体示例
    • 错误码