功能配置

接口说明

本接口用于配置账号维度或活动维度观看页功能开关配置。

请求方式

POST

请求地址

/v3/users/permission/edit-webinar-config

请求头

Content-Type : application/x-www-form-urlencoded

公共参数

关于公共请求参数详细内容，请参考公共参数。

核心逻辑介绍

维度控制（前置依赖）

注意事项 : 接口有一个全局控制逻辑：只有当「功能配置」的总开关开启时，单活动配置才会生效；否则默认使用账号下的全局配置。

开启方式：通过 permission_key = is_function_cofig 先设置总开关状态。

生效规则：

status=0：使用账号维度配置（全局生效）

status=1：使用活动维度配置（单活动独立设置）

调用规则

每次请求仅支持配置 1 个功能开关（通过 permission_key 指定）。

账号维度配置：不传 webinar_id，修改的是全局默认配置。

活动维度配置：必须传入 webinar_id，修改的是单活动独立配置。

请求频率限制：单用户请求频率限制为 120 次/分钟，如果频率超出限制，请参考API调用频率限制说明

活动维度总开关设置

必须先调用该接口开启/关闭功能配置的维度，后续单功能配置才会按预期生效。

请求参数

参数	类型	是否必选	示例值	描述
permission_key	string	是	`is_function_cofig`	功能配置总开关
webinar_id	integer	否	335406275	不传活动ID，则启用账号维度
status	integer	是	1	`0=使用账号配置`,`1=使用活动配置`

参数	类型	是否必选	示例值	描述
permission_key	string	是	`is_player_cofig`	防录屏设置/播放器设置总开关
webinar_id	integer	否	335406275	不传活动ID，则启用账号维度
status	integer	是	1	`0=使用账号配置`,`1=使用活动配置`

单功能开关

以下所有功能开关，均通过同一接口地址调用，仅需修改 permission_key 的值即可。

请求参数

参数	类型	是否必选	示例值	描述
permission_key	string	是	`ui.hide_like`	要配置的功能标识，见下表
webinar_id	integer	否	335406275	活动ID，仅当总开关为`status=1`时有效，不传则修改账号全局配置
status	integer	是	1	开关状态：`0=关闭`，`1=开启`（仅基础开关类型使用，特殊类型见说明）

功能开关清单

permission_key	功能名称	配置说明	参数特殊说明
`#`	打赏功能	合规原因，该功能暂不支持使用	-
`ui.watch_hide_like`	点赞功能	开启后，观看页显示点赞功能	-
`ui.hidden_watch_like_data`	隐藏点赞数据	用于控制观看页是否展示点赞数。开启后，用户仍可进行点赞操作，但点赞数量将被隐藏（仅在已开启点赞功能时生效）	-
`ui.hide_gifts`	礼物功能	开启后，观看页显示礼物功能	-
`ui.watch_hide_share`	分享功能	开启后，观看页显示分享功能（包含微信内分享）	-
`#`	微信观看	已开启，观众只能在微信环境内观看直播	暂不支持openApi使用
`#`	仅PC观看	已开启，观众只能在PC浏览器内观看活动	暂不支持openApi使用
`#`	举报反馈	PC/手机观看页举报入口显示	举报反馈不允许关闭
`wap_hidden_webinar_title`	手机活动标题	已开启，手机观看端「简介」tab下不展示标题信息	-
`#`	清屏功能	已开启，手机竖屏观看模式，观众点击屏幕可清除聊天、商品等信息	暂不支持openApi使用
`ui.dialog_position`	弹窗位置	设置问卷及快问快答在PC观看端展示位置	status : `0=居中`,`1=靠右`
`welcome_message`	访问特效	已开启，观众进入直播间时在聊天区显示欢迎消息，活跃氛围	不使用`status`，改用`value`
`#`	隐藏菜单	已开启，PC观看端不展示自定义菜单区域(使用文档/白板功能，请不要将菜单隐藏，否则将看不到视频画面)	暂不支持openApi使用
`#`	活动状态	已开启，观看端展示活动状态标签和直播模式标签	暂不支持openApi使用
`watch_duration`	观看时长	已开启，观看端展示活动状态标签和直播模式标签	控制观看页观看时长显示，需传入配置对象不使用`status`，改用`value`
`ui.watch_record_no_chatting`	回放禁言	开启后，回放/点播不支持聊天	-
`ui.watch_record_chapter`	回放章节	开启后，回放/点播观看端显示文档章节	-
`record_watch_expire`	回放有效期	开启后，设置观看回放视频的有效期，到期后观众无法观看回放视频	该配置仅支持在活动下 , 不支持账号维度 , 不使用`status`，改用`value`

