保利威文档中心

帮助中心

频道所属用户列表接口

更新时间:2026-04-15 11:51:47

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

1. 分页查询频道所属用户列表

  • 接口地址
    • GET /live-bg/v3/user/channel-viewer/list/list
    • GET /live-bg/v3/teacher/channel-viewer/list/list
  • 请求参数
参数名 必填 类型 说明
channelId Integer 频道ID
groupId Long 分组ID
viewerId String 观众ID,最长 64 字符
nickname String 用户昵称,最长 128 字符
mobile String 手机号,最长 32 字符
pageNumber Integer 页码,默认 1
pageSize Integer 每页大小,默认 10,最大 1000
  • 查询说明

    • 支持按分组ID、用户昵称、用户ID、手机号组合查询
    • 查询结果会关联用户体系,返回用户昵称、手机号和分组名称
  • 响应 data 字段

参数名 类型 说明
pageNumber Integer 当前页码
pageSize Integer 每页大小
totalPages Long 总页数
totalItems Long 总记录数
contents Array 列表数据

contents 数组元素说明:

参数名 类型 说明
id Long 主键ID
channelId Long 频道ID
viewerId String 观众ID
groupId Long 分组ID
groupName String 分组名称
nickname String 用户昵称
wxAvatar String 微信头像
qwAvatar String 企微头像
mobile String 手机号
  • 请求示例
GET /live-bg/v3/user/channel-viewer/list/list?channelId=123456&groupId=1&nickname=张三&pageNumber=1&pageSize=20

2. 导出频道所属用户列表

  • 接口地址
    • GET /live-bg/v3/user/channel-viewer/list/export
    • GET /live-bg/v3/teacher/channel-viewer/list/export
  • 请求参数
参数名 必填 类型 说明
channelId Integer 频道ID
groupId Long 分组ID
viewerId String 观众ID
nickname String 用户昵称
mobile String 手机号
  • 处理说明

    • 导出接口不分页
    • 返回值 data 为导出任务ID,可结合导出任务查询接口查看进度和下载结果
  • 请求示例

GET /live-bg/v3/user/channel-viewer/list/export?channelId=123456&groupId=1

3. 新增频道所属用户

  • 接口地址
    • POST /live-bg/v3/user/channel-viewer/list/save
    • POST /live-bg/v3/teacher/channel-viewer/list/save
  • 请求体参数
参数名 必填 类型 说明
channelId Integer 频道ID
groupId Long 分组ID
viewerIds Array 观众ID列表,不能为空,最多 1000 个
  • 处理说明

    • 已存在的观众不会重复新增
    • 如果传了 groupId,已存在的观众会被更新到该分组
  • 请求示例

{
  "channelId": 123456,
  "groupId": 1,
  "viewerIds": [
    "viewer-a",
    "viewer-b"
  ]
}

4. 删除频道所属用户

  • 接口地址
    • POST /live-bg/v3/user/channel-viewer/list/delete
    • POST /live-bg/v3/teacher/channel-viewer/list/delete
  • 请求体参数
参数名 必填 类型 说明
channelId Integer 频道ID
viewerIds Array 待删除观众ID列表,最多 1000 个

5. 批量转移频道所属用户到指定分组

  • 接口地址
    • POST /live-bg/v3/user/channel-viewer/list/transfer
    • POST /live-bg/v3/teacher/channel-viewer/list/transfer
  • 请求体参数
参数名 必填 类型 说明
channelId Integer 频道ID
targetGroupId Long 目标分组ID,如果不传就是将对应的分组清空
viewerIds Array 观众ID列表,最多 1000 个

6. 导入频道所属用户

  • 接口地址

    • POST /live-bg/v3/user/channel-viewer/list/import
    • POST /live-bg/v3/teacher/channel-viewer/list/import
  • 请求方式

    • multipart/form-data
  • 表单参数

参数名 必填 类型 说明
channelId Integer 频道ID
groupId Long 目标分组ID
file File Excel 文件
  • 导入模板说明

    • Excel 第 1 列表头为:用户手机号
  • 响应 data 字段

参数名 类型 说明
successCount Integer 成功数量
failCount Integer 失败数量
failFileUrl String 失败明细文件地址,失败时可能返回
  • 请求示例
curl -X POST 'https://live.polyv.net/live-bg/v3/user/channel-viewer/list/import?channelId=123456&groupId=1' \
  -F 'file=@/tmp/viewer-import.xlsx'

通用响应说明

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