预约系列电话会议

1. 接口描述

接口名称:

/eventopenapi/event/train/create

发送方式:

POST

参数格式:

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

2. 电话会议系列会定义

  • 系列会特点: 系列会中每场会的会议ID, 会议主题,会议时间,会议白名单等不同, 但会议密码相同
  • 系列会的会议场数最大不能超过100场。
  • 预约系列会会议时间限制:
  系列系列会会议时间需满足: 后一场会允许提前入会时间 -  前一场会议计划结束时间   >= 120(min)
  • 修改系列会会议时间限制:
  修改时检查会议时间约束与预约会议时相同
  • 入会约束:
  入会时间在某场会议的允许提前入会时间到计划结束时间范围内则加入该场会。
  入会时间大于前一场会的计划结束时间小于后一场会的允许提前入会时间且前一场召开中则加入前一场会。
  入会时间大于前一场会的计划结束时间小于后一场会的允许提前入会时间且前一场会已结束则不能加入会议。
  入会时间大于等于后一场会的允许提前入会时间小于计划结束时间且前一场会在召开中则结束前一场会,加入后一场会。
  入会时间大于最后一场会的计划结束时间,且最后一场会召开中则中加入最后一场会。
  入会时间大于最后一场会的计划结束时间,且最后一场会已结束则不能入会。

3. 请求参数

参数 类型 必须 说明
token String 统一鉴权token
hostId Long 主持人ID
meetingInfo Array 系列会会议信息
eventForm Int 会议形式 1: 电话会议(目前只支持电话会议)
joinLimit Int 直播入会方式 0: 公开, 1: 白名单(默认1,且非白名单(电话入会)拒绝入会)

3.1 meetingInfo参数说明

参数 类型 说明
title String 会议主题, 主题不能超过30个字
startTime Long 开始时间(时间戳,单位秒)
endTime Long 结束时间(时间戳,单位秒)
manualService Int 是否需要项目经理开关,1: 开启,2: 关闭(默认1)
liveCover String 活动间(直播)封面图URL 尺寸1280x720px 图片小于2MB(jpg、png)
summary String 会议简介 简介内容不能超过500个字, 目前支持受限的Html标记
分段:p, span, ul, li, br
图形:img
字体:strong, em, u
preJoinTimeLimit Int 提前入会时间(分钟), 默认0,最大60分钟

创建电话会议系列会请求参数示例

{
  "token": "a8245e1a0c68fbcb22b2d90b63ea42c8",
  "hostId": 88589655,
  "callbackUrl":"http://www.quanshi.com/openapi/callback",
  "meetingInfo": [
    {
      "title": "xxxx公司系列会会 ",
      "startTime": 1655985738371,
      "endTime": 1655985758371,
      "liveCover": "https://img0.baidu.com/it/u=1540109528,3311100791&fm=26&fmt=auto&gp=0.jpg",
      "manualService":1,
      "preJoinTimeLimit":5,
      "summary": "openapi 测试会议...."
    },
    {
      "title": "xxxx公司系列会会 ",
      "startTime": 1655985808371,
      "endTime": 1655985958371,
      "liveCover": "https://img0.baidu.com/it/u=1540109528,3311100791&fm=26&fmt=auto&gp=0.jpg",
      "manualService":1,
      "preJoinTimeLimit":5,
      "summary": "请提前联系主讲人...."
    },
    {
      "title": "xxxx公司系列会会 ",
      "startTime": 1655985808371,
      "endTime": 1655985958371,
      "liveCover": "https://img0.baidu.com/it/u=1540109528,3311100791&fm=26&fmt=auto&gp=0.jpg",
      "manualService":1,
      "preJoinTimeLimit":5,
      "summary": "23点准时召开...."
    }
  ]
}

4. 返回参数

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

4.1 data 参数说明

参数 类型 说明
trainId Long 系列会议ID
eventList JSON Array 系列会议会议列表

4.2 eventList 参数说明