访问特效配置

该功能不使用 status，而是通过 value 传入 JSON 字符串格式的完整配置。

请求参数

参数	类型	是否必选	示例值	描述
permission_key	string	是	`welcome_message`	固定值
webinar_id	integer	否	335406275	活动ID，规则同上
value	string	是	`{"status":1,"message":"欢迎{user_nickname}进入直播间"}`	JSON字符串格式的配置，字段说明见下表

value 字段说明

参数名称	参数类型	是否必须	示例	备注
status	integer	是	1	是否显示：`0=不显示`，`1=显示`
message	string	是	欢迎 `昵称` 进入	昵称不可编辑（可编辑字体长度不得 > 10 个汉字）

观看时长配置

该功能不使用 status，而是通过 value 传入 JSON 字符串格式的完整配置。

请求参数

参数	类型	是否必选	示例值	描述
permission_key	string	是	`watch_duration`	固定值
webinar_id	integer	否	335406275	活动ID，规则同上
value	string	是	`{"status": 1,"type": 2,"duration": 1,"prompt_type": 0}`	JSON字符串格式的配置，字段说明见下表

value 字段说明

参数名称	参数类型	是否必须	示例	备注
status	integer	是	1	是否显示：`0=不显示`，`1=显示`
type	integer	是	2	显示方式：`1=正计时`，`2=倒计时`
duration	integer	是	30	倒计时时长（单位：分钟）
prompt_type	integer	否	0	弹窗提示：`0=无提示`，`1=有弹窗提示`

回放有效期配置

该功能不使用 status，而是通过 value 传入 JSON 字符串格式的完整配置。

请求参数

参数名	类型	是否必填	示例值	描述
permission_key	string	是	`record_watch_expire`	固定值
webinar_id	integer	否	335406275	活动 ID
value	string	是	见下方示例	JSON 字符串格式的配置

value 字段说明

参数名	类型	是否必填	示例值	描述
status	integer	是	1	配置是否启用：`0=关闭`，`1=开启`
type	integer	是	1 / 2	生效方式：`1=全天`，`2=部分时段`
start_date	string	是	见下方说明	生效日期或时间
end_date	string	是	见下方说明	结束日期或时间
start_time	string	是	"" 或 12:00:00	时段开始时间
end_time	string	是	"" 或 18:00:00	时段结束时间

字段详细说明

type = 1（全天）

start_date / end_date 必须传完整时间

格式：YYYY-MM-DD HH:mm:ss

示例：2026-04-23 00:00:00

start_time / end_time 必须传空字符串

"start_time": ""

"end_time": ""

注意：此模式下时间字段仅作为占位，不允许传具体时分秒。

type = 2（部分时段）

start_date / end_date 只传日期

格式：YYYY-MM-DD

start_time / end_time 必须传具体时间

格式：HH:mm:ss

示例：

"start_time": "12:00:00"

"end_time": "18:00:00"

注意：日期与时间必须分开传递，不可混用。

示例 1：全天（type = 1）

{"status": 1,"type": 1,"start_date": "2026-04-23 00:00:00","end_date": "2026-04-24 23:59:59","start_time": "","end_time": ""}

示例 2：部分时段（type = 2）

{"status": 1,"type": 2,"start_date": "2026-04-23","end_date": "2026-04-25","start_time": "12:00:00","end_time": "18:00:00"}

响应参数

参数	类型	示例值	描述
code	int	200	状态码
msg	string	""	提示信息，空字符串表示成功
data	object	{}	返回数据对象（当前为空）
request_id	string	`3056b2f0-320c-11f0-a4f8-97921b68a98c`	请求唯一标识符，用于排查问题

响应示例

{
	"code": 200,
	"msg": "",
	"data": {},
	"request_id": "3056b2f0-320c-11f0-a4f8-97921b68a98c"
}

接口说明#

请求方式#

请求地址#

请求头#

公共参数#

核心逻辑介绍#

活动维度总开关设置#

请求参数#

单功能开关#

请求参数#

功能开关清单#

访问特效配置#

请求参数#

value 字段说明#

观看时长配置#

请求参数#

value 字段说明#

回放有效期配置#

请求参数#

value 字段说明#

字段详细说明#

响应参数#

响应示例#

接口说明

请求方式

请求地址

请求头

公共参数

核心逻辑介绍

活动维度总开关设置

请求参数

单功能开关

请求参数

功能开关清单

访问特效配置

请求参数

value 字段说明

观看时长配置

请求参数

value 字段说明

回放有效期配置

请求参数

value 字段说明

字段详细说明

响应参数

响应示例