频道用户分组接口
更新时间: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
}
