创建会议

创建一个日程。

请求参数:

Request Body.

Parameters Type/Value Require Description
name [string] 日程名称
outline [string] 会议描述
startTimestamp [long] 日程开始时间,为null时为立即会议
endTimestamp [long] 日程结束时间
host [string] 日程主持人的唯一标识
rooms [array] 关联的会议室id集合
users [array] 关联的人员id集合,如果是外部联系人可存放邮箱或电话
fileIds [array] 附件标识的id集合
deptIds [array] 部门id集合
contactIds [array] 联系人Id集合
contactGroupIds [array] 联系人分组id集合
publicFlag [boolean] 是否为公共会议
cycleType [string] 重复类型, ONCE=无重复,DAY=按日,WEEK=按周,MONTH=按月
cycleSettings [object] 周期设置,非周期会议时此值不传
networkSettings [object] 关联的网络会议,非网络会议时此值不传
phoneSettings [object] 关联的电话会议,非电话会议时此值不传
videoSettings [object] 关联的视频会议,非视频会议时此值不传
tencentSettings [object] 关联的腾讯会议,非腾讯会议时此值不传

CycleSettings object.

Parameters Type/Value Description
frequency [array] 1.按天重复:1=每天, 2=每个工作日;2.按周重复:1=周一,2=周二,3=周三,4=周四,5=周五,6=周六,7=周日; 3.按月重复:length=1时,value表示每月第几日;length=2时,index0=每月第几个星期,index1=周几(value值同按周重复)
endTimestamp [long] 重复周期的结束时间,和repeatTimes只能有一个生效; 按日/按周不能超过30天, 按月不能超过90天
repeatTimes [int] 重复次数,和endDate只能有一个生效;按日/按周不能超过30次,按月不能超过3次

NetworkSettings object.

Parameters Type/Value Description
password [string] 会议密码
numberOfParticipants [int] 会议方数
onlyParCanJoin [boolean] 仅受邀人可入会
screenWatermark [boolean] 屏幕水印
translation [boolean] 会中翻译

VideoSettings object.

Parameters Type/Value Require Description
password [string] 会议密码
mode [int] 会议模式,1 演讲模式; 2 讨论模式, 默认为2
mainVenue [string] 主会场,会议室标识,演讲模式时必须设置
meetingNumber [string] 入会号码,此参数为空时,会自动生成会议号
layout [string] 会议分屏, FULL(全屏),AUTO_EQUAL(等分屏),FOUR_MULTIPLY_FOUR(四分屏),ONE_PLUS_SEVEN(1+7),默认为FULL
joinMute [boolean] 新终端入会是否禁音,true 禁音,默认为false
autoCall [boolean] 是否自动呼叫终端,true 自动呼叫终端,默认为false
autoRecording [boolean] 是否开启自动录播,true 自动开启录播,默认为false
autoStreaming [boolean] 是否开启自动直播,true 自动开启直播,默认为false
server [object] 视频服务器,此参数为空时,会自动选择此刻可用的MCU,参考mcu接口中的server object

TencentSettings object.

Parameters Type/Value Description
password [string] 会议密码
type [int] 类型,0 - 预约会议 1 - 快速会议。
autoInWaitingRoom [boolean] 等候室

请求例子:

  • 通过CDN方式引入使用
    <script src="https://cdn.jsdelivr.net/npm/umeet-js-sdk@1.0.16/UmeetJsSdk.min.js" type="text/javascript"></script>
    <script type="text/javascript">
    // 创建会议
    function createMeeting() {
    let meetingObj = {
     name: '小明的会议',
     startTimestamp: new Date().getTime() + 6 * 60 * 60 * 1000,
     endTimestamp: new Date().getTime() + 7 * 60 * 60 * 1000,
     rooms: [],
     users: [],
     deptIds: [],
     host: 'xxx',
     outline: '',
     fileIds: [],
     cycleType: 'ONCE',
     videoSettings: null,
     networkSettings: {
       numberOfParticipants: 100,
       password: ''
     }
    }
    UmeetJsSdk.createMeeting(meetingObj, function (res) {
     if (res.status === 200) {
       scheduleId = res.data;
     } else {
       console.log(res.data.message);
     }
    })
    }
    </script>
    
  • 通过NPM引入使用
    import UmeetJsSdk from 'umeet-js-sdk';
    // 创建会议
    createMeeting () {
    let that = this;
    let meetingObj = {
     name: '小明的会议',
     startTimestamp: new Date().getTime() + 6 * 60 * 60 * 1000,
     endTimestamp: new Date().getTime() + 7 * 60 * 60 * 1000,
     rooms: [],
     users: [],
     deptIds: [],
     host: that.currentUser.id,
     outline: '',
     fileIds: [],
     cycleType: 'ONCE',
     videoSettings: null,
     networkSettings: {
       numberOfParticipants: 100,
       password: ''
     }
    }
    UmeetJsSdk.createMeeting(meetingObj).then(res => {
     if (res.status === 200) {
       scheduleId = res.data;
     } else {
       console.log(res.data.message);
     }
    })
    }
    

响应结果:

请求成功时,http status code =200,响应体内容如下:

Parameters Type/Value Description
data [string] id

如:

{
  status: 200,
  data: 'xxxx' // scheduleId
}

请求失败时,http status code = 500,响应体内容如下:

Parameters Type/Value Description
timestamp [string] 错误发生日期
errorCode [string] 错误码
message [string] 错误信息描述

results matching ""

    No results matching ""

    results matching ""

      No results matching ""