頻道所屬使用者列表介面
更新時間:2026-04-15 11:51:47
此文件對應
live-background-aggregate的ChannelViewerListController。
這是直播後台登入態介面,userId由系統根據目前登入帳號自動注入。
使用者端介面前綴:/live-bg/v3/user/channel-viewer/list
教師端介面前綴:/live-bg/v3/teacher/channel-viewer/list
1. 分頁查詢頻道所屬使用者列表
- 介面位址
GET /live-bg/v3/user/channel-viewer/list/listGET /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/exportGET /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/savePOST /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/deletePOST /live-bg/v3/teacher/channel-viewer/list/delete
- 請求體參數
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| channelId | 是 | Integer | 頻道ID |
| viewerIds | 是 | Array |
待刪除觀眾ID列表,最多 1000 個 |
5. 批次轉移頻道所屬使用者到指定分組
- 介面位址
POST /live-bg/v3/user/channel-viewer/list/transferPOST /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/importPOST /live-bg/v3/teacher/channel-viewer/list/import
請求方式
multipart/form-data
表單參數
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| channelId | 是 | Integer | 頻道ID |
| groupId | 否 | Long | 目標分組ID |
| file | 是 | File | Excel 檔案 |
匯入模板說明
- Excel 第 1 列表頭為:
用户手机号
- 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 | 失敗時的錯誤資訊 |
