查看活动观看页风格

1. 接口描述

接口名称:

/eventopenapi/event/settings/showstyle

发送方式:

POST

参数格式:

accept: application/json;content-type: application/json

2. 输入参数

参数 类型 必须 说明
token String 统一鉴权token
eventId Long 直播会议ID
pageType Int 页面类型 1: 移动端; 2: 电脑端, 默认值1

3. 输出参数

参数 类型 说明
timeStamp Long 返回时间(时间戳,单位毫秒)
requestId String 请求ID(在接口异常时, 需提供请求ID)
code Int 返回的状态码
msg String 当返回结果的状态码不为200时,包含的错误信息
data Json 返回数据

data 参数说明

参数 类型 说明
eventId Long 直播会议ID
pageType Int 页面类型 1: 移动端; 2: 电脑端
logo String 企业Logo图片地址
advImgUrl String 广告挂件图片地址
advLinkUrl String 广告挂件链接地址
pageStyle Int 页面风格 1: 沉浸式; 2: 互动式(电脑端只支持互动式页面风格)
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 图片地址

btnColor 参数说明

参数 类型 说明
value String 按钮颜色 (系统支持) blue, red, purple, green, brown
color String 颜色色值

4. 示例

输入示例

{
    "token":"5d41c4ac806c6440eb6aa8e071115f2b",
    "eventId": 554410,
    "pageType": 1
}

输出示例

{
  "timeStamp": 1646993026777,
  "code": 200,
  "msg": "Successfully to get the event showstyle settings!",
  "data": {
    "eventId": 554410,
    "advLinkUrl": "https://www.quanshi.com",
    "pageType": 1,
    "pageStyle": 2,
    "panels": [
      {
        "id": "chat",
        "title": "chat",
        "value": null,
        "configs": {
          "like": false,
          "likeNum": "222",
          "raiseHand": false,
          "share": false
        }
      },
      {
        "id": "summary",
        "title": "Summary",
        "value": null,
        "configs": null
      },
      {
        "id": "qa",
        "title": "问答",
        "value": null,
        "configs": null
      },
      {
        "id": "replay",
        "title": "回放",
        "value": null,
        "configs": null
      },
      {
        "id": "text",
        "title": "自定义",
        "value": "cccaaa",
        "configs": null
      },
      {
        "id": "link",
        "title": "外部连接",
        "value": "https://www.bing.com/",
        "configs": null
      }
    ],
    "logo": "https://t7.baidu.com/it/u=2168645659,3174029352&fm=193&f=GIF",
    "theme": {
      "background": {
        "value": "pro",
        "url": "https://dle.quanshi.com/onemeeting/download/liveapp/theme_bg_blue.jpg"
      },
      "btnColor": {
        "value": "red",
        "color": "#DC2D20"
      }
    },
    "advImgUrl": "http://tse1-mm.cn.bing.net/th/id/OIP-C.EvB94aIKAm7Z-if6pqI24QHaEL?pid=ImgDet&rs=1"
  },
  "requestId": "10.255.0.106_20220311_180346_1646993026562"
}