API 参考
在线调试

更新聊天室信息

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

该接口用于更新聊天室信息,包括聊天室名称、公告、直播地址等信息。

调用频率

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

请求

URL

PATCH https://open.yunxinapi.com/im/v2/chatrooms/:{room_id}

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

路径参数

参数名称 类型 是否必选 描述
room_id Long 必选 需要更新信息的聊天室 ID,聊天室创建成功后,云信会返回聊天室 ID。

请求体参数

参数名称 类型 是否必选 描述
room_name String 可选 聊天室名称。
  • 长度上限 128 位字符。
  • 需要通过反垃圾审核。
  • announcement String 可选 聊天室公告。
  • 长度上限 4096 位字符。
  • 需要通过反垃圾审核。
  • live_url String 可选 直播地址,长度上限 1024 位字符。
    extention String 可选 自定义扩展字段,第三方可以跟据此属性自定义扩展,建议封装成 JSON 格式,{key:value}。
  • 长度上限 4096 位字符。
  • 需要通过反垃圾审核。
  • queue_level Integer 可选 聊天室队列管理权限。
    0(默认):所有人都有权限变更队列;1:只有主播管理员才能变更队列。
    notification_enabled Boolean 可选 是否发送更新聊天室通知。false(默认):不发送;true:发送。
    notification_extension String 可选 通知事件的扩展字段,长度上限 2048 位字符。
    antispam_configuration Object 可选 安全通相关配置项。

    请求体示例

    json{
        "notification_enabled": true,
        "announcement": "announcement",
        "extension": "extension",
        "room_name": "name",
        "live_url": "broadcast_url",
        "queue_level": 0,
        "notification_extension": "extension"
    }
    

    响应

    Header

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

    响应体参数

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

    响应体示例

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

    错误码

    错误码 错误码描述 错误信息示例
    200 请求成功 success
    414 参数错误 parameter error
    416 频率超限 rate limit exceeded
    113410 聊天室服务未开通 chatroom service disabled
    113307 参数与现有聊天室属性一致,无需更新 identical field values
    113404 聊天室不存在 chatroom not exist
    113406 聊天室已关闭 chatroom closed
    113451 未通过反垃圾审核 chatroom info hit antispam
    500 服务端内部错误 internal server error
    503 服务器繁忙 server busy
    此文档是否对你有帮助?
    有帮助
    去反馈
    • 调用频率
    • 请求
    • URL
    • Header
    • 路径参数
    • 请求体参数
    • 请求体示例
    • 响应
    • Header
    • 响应体参数
    • 响应体示例
    • 错误码