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

调用频率

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

请求信息

请求 URL

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

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

请求头参数

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

请求路径参数

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

请求查询参数

参数名称	类型	是否必选	描述
need_online_user_count	Boolean	否	是否需要返回聊天室的在线人数。false（默认）：不返回。true：返回。
online_user_count_by_type	Boolean	否	是否需要根据类型显示每个端的在线用户数。false（默认）：不显示。true：显示。

响应信息

响应头参数

响应 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	延迟消息相关信息。	否
status	Integer	延迟消息状态。	否
delay_seconds	Long	延迟秒数。	否
delay_close_enable	Boolean	是否启用延迟关闭。	否
start_time	Long	开始时间戳。	否
delay_close_policy	Integer	延迟关闭策略。	否
in_out_notification	Integer	是否关闭人员进出聊天室事件通知，0：关闭。1：开启。	否
cdn_message_enable	Boolean	是否开通 CDN 消息。true：开通。false：不开通。	否
online_user_count	Long	在线用户数。	否
ios_online_user_count	Long	iOS 端在线人数	否
android_online_user_count	Long	Android 端在线人数	否
pc_online_user_count	Long	PC 端在线人数	否
web_online_user_count	Long	Web 端在线人数	否
mac_online_user_count	Long	Mac 端在线人数	否
harmony_online_user_count	Long	鸿蒙端在线人数	否

响应体示例

JSON{
    "code": 200,
    "msg": "success",
    "data": {
        "valid": true,
        "extension": "extension",
        "creator": "yx3",
        "announcement": "announcement",
        "room_name": "room_name",
        "chat_banned": false,
        "live_url": "broadcast_url",
        "room_id": 1603669051,
        "queue_level": 0,
        "delay_info": {
            "status": 2,
            "delay_seconds": 2000,
            "delay_close_enable": true,
            "start_time": 1752740866910,
            "delay_close_policy": 1
        },
        "in_out_notification": 1,
        "online_user_count": 0,
        "ios_online_user_count": 0,
        "android_online_user_count": 0,
        "pc_online_user_count": 0,
        "web_online_user_count": 0,
        "mac_online_user_count": 0,
        "harmony_online_user_count": 0
    }
}

错误码

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

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
416	频率超限	rate limit exceeded
113410	聊天室服务未开通	chatroom service disabled
113404	聊天室不存在	chatroom not exist
500	服务端内部错误	internal server error
503	服务器繁忙	server busy