Channel User Group Configuration API

Updated: 2026-04-09 17:41:40

This document corresponds to ChannelViewerGroupSettingController.
This is a live streaming backend login-required API. userId is automatically injected by the system based on the current logged-in account.
User-side API prefix: /live-bg/v3/user/channel-viewer/group-setting
Teacher-side API prefix: /live-bg/v3/teacher/channel-viewer/group-setting

1. Query Channel User Group Configuration

Endpoint
- GET /live-bg/v3/user/channel-viewer/group-setting/get
- GET /live-bg/v3/teacher/channel-viewer/group-setting/get
Request Parameters

Parameter	Required	Type	Description
channelId	Yes	Integer	Channel ID

Response data Fields

Parameter	Type	Description
channelViewerGroupEnabled	String	Channel user group feature toggle, `Y` enabled, `N` disabled, default `N`
notInGroupWatchEnabled	String	Allow ungrouped users to watch toggle, `Y` enabled, `N` disabled, default `N`

Request Example

GET /live-bg/v3/user/channel-viewer/group-setting/get?channelId=123456

Response Example

{
  "code": 200,
  "status": "success",
  "success": true,
  "data": {
    "channelViewerGroupEnabled": "Y",
    "notInGroupWatchEnabled": "N"
  }
}

2. Save Channel User Group Configuration

Endpoint
- POST /live-bg/v3/user/channel-viewer/group-setting/update
- POST /live-bg/v3/teacher/channel-viewer/group-setting/update
Request Description
- channelId is passed via query parameters
- Configuration items are passed via JSON body
Query Parameters

Parameter	Required	Type	Description
channelId	Yes	Integer	Channel ID

Request Body Parameters

Parameter	Required	Type	Description
channelViewerGroupEnabled	No	String	Channel user group feature toggle, `Y` / `N`, default `N`
notInGroupWatchEnabled	No	String	Allow ungrouped users to watch toggle, `Y` / `N`, default `N`

Request Example

POST /live-bg/v3/user/channel-viewer/group-setting/update?channelId=123456
Content-Type: application/json

{
  "channelViewerGroupEnabled": "Y",
  "notInGroupWatchEnabled": "N"
}

General Response Description

Parameter	Type	Description
code	Integer	Status code
status	String	Response status, success is `success`
success	Boolean	Whether the request was successful
requestId	String	Request ID
data	Object	Business response data
error	Object	Error information on failure

Live Streaming Server API

Channel User Group Configuration API

1. Query Channel User Group Configuration

2. Save Channel User Group Configuration

General Response Description