保利威文档中心

幫助中心

頻道使用者分組設定介面

更新時間: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 失敗時的錯誤資訊
联系客服,在线咨询