编辑会议

1. 接口描述

接口名称:

/eventopenapi/event/update

发送方式:

POST

参数格式:

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

2. 输入参数

参数 类型 必须 说明
token String 统一鉴权token
eventId Long 直播会议ID
title String 会议主题 主题不能超过30个字
startTime Long 开始时间(时间戳,单位秒)
length Int 会议时长(单位分钟)
会议时长的取值只接受30的倍数,并且最大为720分钟. 如果填写的时长不符合要求,系统自动取最接近的分钟数. 例如输入时长40分钟,则系统自动转换成30分钟;而输入时长50分钟,系统会调整为60分钟
liveCover String 会议封面图URL 尺寸1280x720px 图片小于2MB(jpg、png)
summary String 会议简介 简介内容不能超过500个字, 目前支持受限的Html标记
分段:p, span, ul, li, br
图形:img
字体:strong, em, u
joinLimit Int 直播入会方式 0: 公开, 1: 白名单
liveLag Int 直播延迟设置 0: 正常延迟,1: 无延迟 只对大型直播活动有效
liveScreen Int 云活动手机屏幕显示方式,0: 横屏,1: 竖屏 在会议开始时,不支持修改
manualService Int 是否需要项目经理开关,1: 开启,2: 关闭 在会议开始时,不支持修改
confNodeType Int 会议节点类型 0: 保密会议,1: 标准会议
useWaitingRoom Int 是否开启等候室 0:否,1:是
customStr String 自定义内容
extraInfo Json 会议扩展信息
isCycle Int 是否为周期会议 只有周期会议才需要设置
oriStart Long 周期会议例外时间 0:表示整场周期会议;>0:表示单场或者周期例外的开始时间(默认0)只有周期会议才需要设置
cycleInfo Json 周期会议信息 只有周期会议才需要设置
  • 周期序列:周期会议的每次运行时间,所形成的一个时间序列
  • 周期例外:周期会议时间序列中的某一场会议。支持对这场会议从周期序列中单独操作
  • 周期例外会议,更新后生成新的eventId,此时可以将周期例外会议当作普通会议。
  • 周期会议例外时间必须和startTime在同一天

extraInfo 参数

参数 类型 必须 说明
openWatchword Int 是否开启入会口令 0:否,1:是
isTest Int 是否需要测试会议 0:否,1:是
recommends Array 直播转播平台,1:在企业站点上公开,8:每市, 16: choice, 32: 同花顺
recommendJoinLimit Int 直播转播观看条件, 1: 仅企业白名单客户才可参会, 7: 平台所有机构投资者均可参会
isReturnLiveStreamUrl Int 是否返回直播拉流地址, 0: 不返回(默认), 1:返回
isDisableRecord Int 直播是否禁止录制 1:禁止, 0:不禁止

cycleInfo 参数

参数 类型 必须 说明
timezone String 时区(周期会议必传)
frequency String 重复频率(DAILY/WEEKLY/MONTHLY/YEARLY)日/周/月/年
interval Int 间隔次数 每几天(1-365)/周(1-52)/月(1-12)/年(1-10)
byday String 星期(MO,TU,WE,TH,FR,SA,SU)只出现在周/月/年上; 在月/年时, byday只能取一个值
bymonth String 月(1-12)
bymonthday String 在月中的第几天(1-31)
bymonthweek String 在月中的第几周(1-5)
repeatEndDate Long 周期会议截止时间(单位秒)

3. 输出参数

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

data 参数说明

