获取会议列表

列出用户管理的所有日程,支持分页。

请求参数:

Query Parameters.

Parameters Type/Value Require Description
page [int] 页码,默认1
size [int] 每页数量,1-200
filter [string] 根据关键字筛选日程,支持搜索:日程名、会议号、主持人名称
type [string] 会议类型,LOCAL_MEETING(本地会议),VIDEO_MEETING(视频会议),NETWORK_MEETING(网络会议),PHONE_MEETING(电话会议),FUSION_MEETING(融合会议)
status [string] 日程状态,默认返回已预约和进行中的;SCHEDULE=已预约;ONLINE=进行中;OFFLINE=已结束;PROCESSING=审批中;REJECT=已驳回
currentDate [long] 会议开始的当天日期
beginTimestamp [long] 查询开始时间,与endTimestamp联用,否则无效
endTimestamp [long] 查询结束时间,与beginTimestamp联用,否则无效
meetingNumber [string] 通过会议号精确匹配日程
participationType [string] 参会类型搜索; SPONSOR:发起人(创建人+主持人),CREATOR:创建人, 主持人身份:HOST, 参会者身份:PARTICIPANT, 公开会议:PUBLIC, 全部ALL/null

请求例子:

  • 通过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">
    // 获取会议列表
    var scheduleId = '';
    function getMeetings() {
     let params = {
       page: 1,
       size: 20,
       filter: '',
       currentDate: new Date().getTime()
     };
     UmeetJsSdk.getMeetings(params, function (res) {
       console.log(res)
       if (res.status === 200) {
         scheduleId = res.data.content[0].id;
       } else {
         console.log(res.data.message)
       }
     })
    }
    </script>
    
  • 通过NPM引入使用
    import UmeetJsSdk from 'umeet-js-sdk';
    // 获取会议列表
    getMeetings () {
    let that = this;
    let params = {
     page: 1,
     size: 20,
     filter: '',
     currentDate: new Date().getTime()
    };
    UmeetJsSdk.getMeetings(params).then(res => {
     console.log(res)
     if (res.status === 200) {
       that.scheduleId = res.data.content[0].id;
     } else {
       console.log(res.data.message)
     }
    })
    }
    

响应结果:

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

Schedule object list.

Parameters Type/Value Description
content [array] 日程对象集合
totalPages [long] 总页数
totalElements [long] 总条数

Schedule object.

Parameters Type/Value Description
id [string] 日程标识
name [string] 日程名称
type [string] 会议类型,LOCAL_MEETING(本地会议),VIDEO_MEETING(视频会议),NETWORK_MEETING(网络会议),PHONE_MEETING(电话会议),FUSION_MEETING(融合会议)
status [string] 日程状态,SCHEDULE=已预约;ONLINE=进行中
startTimestamp [long] 日程开始时间
endTimestamp [long] 日程结束时间
host [object] 日程主持人
numberOfUsers [int] 参会人数量
rooms [array] 参会会议室集合 room object
fileIds [array] 附件id的集合
publicFlag [boolean] 是否为公共会议
imNotice [boolean] 是否发送集成通知
emailNotice [boolean] 是否发送邮件
createByOutlook [boolean] 是否未outlook创建的会议
cycleId [string] 周期会议标识,单次会议时此值与会议标识相同
cycleType [string] 重复类型, ONCE=无重复,DAY=按日,WEEK=按周,MONTH=按月
cycleSettings [object] 周期设置,非周期会议时此值不返回
networkSettings [object] 网络会议设置,非网络会议时此值不返回
phoneSettings [object] 电话会议,非电话会议时此值不返回
videoSettings [object] 视频会议,非视频会议时此值不返回
simpleAttendList [array] 部分参会人员/部门信息,按照部门,系统人员,外部人员的顺序排序,最多显示5个

host object.

Parameters Type/Value Description
name [String] 主持人名称
deptId [String] 部门id
deptName [String] 部门名称

room object.

Parameters Type/Value Description
name [String] 会议室名称

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只能有一个生效
repeatTimes [int] 重复次数,和endDate只能有一个生效

SimpleAttendList object.

Parameters Type/Value Description
id [string] 用户/部门主键
name [string] 用户/部门名称
type [string] USER(系统用户),DEPT(部门),TEMPORARY(外部用户)

NetworkSettings object.

Parameters Type/Value Description
password [string] 会议密码
numberOfParticipants [int] 会议方数
joinUrl [string] 入会url
startUrl [string] 主持人入会url

VideoSettings object.

Parameters Type/Value Description
password [string] 会议密码
mode [boolean] 会议模式,true 演讲模式; false 讨论模式
mainVenue [string] 主会场,会议室标识
meetingNumber [string] 入会号码
layout [string] 会议分屏, FULL(全屏),AUTO_EQUAL(等分屏),FOUR_MULTIPLY_FOUR(四分屏),ONE_PLUS_SEVEN(1+7)
joinMute [boolean] 新终端入会是否禁音,true 禁音
autoCall [boolean] 是否自动呼叫终端,true 自动呼叫终端
autoRecording [boolean] 是否开启自动录播,true 自动开启录播
autoStreaming [boolean] 是否开启自动直播,true 自动开启直播

如:

{
  status: 200,
  data: {
    content: [ meeting object list], // 会议对象列表
    totalElements: 100, // 总数
    totalPages: 1 // 总页数
  }
  ...
}

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

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

results matching ""

    No results matching ""

    results matching ""

      No results matching ""