云直播会议管理

云直播会议管理接口,为用户提供创建云直播会议的一些方法。用户可以使用这些接口,创建、编辑、取消会议,也可以查询会议列表和会议详情。同时系统提供了获取"免校验"入会链接的方法,通过此方法获取到的入会链接,省略了繁琐的入会校验逻辑。用户可以轻松入会,不需要在入会时填写用户名称、电话信息等信息。 针对电话会议的特殊性,用户可以通过"获取入会接入号"接口,获取具体的电话步骤和接入号信息;用户也可以通过查询会议状态接口,实时了解会议目前所处的状态情况

新建会议

1. 接口描述

接口名称:

/eventopenapi/event/create

发送方式:

POST

参数格式:

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

2. 输入参数

参数 类型 必须 说明
token String 统一鉴权token
hostId Long 主持人ID(可通过 https://developer.quanshi.com/cn/api/122 查询)
productType Int 产品类型 5: 云活动,61: 云课堂-小班课,62: 云课堂-大班课(默认值5)
title String 会议主题, 主题不能超过30个字
startTime Long 开始时间(时间戳,单位秒)
length Int 会议时长(单位分钟)
会议时长的取值只接受30的倍数,并且最大为720分钟。如果填写的时长不符合要求,系统自动取最接近的分钟数. 例如输入时长40分钟,则系统自动转换成30分钟;而输入时长50分钟,系统会调整为60分钟
eventForm Int 会议形式 1: 电话会议,3: 网络会议,4: 实时互动直播,7: 大型直播活动
电话会议 :通过电话的方式召开的活动,可进行声音的实时互动,无资料共享。
网络会议:适用于有资料共享的实时互动活动,所有参会用户都可查看共享的资料,可选择电话/网络语音进行互动讨论。
实时互动直播 :适用于大方数互动直播活动,观众通过电话或无延时直播方式参会,会中可举手申请语音互动。
大型直播活动:适用于宣讲路演、带货推广、年会、在线发布会,所有参会用户可通过网页/小程序观看直播,可通过文字或举手方式进行互动讨论。
liveCover String 活动间(直播)封面图URL 尺寸1280x720px 图片小于2MB(jpg、png)
summary String 会议简介 简介内容不能超过500个字, 目前支持受限的Html标记
分段:p, span, ul, li, br
图形:img
字体:strong, em, u
joinLimit Int 直播入会方式 0: 公开, 1: 白名单(默认1)
liveLag Int 直播延迟设置 0: 正常延迟,1: 无延迟(默认0,只对大型直播活动有效)
liveScreen Int 云活动手机屏幕显示方式,0: 横屏,1: 竖屏 (默认0)
manualService Int 是否需要项目经理开关,1: 开启,2: 关闭(默认1)
confNodeType Int 会议节点类型 0: 保密会议,1: 标准会议(默认1)
useWaitingRoom Int 是否开启等候室 0:否,1:是(默认0)
callbackUrl String 会议回调地址
labels Array 活动标签
customStr String 自定义内容
extraInfo Json 会议扩展信息
isCycle Int 是否是周期会议,0:否,1:是(默认0)
cycleInfo Json 周期会议信息
participants Json 会议参会人列表

extraInfo 参数

参数 类型 必须 说明
isThirdConfId Int 是否使用第三方会议ID 0:否,1:是(默认0)(特定客户专用)
thirdConfId String 第三方会议ID(特定客户专用)
openWatchword Int 是否开启入会口令 0:否,1:是(默认0)
eventWatchword String 入会口令(默认空)
isTest Int 是否需要测试会议 0:否,1:是(默认0)
btplId Int 业务模板ID(专业活动需要提供,调用方需要确保业务模板类型与会议形式一致)
btplName String 业务模板名称(专业活动需要提供)
parentEventId Long 母直播的eventId
parentRecordList JSON 转播录制ID数组, 对应 根据标签获取会议录制列表中的sliceId
liveConfig JSON 会议配置
recommends Array 直播转播平台,1:在企业站点上公开, 8:每市, 16: choice, 32: 同花顺
recommendJoinLimit Int 直播转播观看条件, 1: 仅企业白名单客户才可参会, 7: 平台所有机构投资者均可参会
isReturnLiveStreamUrl Int 是否返回直播拉流地址, 0: 不返回(默认), 1:返回
isDisableRecord Int 直播是否禁止录制 1:禁止, 0:不禁止
genLivecode Int 是否生成直播码 1:生成, 0:不生成

以下关于thirdConfId, isThirdConfId的描述, 特定客户专用

  • 当isThirdConfId=1且thirdConfId为空时,系统自动生成第三方会议ID
  • 当isThirdConfId=1且thirdConfId不为空时,系统使用thirdConfId作为第三方会议ID
  • 如果thirdConfId不为空,需要外部系统保证thirdConfId的唯一性
  • 调用方需要确保业务模板类型与会议形式一致。例如业务模板是网络会议模板,eventForm需要设置为3;业务模板是直播类型,eventForm可以设置为4或者7

liveConfig 参数说明

参数 类型 必须 说明
waterMark Int 水印 0:关闭,1:开启(默认0)
announcement Int 公告选项 0:关闭, 1:打开(默认0)
organizer String 主办方
viewerNum Int 是否显示观看人数 0:不显示,1:显示(默认1)
praise Int 是否启用点赞功能 0:关闭,1:打开(默认0)
chatqa Int 是否开启聊天问答 0:否,1:是(默认0)
replay Int 是否开启回放 -1:不允许回放,0:永不失效
guestJoinLimit Int 标准活动,嘉宾入会限制是否需要验证(0:否,1:是)
audienceJoinLimit Int 标准活动,观众入会限制是否需要验证(0:否,1:是)

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 周期会议截止时间(单位秒)

participants 参数说明

参数 类型 必须 说明
roleId Long 参会人角色ID(必须是会议详情中的btplRole字段定义的roleId,且managerType=2)
userId Long 参会人UMSID(userId, email, mobile 三选一)
name String 姓名
company String 公司
email String 邮箱
countryCode String 国家码(默认86)
mobile String 手机号

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: 网络会议,4: 实时互动直播,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:关闭
liveLag Int 直播延迟设置 0:正常延迟,1:无延迟
labels Array 活动标签
customStr String 自定义内容
confNodeType Int 会议节点类型 0: 保密会议,1: 标准会议
liveOpenFlag Int 开启实时互动直播 0: 否, 1: 是(仅针对eventForm=3有效)
useWaitingRoom Int 是否开启等候室 0:否,1:是
thirdConfId String 第三方会议ID
joinLimit Int 观众直播入会限制 0: 公开, 1: 白名单(非白名单(电话入会)拒绝入会)
extraInfo Json 会议扩展信息
btplRole Json 专业活动角色信息
productType Int 产品类型 5: 云活动,61: 云课堂-小班课,62: 云课堂-大班课
isCycle Int 是否是周期会议,0:否,1:是
cycleInfo Json 周期会议信息
liveStreamUrl Json Array 直播平台拉流地址,当请求参数 isReturnLiveStreamUrl = 1 时返回
liveCode String 直播码,只有genLiveCode=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 Int 是否需要测试会议 0:否,1:是
isPublic Int 公共活动类型 0:非公开,1:公开
btplId Int 业务模板ID
btplName String 业务模板名称
parentEventId Long 母直播的eventId
parentRecordList JSON 转播录制ID数组
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",
    "title": "直播标准活动",
    "startTime": 1655985738371,
    "length":1200,
    "hostId": 88589655,
    "eventForm": 7,
    "liveCover": "https://img0.baidu.com/it/u=1540109528,3311100791&fm=26&fmt=auto&gp=0.jpg",
    "summary": "openapi 测试会议....",
    "liveLag": 1,
    "liveScreen": 0,
    "joinLimit": 0,
    "labels": ["t1", "t2"],
    "confNodeType": 1,
    "useWaitingRoom": 0,
    "liveOpenFlag": 0,
    "customStr": "this is the customer str!",
    "extraInfo": {
        "isTest": 0,
        "parentEventId":23000,
        "parentRecordList":[234,789],
        "recommends":[8,16],
        "recommendJoinLimit":1
    }
}

