API 参考
在线调试

查询聊天室信息

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

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

调用频率

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

请求

URL

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

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

路径参数

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

查询参数

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

响应

Header

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

响应体参数

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

响应体示例

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,
        "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
    }
}

错误码

错误码 错误码描述 错误信息示例
200 请求成功 success
414 参数错误 parameter error
416 频率超限 rate limit exceeded
113410 聊天室服务未开通 chatroom service disabled
113404 聊天室不存在 chatroom not exist
500 服务端内部错误 internal server error
503 服务器繁忙 server busy
此文档是否对你有帮助?
有帮助
去反馈
  • 调用频率
  • 请求
  • URL
  • Header
  • 路径参数
  • 查询参数
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码