保利威文档中心

帮助中心

频道用户分组配置接口

更新时间:2026-04-09 17:41:40

该文档对应 ChannelViewerGroupSettingController
这是直播后台登录态接口,userId 由系统根据当前登录账号自动注入。
用户端接口前缀:/live-bg/v3/user/channel-viewer/group-setting
教师端接口前缀:/live-bg/v3/teacher/channel-viewer/group-setting

1. 查询频道用户分组配置

  • 接口地址
    • GET /live-bg/v3/user/channel-viewer/group-setting/get
    • GET /live-bg/v3/teacher/channel-viewer/group-setting/get
  • 请求参数
参数名 必填 类型 说明
channelId Integer 频道ID
  • 响应 data 字段
参数名 类型 说明
channelViewerGroupEnabled String 频道用户分组功能开关,Y 开启,N 关闭,默认 N
notInGroupWatchEnabled String 未分组用户允许观看开关,Y 开启,N 关闭,默认 N
  • 请求示例
GET /live-bg/v3/user/channel-viewer/group-setting/get?channelId=123456
  • 响应示例
{
  "code": 200,
  "status": "success",
  "success": true,
  "data": {
    "channelViewerGroupEnabled": "Y",
    "notInGroupWatchEnabled": "N"
  }
}

2. 保存频道用户分组配置

  • 接口地址

    • POST /live-bg/v3/user/channel-viewer/group-setting/update
    • POST /live-bg/v3/teacher/channel-viewer/group-setting/update
  • 请求说明

    • channelId 通过 query 参数传入
    • 配置项通过 JSON body 传入
  • Query 参数

参数名 必填 类型 说明
channelId Integer 频道ID
  • 请求体参数
参数名 必填 类型 说明
channelViewerGroupEnabled String 频道用户分组功能开关,Y / N,默认 N
notInGroupWatchEnabled String 未分组用户允许观看开关,Y / N,默认 N
  • 请求示例
POST /live-bg/v3/user/channel-viewer/group-setting/update?channelId=123456
Content-Type: application/json
{
  "channelViewerGroupEnabled": "Y",
  "notInGroupWatchEnabled": "N"
}

通用响应说明

参数名 类型 说明
code Integer 状态码
status String 响应状态,成功为 success
success Boolean 是否成功
requestId String 请求ID
data Object 业务返回数据
error Object 失败时的错误信息
联系客服,在线咨询