参数 类型 说明
eventId Long 直播会议ID
title String 会议主题
startTime Long 会议开始时间(时间戳,单位秒)
length Int 会议时长(时间戳,单位分钟)
eventForm Int 会议形式 1: 电话活动,3: 网络会议,7: 大型直播活动
summary String 会议概要
hostId Long 主持人ID
billingCode String 云会议计费BC
conferenceId String 云会议ID
pcode1 String 主持人入会密码
pcode2 String 参会人入会密码
hostJoinUrl String 主持人入会链接
joinHostUrl String 助理主持人链接
guestJoinUrl String 嘉宾入会链接
audienceUnionUrl String 参会者链接
testAudienceUnionUrl String 测试会参会者链接
liveCover String 活动间(直播)封面图URL
callbackUrl String 会议回调地址
liveScreen Int 云活动手机屏幕显示方式,0:横屏(默认)1:竖屏
manualService Int 是否需要项目经理开关,1:开启,2:关闭,默认2
liveLag Int 直播延迟设置(0:正常延迟,1:无延迟,默认0)
labels Array 活动标签
customStr String 自定义内容
confNodeType Int 会议节点类型 0: 保密会议,1: 标准会议(默认)
liveOpenFlag Int 开启实时互动直播 0: 否, 1: 是(默认值0,仅针对eventForm=3有效)
useWaitingRoom Int 是否开启等候室 0:否,1:是
thirdConfId String 第三方会议ID
joinLimit Int 观众直播入会限制 0: 公开, 1: 白名单(默认值1, 并且非白名单(电话入会)拒绝入会)
extraInfo Json 会议扩展信息
btplRole Json 专业活动角色信息
isCycle Int 是否是周期会议,0:否,1:是
cycleInfo Json 周期会议信息
liveStreamUrl Json Array 直播平台拉流地址,当请求参数 isReturnLiveStreamUrl = 1 时返回

liveStreamUrl 数组中的单个对象

参数 类型 说明
rtmp_url String RTMP拉流地址
flv_url String FLV拉流地址
hls_url String HLS拉流地址
provider String 直播平台名称, netease:网易,tencent:腾讯,ali:阿里, ks: 金山, quanshi: 全时
layout_type Int 直播布局 1: PC布局(默认),2:移动竖屏(用于二期扩展)
url_expire_time Long 过期时间(单位毫秒)

extraInfo 参数

参数 类型 说明
isThirdConfId Int 是否使用第三方会议ID 0:否,1:是 (特定客户专用)
thirdConfId String 第三方会议ID (特定客户专用)
openWatchword Int 是否开启入会口令 0:否,1:是
eventWatchword String 入会口令
isTest String 是否需要测试会议 0:否,1:是
isDisableRecord Int 直播是否禁止录制 1:禁止, 0:不禁止
recommends Array 直播转播平台,1:在企业站点上公开, 8:每市, 16: choice, 32: 同花顺
recommendJoinLimit Int 直播转播观看条件, 1: 仅企业白名单客户才可参会, 7: 平台所有机构投资者均可参会

btplRole 参数

参数 类型 说明
roleId Int 角色ID
roleName String 角色名称
managerType Int 管理类型 1:管理者,2:辅助管理者(联席主持人),3:参会人, -1: 企业管理者
joinconfway Int 入会方式 1: 电话,2: 网络,3: 电话+网络,4: 直播
link String 入会链接
internallink String 内部使用链接

cycleInfo 参数

参数 类型 说明
timezone String 时区(周期会议必传)
frequency String 重复频率(DAILY/WEEKLY/MONTHLY/YEARLY)日/周/月/年
interval Int 间隔次数 每几天(1-365)/周(1-52)/月(1-12)/年(1-10)
byday String 星期(MO,TU,WE,TH,FR,SA,SU)只出现在周/月/年上; 在月/年时, byday只能取一个值
bymonth String 月(1-12)
bymonthday String 在月中的第几天(1-31)
bymonthweek String 在月中的第几周(1-5)
repeatEndDate Long 周期会议截止时间(单位秒)

4. 示例

输入示例1: 更新标准活动

{
    "token":"a8245e1a0c68fbcb22b2d90b63ea42c8",
    "eventId": 572328,
    "title": "云活动会议更新",
    "startTime": 1657715487329,
    "length": 240,
    "liveCover": "http://www.quanshi.com",
    "summary": "update the summary",
    "customStr": "Update the customStr1!",
    "confNodeType": 0,
    "useWaitingRoom": 1,
    "liveLag": 0,
    "liveScreen": 0,
    "joinLimit": 1,
    "extraInfo":{"isPublic":1, "recommends":[8,16],"recommendJoinLimit":7}
}

输入示例3: 将周期会议更新成普通会议

{
    "token":"a8245e1a0c68fbcb22b2d90b63ea42c8",
    "eventId": 572328,
    "title": "云活动周期会议更新成普通会议",
    "startTime": 1657715487329,
    "length": 240,
    "liveCover": "http://www.quanshi.com",
    "summary": "update the summary",
    "customStr": "Update the customStr1!",
    "confNodeType": 0,
    "useWaitingRoom": 1,
    "liveLag": 0,
    "liveScreen": 0,
    "joinLimit": 1,
    "isCycle": 0
}