参数 类型 说明
eventId Long 会议ID
trainId Long 本场会所属系列会议ID
title String 会议主题
startTime Long 会议开始时间(时间戳,单位秒)
length Int 会议时长(时间戳,单位分钟)
eventForm Int 会议形式 1: 电话活动,3: 网络会议,4: 实时互动直播,7: 大型直播活动
summary String 会议概要
hostId Long 主持人ID
billingCode String 云会议计费BC
pcode1 String 主持人入会密码
pcode2 String 参会人入会密码
hostJoinUrl String 主持人入会链接
joinHostUrl String 助理主持人链接
guestJoinUrl String 嘉宾入会链接
audienceUnionUrl String 观众观看链接
testAudienceUnionUrl String 测试会观众观看链接
liveCover String 活动间(直播)封面图URL
callbackUrl String 会议回调地址
manualService Int 是否需要项目经理开关,1:开启,2:关闭
joinLimit Int 观众直播入会限制 0: 公开, 1: 白名单(非白名单(电话入会)拒绝入会)
preJoinTimeLimit Int 提前入会时间(分钟), 默认0,最大60分钟

5. 示例

输出示例

{
  "timeStamp": 1657682941299,
  "code": 200,
  "msg": "Successfully to create the event!",
  "data": [
    {
      "title": "云活动标准会议-001",
      "joinLimit": 0,
      "joinHostUrl": "http://stest.qsh1.cn/a/GVT6BXB599CB",
      "manualService": 1,
      "audienceUnionUrl": "https://l2.qsh1.cn/activity/1uDWBGl",
      "startTime": 1657715339724,
      "callbackUrl": "https://eventopenapi-dev.quanshi.com/eventopenapi/event/callback",
      "guestJoinUrl": "https://l2.qsh1.cn/activity/1u34RDD",
      "summary": "请提前联系主讲人",
      "eventId": 572328,
        "trainId": 98234,
      "hostJoinUrl": "http://stest.qsh1.cn/a/HVT6BXF2D33F",
      "length": 120,
      "hostId": 88408692,
      "billingCode": "95404541",
      "pcode2": "201501000037453348",
      "pcode1": "201501000037453347",
        "preJoinTimeLimit":5,
      "liveCover": "https://img0.baidu.com/it/u=1540109528,3311100791&fm=26&fmt=auto&gp=0.jpg"
    },
    {
      "title": "云活动标准会议-001",
      "joinLimit": 0,
      "joinHostUrl": "http://stest.qsh1.cn/a/GVT4DDFR",
      "manualService": 1,
      "audienceUnionUrl": "https://l2.qsh1.cn/activity/1uDWB",
      "startTime": 1657715341778,
      "callbackUrl": "https://eventopenapi-dev.quanshi.com/eventopenapi/event/callback",
      "guestJoinUrl": "https://l2.qsh1.cn/activity/1uDWB3Ol",
      "summary": "请提前联系主讲人",
      "eventId": 6023890,
        "trainId": 98234,
      "hostJoinUrl": "http://stest.qsh1.cn/a/HVT6BXF45YUT",
      "length": 120,
      "hostId": 88408692,
      "billingCode": "95404541",
        "preJoinTimeLimit":5,
      "pcode2": "201501000037453348",
      "pcode1": "201501000037453347",
      "liveCover": "https://img0.baidu.com/it/u=1540109528,3311100791&fm=26&fmt=auto&gp=0.jpg"
    },
    {
      "title": "云活动标准会议-001",
      "joinLimit": 0,
      "joinHostUrl": "http://stest.qsh1.cn/a/GVT6BXB599",
      "manualService": 1,
      "audienceUnionUrl": "https://l2.qsh1.cn/activity/1uDWB",
      "startTime": 1657715345700,
      "callbackUrl": "https://eventopenapi-dev.quanshi.com/eventopenapi/event/callback",
      "guestJoinUrl": "https://l2.qsh1.cn/activity/1uDW098",
      "summary": "请提前联系主讲人",
      "eventId": 592330,
        "trainId": 98234,
      "hostJoinUrl": "http://stest.qsh1.cn/a/HVT6BXF2D56F",
      "length": 120,
      "hostId": 88408692,
        "preJoinTimeLimit":5,
      "billingCode": "95404541",
      "pcode2": "201501000037453348",
      "pcode1": "201501000037453347",
      "liveCover": "https://img0.baidu.com/it/u=1540109528,3311100791&fm=26&fmt=auto&gp=0.jpg"
    }
  ],
  "requestId": "10.255.0.106_20220713_112859_1657682939816"
}