頻道使用者分組介面
更新時間:2026-04-09 17:41:40
該文件對應
ChannelViewerGroupController。
這是直播後台登入態介面,userId由系統根據當前登入帳號自動注入,無需前端傳入。
使用者端介面前綴:/live-bg/v3/user/channel-viewer/group
教師端介面前綴:/live-bg/v3/teacher/channel-viewer/group
1. 查詢頻道下的分組列表
- 介面位址
GET /live-bg/v3/user/channel-viewer/group/listGET /live-bg/v3/teacher/channel-viewer/group/list
- 請求參數
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| channelId | 是 | Integer | 頻道ID |
處理說明
- 如果頻道下還沒有分組,系統會自動建立 3 個預設分組:
第一小组、第二小组、第三小组
- 如果頻道下還沒有分組,系統會自動建立 3 個預設分組:
回應 data 欄位
| 參數名 | 類型 | 說明 |
|---|---|---|
| id | Long | 分組ID |
| channelId | Long | 頻道ID |
| name | String | 分組名稱 |
| viewerCount | Integer | 分組關聯的使用者數量 |
- 請求範例
GET /live-bg/v3/user/channel-viewer/group/list?channelId=123456
- 回應範例
{
"code": 200,
"status": "success",
"success": true,
"data": [
{
"id": 1,
"channelId": 123456,
"name": "第一小组",
"viewerCount": 12
},
{
"id": 2,
"channelId": 123456,
"name": "第二小组",
"viewerCount": 8
}
]
}
2. 新增頻道分組
- 介面位址
POST /live-bg/v3/user/channel-viewer/group/savePOST /live-bg/v3/teacher/channel-viewer/group/save
- 請求主體參數
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| channelId | 是 | Integer | 頻道ID |
| name | 是 | String | 分組名稱,最長 128 個字元 |
- 回應 data 欄位
| 參數名 | 類型 | 說明 |
|---|---|---|
| id | Long | 分組ID |
| channelId | Long | 頻道ID |
| name | String | 分組名稱 |
| viewerCount | Integer | 分組關聯的使用者數量,新增後預設回傳 0 |
- 請求範例
{
"channelId": 123456,
"name": "重点用户组"
}
3. 更新頻道分組
- 介面位址
POST /live-bg/v3/user/channel-viewer/group/updatePOST /live-bg/v3/teacher/channel-viewer/group/update
- 請求主體參數
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| channelId | 是 | Integer | 頻道ID |
| id | 是 | Long | 分組ID |
| name | 是 | String | 新分組名稱,最長 128 個字元 |
- 請求範例
{
"channelId": 123456,
"id": 1,
"name": "高意向用户组"
}
4. 刪除頻道分組
- 介面位址
POST /live-bg/v3/user/channel-viewer/group/deletePOST /live-bg/v3/teacher/channel-viewer/group/delete
- 請求主體參數
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| channelId | 是 | Integer | 頻道ID |
| id | 是 | Long | 分組ID |
處理說明
- 刪除分組前,系統會先將該分組下的使用者解除分組關係,不會刪除使用者本身
請求範例
{
"channelId": 123456,
"id": 1
}
