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

调用频率

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

请求信息

请求 URL

PATCH https://{endpoint}/im/v2/chatrooms/{room_id}

请求 URL 中的 {endpoint} 代表服务地址域名，您可以根据用户服务区域选择中国大陆和海外服务地址，并支持搭建高可用主备域名机制。详情请参考 调用方式 服务地址章节。

请求头参数

请求 Header 的参数说明请参考 请求 Header。

路径参数

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

请求体参数

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

请求体示例

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

响应信息

响应头参数

响应 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 时，该参数才生效，且最大值为 7243600 秒。	否
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": "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
        }
    }
}

错误码

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

错误码	错误码描述	错误信息示例
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