输入示例3: 更新周期会议序列

{
    "token":"a8245e1a0c68fbcb22b2d90b63ea42c8",
    "eventId": 572328,
    "title": "云活动周期会议更新",
    "startTime": 1657715487329,
    "length": 240,
    "liveCover": "http://www.quanshi.com",
    "summary": "update the summary",
    "customStr": "Update the customStr1!",
    "confNodeType": 0,
    "useWaitingRoom": 1,
    "liveLag": 0,
    "liveScreen": 0,
    "joinLimit": 1,
    "cycleInfo": {
        "timezone": "Asia/Shanghai",
        "frequency": "daily",
        "interval": 2
    }
}

输入示例4: 更新周期例外会议

{
    "token":"a8245e1a0c68fbcb22b2d90b63ea42c8",
    "eventId": 572328,
    "title": "云活动周期例外会议更新",
    "startTime": 1663244401,
    "length": 240,
    "liveCover": "http://www.quanshi.com",
    "summary": "update the summary",
    "customStr": "Update the customStr1!",
    "confNodeType": 0,
    "useWaitingRoom": 1,
    "liveLag": 0,
    "liveScreen": 0,
    "joinLimit": 1,
    "oriStart": 1663237201
}

输出示例

{
    "timeStamp": 1657683088011,
    "code": 200,
    "msg": "Successfully to update the event!",
    "data": {
        "thirdConfId": "",
        "isCycle": 0,
        "title": "云活动专业会议测试更新-002",
        "joinLimit": 1,
        "customStr": "Update the customStr1!",
        "joinHostUrl": "http://stest.qsh1.cn/a/GVT6BXB599CB",
        "liveScreen": 0,
        "audienceJoinUrl": "",
        "manualService": 2,
        "audienceUnionUrl": "",
        "testAudienceUnionUrl": "",
        "btplRole": [
            {
                "managerType": 1,
                "internallink": null,
                "roleId": 1000,
                "roleName": "主播",
                "link": "http://stest.qsh1.cn/a/HVT6BXF2D33F",
                "joinconfway": 19
            },
            {
                "managerType": 2,
                "internallink": null,
                "roleId": 1001,
                "roleName": "管理员",
                "link": "http://stest.qsh1.cn/a/GVT6BXB599CB",
                "joinconfway": 2
            },
            {
                "managerType": 3,
                "internallink": "https://ntest.qsh1.cn/k/mkKUvYUk0GH?jointid=SZql330xSglfxEa-uyN4kqrVbKl-naZ9G87sWU37ZrHmmeesv1IQN19smwGu4uTB",
                "roleId": 1002,
                "roleName": "助理",
                "link": "https://ltest.qsh1.cn/activity/gdS12gaWl",
                "joinconfway": 6
            }
        ],
        "startTime": 1657715487329,
        "callbackUrl": "https://eventopenapi-dev.quanshi.com/eventopenapi/event/callback",
        "confNodeType": 0,
        "guestJoinUrl": "",
        "attendeeJoinUrl": "-",
        "summary": "update the summary",
        "eventId": 572328,
        "hostJoinUrl": "http://stest.qsh1.cn/a/HVT6BXF2D33F",
        "wcallurl": "http://meetservicem.quanshi.com/m-wcall/?pcode=778416fa1553196d01e124b62cba4b3a2a95202536d30fc4d3be56b0e3249366&env=E&billingcode=79ac14db74358e9fb7d701050819c257&summit=1&prod=meetnow&uc_lang=cn",
        "eventForm": 7,
        "length": 240,
        "hostId": 88408692,
        "useWaitingRoom": 1,
        "labels": [
            "t1",
            "t2"
        ],
        "billingCode": "95404541",
        "pcode2": "201501000037453348",
        "pcode1": "201501000037453347",
        "conferenceId": "239727280",
        "liveOpenFlag": 1,
        "liveCover": "http://www.quanshi.com",
        "liveLag": 1,
        "extraInfo": {
            "eventWatchword": null,
            "btplName": "网络互动606",
            "thirdConfId": null,
            "isTest": 0,
            "openWatchword": 0,
            "isThirdConfId": 0,
            "btplId": 22100,
            "recommends":[8,16],
            "recommendJoinLimit":1
        }
    },
    "requestId": "10.255.0.106_20220713_113127_1657683087429"
}