← 返回 Broadcast API 列表

获取广播频道信息

在 GitHub 上查看源码

POST /api/broadcast/getChannelInfo

描述

获取指定名称的广播频道的信息,主要是频道的名称和当前连接到该频道的 WebSocket 会话数量。

请求参数

请求体需要是 JSON 格式。

参数名 类型 描述 必需
name string 要查询的广播频道名称。

响应结果

响应体是 JSON 格式。code 为 0 表示成功,非 0 表示失败(例如频道不存在)。data 包含频道信息。


{
  "code": 0,
  "msg": "",
  "data": {
    "channel": {
      "name": "my-channel", // 频道名称
      "count": 2          // 当前连接数
    }
  }
}
    

注意:这是一个社区维护的文档,可能与官方最新版本存在差异。

如果您觉得本文档有帮助,可以考虑赞助支持:爱发电

在线测试