查看会议列表
1. 接口描述
查询会议预约时间在指定时间范围内的会议列表:通过参数startTime每次取列表上最大的会议开始时间来作分页,如果分页处有开始时间相同的多场会议,通过lastEventId参数来去重(传最后的eventId)
接口名称:
/eventopenapi/event/list
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
| 参数 | 类型 | 必须 | 说明 | 
|---|---|---|---|
| token | String | 是 | 统一鉴权token | 
| hostId | Long | 否 | 主持人ID 如果主持人ID为空,则查询所有创建的直播会议 | 
| startTime | Long | 否 | 查询开始时间(时间戳,单位秒)默认为当前时间 | 
| endTime | Long | 否 | 查询结束时间(时间戳,单位秒)默认为当前时间之后3个月 | 
| limit | Int | 否 | 每页返回多少条记录,默认值10 | 
| lastEventId | Long | 否 | 分页参数,上页最后一条会议的eventId | 
| showCycle | Boolean | 否 | 是否显示周期会议(默认值false) | 
| ignoreParent | Boolean | 否 | 是否忽略系列会父会, true:忽略(默认) false:不忽略 | 
3. 输出参数
| 参数 | 类型 | 说明 | 
|---|---|---|
| timeStamp | Long | 返回时间(时间戳,单位毫秒) | 
| requestId | String | 请求ID(在接口异常时, 需提供请求ID) | 
| code | Int | 返回的状态码 | 
| msg | String | 当返回结果的状态码不为200时,包含的错误信息 | 
| data | Array | 返回数据 | 
data 参数说明
| 参数 | 类型 | 说明 | 
|---|---|---|
| eventId | Long | 直播会议ID | 
| parentId | 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",
    "hostId": 88406965,
    "startTime": 1625733388,
    "limit": 2
}
输出示例
{
    "timeStamp": 1639472373419,
    "code": 200,
    "msg": "Successfully to get the event list!",
    "data": [
        {
            "summary": "openapi 测试会议....",
            "eventId": 542781,
            "hostName": "15029232544",
            "jointHostUrl": "http://stest.qsh1.cn/a/OVsNIX170A2E",
            "livePullUrl": "https://ltest.qsh1.cn/activity/gdm8FQ2",
            "hostJoinUrl": "https://mtest.qsh1.cn/k/mkmBvD5N5je",
            "eventForm": 3,
            "length": 120,
            "hostId": 88406965,
            "title": "openapi-callback-1214白名单测试",
            "billingCode": "95370622",
            "pcode2": "201501000037372206",
            "pcode1": "201501000037372205",
            "modifyTime": 1639466204,
            "conferenceId": "239604745",
            "audienceUnionUrl": "https://ltest.qsh1.cn/activity/gdm8FQ2",
            "startTime": 1639495003,
            "endTime": 1639502203,
            "liveCover": "http://www.baidu.com",
            "guestJoinUrl": "http://stest.qsh1.cn/a/NVsNIX7C34DF",
            "attendeeJoinUrl": "https://mtest.qsh1.cn/k/mkmBv9XdAaT"
        },
        {
            "summary": "openapi 测试会议....",
            "eventId": 542815,
            "hostName": "15029232544",
            "jointHostUrl": "http://stest.qsh1.cn/a/OVUMIX7BB3BF",
            "livePullUrl": "https://ltest.qsh1.cn/activity/gdm9fD9",
            "hostJoinUrl": "https://mtest.qsh1.cn/k/mkmcZg2g550",
            "wcallUrl": "https://dwz.cn/nfZy5imC",
            "eventForm": 3,
            "length": 120,
            "hostId": 88406965,
            "title": "openapi-callback-1214白名单测试02",
            "billingCode": "95370645",
            "pcode2": "201501000037372252",
            "pcode1": "201501000037372251",
            "modifyTime": 1639471968,
            "conferenceId": "239604781",
            "audienceUnionUrl": "https://ltest.qsh1.cn/activity/gdm9fD9",
            "startTime": 1639497168,
            "endTime": 1639504368,
            "liveCover": "http://www.baidu.com",
            "guestJoinUrl": "http://stest.qsh1.cn/a/NVUMIXE158FD",
            "attendeeJoinUrl": "https://mtest.qsh1.cn/k/mkmcZhUrHxR"
        }
    ],
    "requestId": "10.255.0.106_20211214_165933_1639472373314"
}
    
  

