查看会议详情
1. 接口描述
接口名称:
/eventopenapi/event/info
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
token | String | 是 | 统一鉴权token |
eventId | Long | 是 | 直播会议ID |
isReturnLiveStreamUrl | Int | 否 | 是否返回直播拉流地址, 0: 不返回(默认), 1:返回 |
3. 输出参数
参数 | 类型 | 说明 |
---|---|---|
timeStamp | Long | 返回时间(时间戳,单位毫秒) |
requestId | String | 请求ID(在接口异常时, 需提供请求ID) |
code | Int | 返回的状态码 |
msg | String | 当返回结果的状态码不为200时,包含的错误信息 |
data | Json | 返回数据 |
data 参数说明
参数 | 类型 | 说明 |
---|---|---|
eventId | Long | 直播会议ID |
title | String | 会议主题 |
startTime | Long | 会议开始时间(时间戳,单位秒) |
endTime | Long | 会议结束时间(时间戳,单位秒) |
createTime | Long | 创建时间 (时间戳,单位秒) |
modifyTime | Long | 修改时间 (时间戳,单位秒) |
length | Int | 会议时长(时间戳,单位分钟) |
eventForm | Int | 会议形式 1: 电话活动,3: 网络会议,4: 实时互动直播,7: 大型直播活动 |
summary | String | 会议概要 |
hostId | Long | 主持人ID |
hostName | String | 主持人姓名 |
billingCode | String | 云会议计费BC |
conferenceId | String | 云会议ID |
status | Int | 会议状态,0:已取消,1:已创建,4:已结束(超过会议预约时间12个小时后) |
pcode1 | String | 主持人入会密码 |
pcode2 | String | 参会人入会密码 |
hostJoinUrl | String | 创建人入会链接 |
joinHostUrl | String | 助理主持人链接 |
guestJoinUrl | String | 嘉宾入会链接 |
audienceUnionUrl | String | 参会者链接 |
testAudienceUnionUrl | String | 测试会参会者链接 |
liveCover | String | 活动间(直播)封面图URL |
wcallUrl | String | 云会议电话会议链接 |
webRTCUrl | String | webRTC入会链接 |
callbackUrl | String | 会议回调地址 |
customerCode | 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: 是 |
useWaitingRoom | Int | 是否开启等候室 0:否,1:是 |
thirdConfId | String | 第三方会议ID |
webMeetUrl | String | webRTC链接 |
activityForm | Int | 云活动类型,1:大型直播,2:实时互动,3:网络活动,4:电话活动,大于1000传递值的是业务模板ID |
extraInfo | Json | 会议扩展信息 |
attendList | Array | 参会人列表 |
btplRole | Json | 专业活动角色信息 |
confMode | Int | 会议类型 0: 视频会议 1: 数据会议 |
allowHardVideo | Int | 是否允许硬件视频入会,0:否,1:是 |
watchMcuVideoMode | Int | 观看视频模式 1: 观看多路云会议视频模式,2: 观看多路硬件视频模式,0: 表示既不是1模式也不是2模式 |
eventSource | Int | 活动来源 5: 云活动,6: 云课堂 |
isCycle | Int | 是否是周期会议,0:否,1:是 |
cycleInfo | Json | 周期会议信息 |
liveStreamUrl | Json Array | 直播平台拉流地址,当请求参数 isReturnLiveStreamUrl = 1 时返回 |
thirdMeetingInfo | Json | 第三方会议信息 |
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 参数
参数 | 类型 | 说明 |
---|---|---|
isTest | Int | 是否需要测试会议 0:否,1:是 |
isPublic | Int | 公共活动类型 0:非公开,1:公开 |
btplId | Int | 业务模板ID |
btplName | String | 业务模板名称 |
parentEventId | Long | 母直播的eventId |
parentRecordList | JSON | 转播录制ID数组 |
recommends | Array | 直播转播平台,8:每市, 16: choice, 32: 同花顺 |
recommendJoinLimit | Int | 直播转播观看条件, 1: 仅企业白名单客户才可参会, 7: 平台所有机构投资者均可参会 |
liveCode | String | 直播码 (只有genLiveCode=1时才有值) |
attendList 参数
参数 | 类型 | 说明 |
---|---|---|
roleId | Int | 角色ID |
user | String | UMSID或者邮箱、电话信息 |
name | String | 姓名 |
String | 邮箱 | |
userType | String | 类型 1:user为UMSID,2:user为邮箱; 3: user为电话 |
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 | 周期会议截止时间(单位秒) |
thirdMeetingInfo 第三方会议信息
参数 | 类型 | 说明 |
---|---|---|
tencent | JSON | 腾讯会议信息 |
tencent 腾讯会议信息
参数 | 类型 | 说明 |
---|---|---|
password | String | 腾讯会议号(参会密码) |
meetingLink | String | 入会链接 |
4. 示例
输入示例
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"eventId": 572328
}
输出示例1: 普通会议
{
"timeStamp": 1657683276617,
"code": 200,
"msg": "Successfully to get the event info!",
"data": {
"hostName": "云活动测试0098777",
"jointHostUrl": "http://stest.qsh1.cn/a/GVT6BXB599CB",
"webMeetUrl": "https://webmeet-test.quanshi.com",
"thirdConfId": "",
"wcallUrl": "http://meetservicem.quanshi.com/m-wcall/?pcode=778416fa1553196d01e124b62cba4b3a2a95202536d30fc4d3be56b0e3249366&env=E&billingcode=79ac14db74358e9fb7d701050819c257&summit=1&prod=meetnow&uc_lang=cn",
"endDate": "2022-07-14 00:31:27",
"isCycle": 0,
"customerCode": "153857",
"title": "云活动专业会议测试更新-002",
"customStr": "Update the customStr1!",
"liveScreen": 0,
"joinHostUrl": "http://stest.qsh1.cn/a/GVT6BXB599CB",
"createTime": 1657679400,
"modifyTime": 1657683087,
"audienceJoinUrl": "",
"attendList": [
{
"roleId": 1000,
"user": "88408692"
}
],
"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": 1657715487,
"callbackUrl": "https://eventopenapi-dev.quanshi.com/eventopenapi/event/callback",
"confNodeType": 0,
"guestJoinUrl": "",
"attendeeJoinUrl": "-",
"summary": "update the summary",
"eventId": 572328,
"livePullUrl": "https://ltest.qsh1.cn/activity/gdS12y7",
"createDate": "2022-07-13 10:30:00",
"modifyDate": "2022-07-13 11:31:27",
"hostJoinUrl": "http://stest.qsh1.cn/a/HVT6BXF2D33F",
"eventForm": 7,
"length": 240,
"status":1,
"hostId": 88408692,
"useWaitingRoom": 1,
"labels": [
"t1",
"t2"
],
"billingCode": "95404541",
"pcode2": "201501000037453348",
"pcode1": "201501000037453347",
"conferenceId": "239727280",
"webRTCUrl": "https://ntest.qsh1.cn/k/mkKUvYUk0GH?priority=web",
"confMode": 0,
"liveOpenFlag": 1,
"endTime": 1657729887,
"liveCover": "http://www.quanshi.com",
"activityForm": 22100,
"liveLag": 1,
"startDate": "2022-07-13 20:31:27",
"extraInfo": {
"eventWatchword": null,
"btplName": "网络互动606",
"thirdConfId": "",
"isTest": 0,
"openWatchword": 0,
"isThirdConfId": 0,
"btplId": 22100,
"recommends":[8,16],
"recommendJoinLimit":1
},
"isCycle": 0,
"thirdMeetingInfo":{
"tencent":{
"password":"29810",
"meetingLInk":"https://meeting.tencent.com/"
}
}
},
"requestId": "10.255.0.106_20220713_113436_1657683276513"
}
输出示例1: 周期会议
{
"timeStamp": 1663056462010,
"code": 200,
"msg": "Successfully to get the event info!",
"data": {
"webMeetUrl": "https://webmeet-test.quanshi.com",
"wcallUrl": "https://stest.qsh1.cn/a/IRmse4GVJf91Y81B586",
"endDate": "2022-09-13 21:53:49",
"guestJoinInternalUrl": "https://stest.qsh1.cn/a/NVGVsX946B0F",
"customStr": "{\"email\":[\"gang.liu@quanshi.com\"]}",
"liveScreen": 0,
"joinHostUrl": "https://stest.qsh1.cn/a/OVGVsX54CFD8",
"createTime": 1663031400,
"modifyTime": 1663037629,
"audienceUnionUrl": "https://ltest.qsh1.cn/activity/ge6yYGl",
"callbackUrl": "https://eventopenapi-dev.quanshi.com/deliver/api/callback/meeting",
"attendeeJoinUrl": "-",
"eventId": 603775,
"createDate": "2022-09-13 09:10:00",
"modifyDate": "2022-09-13 10:53:49",
"eventForm": 7,
"hostId": 88408692,
"useWaitingRoom": 0,
"labels": [
"t1",
"t2"
],
"pcode2": "201501000037581658",
"pcode1": "201501000037581657",
"webRTCUrl": "https://ntest.qsh1.cn/k/mkx0b252NjR?priority=web",
"watchMcuVideoMode": 1,
"confMode": 0,
"liveOpenFlag": 1,
"liveCover": "https://img0.baidu.com/it/u=1540109528,3311100791&fm=26&fmt=auto&gp=0.jpg",
"startDate": "2022-09-13 20:53:49",
"extraInfo": {
"eventWatchword": "",
"rebroadcastform": null,
"btplName": null,
"parentRecordList": null,
"thirdConfId": "",
"isTest": 0,
"openWatchword": 0,
"isThirdConfId": 0,
"btplId": null,
"parentEventId": null,
"rebroadcast": 0
},
"allowHardVideo": 1,
"hostName": "云活动测试0098777",
"jointHostUrl": "https://stest.qsh1.cn/a/OVGVsX54CFD8",
"thirdConfId": "",
"isCycle": 1,
"eventSource": 5,
"customerCode": "153857",
"title": "直播周期会议测试-003",
"audienceJoinUrl": "https://ltest.qsh1.cn/activity/ge6yYGl",
"attendList": [
{
"roleId": 1,
"name": "",
"userType": 1,
"user": "88408692",
"email": "",
"status": "W"
}
],
"manualService": 1,
"testAudienceUnionUrl": "",
"btplRole": [
{
"managerType": 1,
"internallink": null,
"roleId": 1,
"roleName": "主持人",
"link": "https://ntest.qsh1.cn/k/mkx0bQo0TNN",
"joinconfway": null
},
{
"managerType": 2,
"internallink": null,
"roleId": 2,
"roleName": "助理主持人",
"link": "https://stest.qsh1.cn/a/OVGVsX54CFD8",
"joinconfway": null
},
{
"managerType": 3,
"internallink": "https://stest.qsh1.cn/a/NVGVsX946B0F",
"roleId": 3,
"roleName": "嘉宾",
"link": "https://ltest.qsh1.cn/activity/ge6yY3Ol",
"joinconfway": null
},
{
"managerType": 3,
"internallink": "https://ntest.qsh1.cn/k/mkx0b252NjR",
"roleId": 0,
"roleName": "观众",
"link": "https://ltest.qsh1.cn/activity/ge6yYGl",
"joinconfway": null
}
],
"startTime": 1663073629,
"confNodeType": 1,
"guestJoinUrl": "https://ltest.qsh1.cn/activity/ge6yY3Ol",
"cycleInfo": {
"bymonthday": null,
"bymonthweek": null,
"timezone": "Asia/Shanghai",
"byday": null,
"bymonth": null,
"interval": 1,
"frequency": "daily",
"repeatEndDate": 1663210397
},
"summary": "openapi 测试会议....",
"livePullUrl": "https://ltest.qsh1.cn/activity/ge6yYGl",
"hostJoinUrl": "https://ntest.qsh1.cn/k/mkx0bQo0TNN",
"length": 60,
"billingCode": "A1000056",
"conferenceId": "239783200",
"audienceJoinInternalUrl": "https://ntest.qsh1.cn/k/mkx0b252NjR",
"endTime": 1663077229,
"activityForm": 1,
"liveLag": 1
},
"requestId": "10.255.0.106_20220913_160741_1663056461965"
}