设置活动观看页风格
1. 接口描述
接口名称:
/eventopenapi/event/settings/showstyle/update
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
token | String | 是 | 统一鉴权token |
eventId | Long | 是 | 直播会议ID |
pageType | Int | 是 | 页面类型 1: 移动端; 2: 电脑端 |
logo | String | 否 | 企业Logo图片地址 |
advImgUrl | String | 否 | 广告挂件图片地址 |
advLinkUrl | String | 否 | 广告挂件链接地址 |
advConfig | JSON | 否 | 广告挂件配置项 |
pageStyle | Int | 否 | 页面风格 1: 沉浸式; 2: 互动式(电脑端只支持互动式页面风格),默认值1 |
panels | Json | 否 | 菜单管理面板数据 |
theme | Json | 否 | 页面主题 |
panels 参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
id | String | 是 | 菜单ID chat: 聊天室; summary: 活动简介; qa: 文字提问; replay: 回放; text: 自定义图文; link: 推广外链 |
title | String | 是 | 菜单标题 |
value | String | 否 | 菜单值(只在菜单ID为text, link时有效) |
configs | Json | 否 | 菜单配置(只在菜单ID为chat时有效) |
configs 参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
like | Boolean | 否 | 是否显示点赞功能 true: 是; false: 否 |
likeNum | String | 否 | 默认点赞数 |
raiseHand | Boolean | 否 | 是否举手 true: 是; false: 否 |
share | Boolean | 否 | 是否显示分享功能 true: 是; false: 否 |
theme 参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
background | Json | 否 | 背景图 |
btnColor | Json | 否 | 按钮颜色 |
background 参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
value | String | 是 | 背景图(系统支持)pro: 专业; annual: 年会; rec: 娱乐; edu: 教育; black: 极简黑; gray: 极简灰; white: 极简白; custom: 自定义 |
url | String | 否 | 图片地址(如果value为custom,需要提供url地址; 如果是系统支持的值, url值系统会自动设置; 如果value值非法,则系统自动将value值修正为pro) |
btnColor 参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
value | String | 是 | 按按钮颜色 (系统支持) blue, red, purple, green, brown |
advConfig 参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
position | String | 否 | 广告挂件显示位置, 对应的值: leftTop, leftBottom, leftCenter, rightTop, rightBottom, rightCenter |
duration | Int(秒) | 否 | 广告挂件显示时长, 对应的值: 0, 30, 60 |
device | Array | 否 | 广告挂件显示终端, 对应的值: h5, pc, appsdk, mini, tv, 例如 ["pc","h5"] |
3. 输出参数
参数 | 类型 | 说明 |
---|---|---|
timeStamp | Long | 返回时间(时间戳,单位毫秒) |
requestId | String | 请求ID(在接口异常时, 需提供请求ID) |
code | Int | 返回的状态码 |
msg | String | 当返回结果的状态码不为200时,包含的错误信息 |
data | Json | 返回数据 |
4. 示例
输入示例
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"eventId": 551603,
"pageType": 1,
"advImgUrl": "http://www.people.com.cn/mediafile/pic/20190918/49/14020623284258866277.jpg",
"advLinkUrl": "http://www.quanshi.com",
"logo": "http://src.sotu114.com/data/attachment/forum/202006/03/234018ly6p16zihresr2y5.item.jpg-ture",
"pageStyle": 1,
"panels": [
{
"id": "chat",
"title": "chat",
"value": null,
"configs": {
"raiseHand": false,
"like": false,
"likeNum": "222",
"share": false
}
},
{
"id": "summary",
"title": "Summary"
},
{
"id": "qa",
"title": "问答"
},
{
"id": "replay",
"title": "回放"
},
{
"id": "text",
"title": "自定义",
"value": "cccaaa"
},
{
"id": "link",
"title": "外部连接",
"value": "http://www.baidu.com"
}
],
"theme": {
"background": {
"value": "pro"
},
"btnColor": {
"value": "blue"
}
},
"advConfig": {
"position": "leftBottom",
"duration":30,
"device":["pc","h5"]
}
}
输出示例
{
"timeStamp": 1645769071665,
"code": 200,
"msg": "Successfully to update the event showstyle settings!",
"data": null,
"requestId": "10.255.0.106_20220225_140430_1645769070869"
}