即时通信
  1. 聊天室管理
即时通信
  • API在线调试指南
  • IM账号管理
    • 注册云信IM账号
      POST
    • 更新账号属性
      PATCH
    • 刷新 Token
      PATCH
    • 封禁账号
      PATCH
    • 更新移动端推送配置
      PATCH
    • 查询账号属性
      GET
    • 批量查询账号信息
      GET
    • 强制账号退出登录
      POST
  • 用户名片管理
    • 更新用户名片
      PATCH
    • 查询用户名片
      GET
    • 批量查询用户名片
      GET
    • 批量获取账号在线状态
      POST
  • 好友管理
    • 添加好友
      POST
    • 删除好友
      DELETE
    • 更新好友信息
      PATCH
    • 查询好友信息
      GET
    • 分页查询好友列表
      GET
    • 同意/拒绝添加好友
      POST
  • 静音管理
    • 分页查询静音列表
    • 解除静音
    • 设置静音
  • 黑名单管理
    • 列入黑名单
    • 移出黑名单
    • 分页查询黑名单列表
  • 消息管理
    • 发送消息
    • 批量发送单聊消息
    • 撤回/删除消息
    • 删除会话中漫游/历史消息
    • 发送单聊已读回执
    • 发送高级群已读回执
    • 查询群消息已读未读详情
    • 查询单条消息
    • 分页查询历史消息
    • 发送聊天室消息
    • 批量发送聊天室消息
    • 撤回/删除聊天室历史消息
    • 分页查询聊天室历史消息
    • 更新消息
    • 根据消息 ID 查询历史消息
    • 查询 Thread 消息
    • 添加快捷评论
    • 删除快捷评论
    • 查询快捷评论
    • 检索历史消息
    • 发送流式消息
  • 会话功能
    • 会话管理
      • 创建会话
      • 更新会话
      • 删除会话
      • 批量删除会话
      • 查询会话信息
      • 批量查询会话信息
      • 分页查询账号的所有会话列表
    • 会话未读数管理
      • 获取会话总未读数
    • 会话分组
      • 创建会话分组
      • 更新会话分组
      • 删除会话分组
      • 查询会话分组信息
      • 批量查询会话分组信息
      • 查询所有会话分组信息
  • 群组功能
    • 群成员
      • 拉人入群
      • 踢人出群
      • 主动退群
      • 更新群成员信息
      • 批量禁言群成员
      • 分页查询指定账号已加入的群组信息
    • 群组管理
      • 创建群组
      • 更新群组信息
      • 转让群主
      • 添加管理员
      • 移除管理员
      • 解散群组
      • 查询群组信息
      • 批量查询群组信息列表
      • 查询高级群在线成员列表
      • 批量查询高级群的在线成员数
      • 分页查询群成员列表
  • 聊天室功能
    • 聊天室管理
      • 创建聊天室
        POST
      • 获取聊天室地址
        GET
      • 查询聊天室信息
        GET
      • 更新聊天室信息
        PATCH
      • 开放/关闭聊天室
        PATCH
      • 聊天室禁言
        PATCH
      • 开启/关闭进出聊天室事件通知
        PATCH
      • 查询开放状态的聊天室
        GET
      • 分页查询聊天室在线成员列表
        GET
      • 查询聊天室固定成员列表
        GET
    • 聊天室成员
      • 设置聊天室成员角色
      • 更新聊天室在线成员信息
      • 禁言聊天室成员
      • 临时禁言聊天室成员
      • 查询聊天室的禁言列表
      • 拉黑聊天室成员
      • 聊天室标签禁言
      • 查询聊天室黑名单列表
      • 聊天室标签禁言
      • 修改聊天室在线成员标签
      • 查询标签下的在线成员数
      • 分页查询标签下的在线成员列表
      • 批量查询聊天室固定成员信息
      • 添加聊天室虚构用户
      • 删除聊天室虚构用户
      • 清空聊天室虚构用户
      • 查询聊天室虚构用户
    • 聊天室队列
      • 初始化聊天室队列
      • 删除聊天室队列
      • 更新聊天室队列
      • 查询聊天室队列元素
      • 从聊天室队列中取出元素
  • 广播消息管理
    • 发送广播消息
    • 删除广播消息
    • 查询广播消息
    • 分页查询广播消息
    • 发送聊天室全服广播消息
  • 系统通知管理
    • 发送自定义系统通知
    • 批量发送自定义系统通知
  • 发布订阅
    • 订阅在线状态事件
    • 查询在线状态事件订阅关系
    • 取消在线状态事件订阅
  • 翻译
    • 文本翻译
  1. 聊天室管理

查询聊天室信息

GET
/im/v2/chatrooms/{room_id}

请求参数

Path 参数
room_id
string 
必需
需要更新信息的聊天室 ID,聊天室创建成功后,云信会返回聊天室 ID。
示例值:
1605537145
Query 参数
need_online_user_count
string 
可选
是否需要返回聊天室的在线人数。false(默认):不返回;true:返回。
示例值:
true
online_user_count_by_type
string 
可选
是否需要根据类型显示每个端的在线用户数。false(默认):不显示;true:显示。
示例值:
true
Header 参数
AppKey
string 
必需
默认值:
{{AppKey}}
X-custom-traceid
string 
可选
默认值:
{% mock 'uuid' %}
Nonce
string 
必需
默认值:
{{Nonce}}
CurTime
string 
必需
默认值:
{{CurTime}}
CheckSum
string 
必需
默认值:
{{CheckSum}}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://open.yunxinapi.com/im/v2/chatrooms/1605537145?need_online_user_count=true&online_user_count_by_type=true' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
msg
string 
必需
data
object 
必需
valid
boolean 
必需
extension
string 
必需
creator
string 
必需
announcement
string 
必需
room_name
string 
必需
chat_banned
boolean 
必需
live_url
string 
必需
room_id
integer 
必需
queue_level
integer 
必需
in_out_notification
integer 
必需
cdn_message_enable
boolean 
必需
online_user_count
integer 
必需
ios_online_user_count
integer 
必需
android_online_user_count
integer 
必需
pc_online_user_count
integer 
必需
web_online_user_count
integer 
必需
mac_online_user_count
integer 
必需
示例
{"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":1605537145,"queue_level":0,"in_out_notification":1,"cdn_message_enable":false,"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}}
上一页
获取聊天室地址
下一页
更新聊天室信息
Built with