输入示例2: 创建专业活动(业务模板是网络类型)

{
    "token":"a8245e1a0c68fbcb22b2d90b63ea42c8",
    "title": "直播专业活动",
    "startTime": 1655985738371,
    "length":1200,
    "hostId": 88589655,
    "eventForm": 3,
    "liveCover": "https://img0.baidu.com/it/u=1540109528,3311100791&fm=26&fmt=auto&gp=0.jpg",
    "summary": "openapi 测试会议....",
    "joinLimit": 0,
    "labels": ["t1", "t2"],
    "confNodeType": 1,
    "useWaitingRoom": 0,
    "customStr": "this is the customer str!",
    "extraInfo": {
        "isTest": 0,
        "btplId": 22100,
        "btplName": "网络互动606",
        "parentEventId":23000,
        "parentRecordList":[234,789],
        "recommends":[8,16],
        "recommendJoinLimit":1
    }
}

输入示例3: 创建周期会议

{
    "token":"a8245e1a0c68fbcb22b2d90b63ea42c8",
    "title": "直播周期会议",
    "startTime": 1655985738371,
    "length":1200,
    "hostId": 88589655,
    "eventForm": 3,
    "liveCover": "https://img0.baidu.com/it/u=1540109528,3311100791&fm=26&fmt=auto&gp=0.jpg",
    "summary": "openapi 测试会议....",
    "joinLimit": 0,
    "labels": ["t1", "t2"],
    "confNodeType": 1,
    "useWaitingRoom": 0,
    "customStr": "this is the customer str!",
    "isCycle": 1,
    "cycleInfo": {
        "timezone": "Asia/Shanghai",
        "frequency": "daily",
        "interval": 1
    }
}

