云直播会议设置
云直播会议设置接口,为用户提供了设置会议级白名单、修改会议属性的功能。用户可以在预约完会议后,对会议的某些属性值进行调整,从而更加灵活的控制会议的运行效果。云直播为用户提供了丰富的会议属性项,用户可以控制直播风格、直播限制、公告内容、回放时效等,具体可以详见会议设置接口说明
查看会议设置
1. 接口描述
接口名称:
/eventopenapi/event/settings
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
| 参数 | 类型 | 必须 | 说明 | 
|---|---|---|---|
| token | String | 是 | 统一鉴权token | 
| eventId | Long | 是 | 直播会议ID | 
3. 输出参数
| 参数 | 类型 | 说明 | 
|---|---|---|
| timeStamp | Long | 返回时间(时间戳,单位毫秒) | 
| requestId | String | 请求ID(在接口异常时, 需提供请求ID) | 
| code | Int | 返回的状态码 | 
| msg | String | 当返回结果的状态码不为200时,包含的错误信息 | 
| data | Json | 返回数据 | 
data 参数说明
| 参数 | 类型 | 说明 | 
|---|---|---|
| show_style | Json | 直播风格 { "value: "pro", "bg": "#000000", "button": "#ff0000", "logo": "urlstring", "cover": "urlstring", "adv": "urlstring" } value: 直播风格: pro:专业edu: 教育rec:娱乐annual:年会 custom:自定义 bg: 背景颜色, button: 按钮颜色 logo: logo地址 cover: 封面地址,, adv: 广告挂件  | 
		
| announcement | Json | 公告 (500字符) { "value": "1", " content ": "公告内容" } value:公告选项, 0关闭, 1打开 content: 公告内容 (当value为1时需要提供)  | 
		
| replay | Json | 回放有效期 { "value": "4", "expire_time":16103932093 } value: -1:不允许回放,0:永不失效,1:一个月失效,3:三个月失效,4:自定义失效时间 expire_time: 回放失效时间(秒级时间戳)(当value为1、3、4时需要提供)  | 
		
| organizer | String | 主办方 | 
| viewer_num | Json | 是否显示观看人数 { "value": "1", "base_viwer_num": 1000 } value: 0:不显示, 1:显示 base_viewer_num: 默认观看人数 (当value为1时需要提供)  | 
		
| praise | Json | 是否启用点赞功能 { "value": "1", "show_praie_num": 1, "base_praise_num": 0 } value: 0:关闭, 1:打开 show_praise_num: 是否显示点赞数 (当value为1时需要提供) base_praise_num: 默认基准点赞数量 (当value为1时需要提供)  | 
		
| anti_screen | Json | 防录屏跑马灯 { "value": "1", "font_color": "red", "font_size": 20, "interval": 20, "location": "middle", "opacity": 20, "speed": "middle", "style": "txt-nick", "text": "版权所有,盗版必究" } value: 0:关闭, 1:打开 font_color: 字体颜色 font_size: 字体大小 interval: 间隔时间(秒) location: 显示位置 opacity: 不透明度 speed: 文本移动速度 style: 跑马灯显示格式(文本或文本+昵称ID) text: 跑马灯文本  | 
		
| water_mark | Json | 水印 { "value": "1", "location": "upleft", "water_mark_url": "" } value: 0:关闭, 1:打开 location: 显示位置(upleft, upright, bottomleft, bottomright) water_mark_url: 水印图片地址  | 
		
| chatqa | Int | 是否开启聊天问答 0:否;1:是 | 
| audience_properties | Json | 观众权限属性 | 
| manual_service | Json | 人工服务属性 | 
| noticeWay | Int | 通知方式 0: 无通知, 1: 邮件通知, 2: 短信通知, 3: 邮件短信都通知(默认1) | 
| remindTime | Int | 入会提醒发送时间 5:开始前5分钟,10:开始前10分钟,15:开始前15分钟,20:开始前20分钟,25:开始前25分钟,30:开始前30分钟 | 
| notify_scene | Json | 企业级通知场景 {"activity_notify":{"1000":1,"1002":1},"join_remind":{"1000":1,"1002":1},"rec_notify":{"1000":1},"rep_notify":{"1000":1}} | 
| access_numbers | Json | 入会接入号 | 
| unionCustomers | Array[int] | 联合会 白名单验证证券公司列表 整形数组 1:中信证券 2:中银证券 3:兴业证券 4 西部证券 5:天风证券 6:申万证券 7:每市 8:海通证券 9:广发证券 10:国泰君安 11:东方证券 12:安信证券 13:长江证券 | 
audience_properties 参数说明 (默认值来自产品设置)
| 参数 | 类型 | 说明 | 
|---|---|---|
| confMute | String | 入会默认静音 0: 关闭; 1: 开启 | 
| enableRelieveMute | String | 允许解除静音 0: 关闭; 1: 开启 | 
| videoConferenceMode | String | 入会开启视频 0: 入会都不开启; 1: 入会需要开启; 2: 入会自由开关 | 
| videoControl | Int | 会中视频控制 1: 由主持人/联席主持人开关视频; 2: 自由开关视频 | 
| share | String | 是否可以共享 0: 允许; 1: 不允许 | 
| shareNotes | String | 是否可以批注 0: 不允许; 1: 允许 | 
| watermark | String | 是否加上水印 0: 不加水印; 1: 加水印 | 
| showWholeAttendList | String | 参会列表 0: 仅显示自己、主持人、主讲人和嘉宾; 1: 显示完整列表; 2: 仅主持人、联席主持人显示完整列表 | 
| isFreeChat | String | 聊天权限 0: 仅可与主持人聊天; 1: 可公开聊天和私聊 | 
| chat | String | 公开聊天 0:关闭 1:开启(默认1) | 
| autoRecord | String | 选择录制方式 0:手动录制,1:自动录制 | 
manual_service 参数说明
| 参数 | 类型 | 说明 | 
|---|---|---|
| confSecretaryQAHelp | String | 会议秘书问答协助 0:关闭 1:开启(默认) | 
| playBackMusic | String | 播放背景音乐 0:关闭 1:开启(默认) | 
| confSecretaryBroadcast | String | 会议秘书播报 0:关闭 1:开启(默认) | 
notify_scene 参数说明
| 参数 | 类型 | 说明 | 
|---|---|---|
| activity_notify | Json | 活动预约/更新/取消 | 
| join_remind | Json | 入会提醒 | 
| rec_notify | Json | 活动录制 | 
| rep_notify | Json | 活动报告 | 
access_numbers 参数说明
| 参数 | 类型 | 说明 | 
|---|---|---|
| accessNumberLanguage | String | 接入号语言 | 
| countryName | String | 国家名称 | 
| name | String | 接入号名称 | 
| value | String | 接入号 | 
4. 示例
输入示例
{
    "token":"5d41c4ac806c6440eb6aa8e071115f2b",
    "eventId": 573064
}
输出示例
{
    "timeStamp": 1658285785302,
    "code": 200,
    "msg": "Successfully to get the event settings!",
    "data": {
        "anti_screen": {
            "value": "0"
        },
        "eventId": 573064,
        "join_type": 0,
        "chat_review": 0,
        "telRecord": null,
        "manual_service": {
            "confSecretaryBroadcast": "0",
            "confSecretaryQAHelp": "0",
            "playBackMusic": "0"
        },
        "mute": 0,
        "replay": {
            "value": "-1"
        },
        "viewer_num": {
            "value": "1"
        },
        "praise": {
            "show_praise_num": "1",
            "value": "1"
        },
        "water_mark": {
            "value": "0"
        },
        "remindTime": 10,
        "join_limit_lock": 0,
        "show_style": {
            "adv": "",
            "bg": "white",
            "button": "red",
            "cover": "https://dle.quanshi.com/onemeeting/download/cover.jpg",
            "logo": "",
            "value": "pro"
        },
        "organizer": "",
        "notify_scene": {
            "activity_notify": {
                "1": 1,
                "2": 1
            },
            "join_remind": {
                "1": 1,
                "2": 1
            },
            "rec_notify": {
                "-1": 1,
                "1": 1,
                "2": 1
            },
            "rep_notify": {
                "-1": 1,
                "1": 0,
                "2": 0
            }
        },
        "join_limit": {
            "value": "0"
        },
        "auth_url": "https://exlogin-test.quanshi.com/exlogin/system/index",
        "noticeWay": 2,
        "audience_properties": {
            "confMute": "0",
            "enableRelieveMute": "0",
            "videoConferenceMode": "0",
            "showPreview": "0",
            "share": "1",
            "shareNotes": "0",
            "showWholeAttendList": "0",
            "chat": "1",
            "isFreeChat": "1",
            "autoRecord": "0",
            "watermark": "1",
            "videoControl": "2"
        },
        "poster": {
            "value": null
        },
        "announcement": {
            "value": "0"
        },
        "chatqa": 0,
        "access_numbers": [
            {
                "accessNumberLanguage": "英文",
                "name": "400-810-8128(中国大陆)",
                "countryName": "中国大陆",
                "value": "400-810-8128"
            },
            {
                "accessNumberLanguage": "中文",
                "name": "400-810-8228(中国大陆)",
                "countryName": "中国大陆",
                "value": "400-810-8228"
            }
        ],
        "unionCustomers": [
            1,
            2,
            3,
            4
        ]
    },
    "requestId": "10.255.0.106_20220720_105620_1658285780118"
}
    
  

