开发者中心

# 查询在线频道信息

# 1 查询用户状态

该方法查询某个用户是否在指定频道中，以及该用户在该频道中的角色等状态。

接口地址 方法 说明
BaseUrl/api/v1/channel/user/property/{appId}/{uid}/{channelName} GET 查询用户状态

PathVariable：

参数 描述
appId 必填，控制台中项目的APP ID（应用标识ID）
uid 必填，用户id
channelName 必填，channel名称

响应数据：

实例：
[GET] https://192.168.2.251/client/api/v1/channel/user/property/6030db678613f149de55d2a7/1234/channel1
响应：
{
  "success": true,
  "data": {
    "join": 1592289039,//in_channel为true时，有此字段
    "in_channel": true,
    "role": "presenter"
  }
}

# 2 获取用户列表

该方法获取指定频道内的用户列表：

  • 通信场景下，返回频道内的用户列表。
  • 直播场景下，返回频道内的主播列表和观众列表。

注意事项：

  • 同一频道内的用户必须使用相同的频道场景。否则，查询结果可能不准确。
  • 本方法和[查询用户状态]方法均能用于同步在线频道状态信息。相比查询用户状态方法，获取用户列表方法所需的调用频率低，查询效率高。因此，更推荐使用获取用户列表方法。
接口地址 方法 说明
BaseUrl/api/v1/channel/user/{appId}/{channelName} GET 获取用户列表

PathVariable：

参数 描述
appId 必填，控制台中项目的APP ID（应用标识ID）
channelName 必填，channel名称

响应数据：

实例：
[GET] https://192.168.2.251/client/api/v1/channel/user/6030db678613f149de55d2a7/channel1
响应：
{
  "success": true,
  "data": {
    "channel_exist": true,
    "mode": 1,
    "total": 1,
    "users": [
      "<uid>"
    ]
  }
}

# 3 分页查询项目的频道列表

接口地址 方法 说明
BaseUrl/api/v1/channel/{appId} GET 分页查询项目的频道列表

PathVariable：

参数 描述
appId 必填，控制台中项目的APP ID（应用标识ID）

PathVariable：

参数 描述
pageNo 第N页，默认1
pageSize 每页N条记录，默认10

响应数据：

实例：
[GET] https://192.168.2.251/client/api/v1/channel/6030db678613f149de55d2a7?pageNo=1&pageSize=100
响应：
{
  "success": true,
  "data": {
    "channels": [
      {
        "channel_name": "lkj144",
        "user_count": 3
      }
    ],
    "total_size": 3
  }
}

← 频道 →