输出示例

{
    "timeStamp": 1657682941299,
    "code": 200,
    "msg": "Successfully to create the event!",
    "data": {
        "thirdConfId": "",
        "isCycle": 0,
        "title": "云活动标准会议-001",
        "joinLimit": 0,
        "customStr": "This is the custom string",
        "joinHostUrl": "http://stest.qsh1.cn/a/GVT6BXB599CB",
        "liveScreen": 0,
        "audienceJoinUrl": "",
        "manualService": 1,
        "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": 1657715339724,
        "callbackUrl": "https://eventopenapi-dev.quanshi.com/eventopenapi/event/callback",
        "confNodeType": 1,
        "guestJoinUrl": "",
        "attendeeJoinUrl": "-",
        "cycleInfo": null,
        "summary": "",
        "eventId": 572328,
        "wcallurl": "http://meetservicem.quanshi.com/m-wcall/?pcode=778416fa1553196d01e124b62cba4b3a2a95202536d30fc4d3be56b0e3249366&env=E&billingcode=79ac14db74358e9fb7d701050819c257&summit=1&prod=meetnow&uc_lang=cn",
        "hostJoinUrl": "http://stest.qsh1.cn/a/HVT6BXF2D33F",
        "eventForm": 7,
        "length": 120,
        "hostId": 88408692,
        "useWaitingRoom": 0,
        "labels": [
            "t1",
            "t2"
        ],
        "billingCode": "95404541",
        "pcode2": "201501000037453348",
        "pcode1": "201501000037453347",
        "conferenceId": "239727280",
        "liveOpenFlag": 0,
        "liveCover": "https://img0.baidu.com/it/u=1540109528,3311100791&fm=26&fmt=auto&gp=0.jpg",
        "liveLag": 1,
        "extraInfo": {
            "eventWatchword": null,
            "btplName": "网络互动606",
            "thirdConfId": "",
            "isTest": 0,
            "openWatchword": 0,
            "isThirdConfId": 0,
            "btplId": 22100,
            "recommends":[8,16],
            "recommendJoinLimit":1
        }
    },
    "requestId": "10.255.0.106_20220713_112859_1657682939816"
}