请登录后查看
SearchOnlineMeetings
查询在线会议列表
该接口用于查询正在召开的会议列表。管理员可以查询本企业内所有在线会议,普通用户仅能查询当前自己帐号创建或者需要参加的在线会议。不带查询参数时,默认查询权限范围内的在线会议,按开始时间升序排列。
名称 | 类型 | IN | 必选 | 描述 |
---|---|---|---|---|
X-Site-Id | string | header | 否 | 用于区分到哪个HCSO站点鉴权。
|
X-Authorization-Type | string | header | 否 | 标识是否为第三方portal过来的请求。
|
X-Access-Token | string | header | 是 | Access Token。通过 执行App ID鉴权接口返回的accessToken。 |
searchKey | string | query | 否 | 查询条件 。会议主题、会议预约人和会议ID等可作为搜索内容。长度限制为1-128个字符。 |
queryAll | boolean | query | 否 | 指定是否查询企业下所有用户的在线会议。默认值是false。
|
limit | integer | query | 否 | 查询数量。默认是20,最大500条。 |
offset | integer | query | 否 | 查询偏移量。默认为0。 |
userUUID | string | query | 否 | 用户的UUID。
|
操作成功。
名称 | 类型 | 描述 |
---|---|---|
offset | integer | 查询偏移量。 |
limit | integer | 每页的记录数。 |
count | integer | 总记录数。 |
data | Array of ConferenceInfo objects | 会议列表。 |
名称 | 类型 | 描述 |
---|---|---|
conferenceID | string | 会议ID。 |
subject | string | 会议主题。 |
size | integer | 会议预约时添加的会议者数量。 |
timeZoneID | string | 会议通知中会议时间的时区信息。时区信息,参考时区映射关系。 |
startTime | string | 会议起始时间 (YYYY-MM-DD HH:MM )。 |
endTime | string | 会议结束时间 (YYYY-MM-DD HH:MM )。 |
mediaTypes | string | 会议的媒体类型。 由1个或多个枚举String组成,多个枚举时,每个枚举值之间通过”,”逗号分隔。
|
conferenceState | string | 会议状态。
|
language | string | 会议通知短信或邮件的语言。默认中文。
|
accessNumber | string | 会议接入的SIP号码。 |
passwordEntry | Array of PasswordEntry objects | 会议密码。
|
userUUID | string | 会议预订者的用户UUID。 |
scheduserName | string | 会议预订者名称。 |
conferenceType | integer | 会议类型。
|
confType | string | 会议类型。
|
cycleParams | CycleParams object | 周期会议参数。当会议是周期会议的时候携带该参数。 |
isAutoMute | integer | 是否入会自动静音。
|
isAutoRecord | integer | 是否自动开启云录制。
|
chairJoinUri | string | 主持人会议链接地址。 |
guestJoinUri | string | 普通与会者会议链接地址。 |
audienceJoinUri | string | 网络研讨会观众会议链接地址。 |
recordType | integer | 录播类型。
|
auxAddress | string | 辅流直播推流地址。 |
liveAddress | string | 主流直播推流地址。 |
recordAuxStream | integer | 是否录制辅流。
|
recordAuthType | integer | 观看/下载录播的鉴权方式。
|
liveUrl | string | 直播观看地址。 |
confConfigInfo | RestConfConfigDTO object | 会议其他配置信息。 |
vmrFlag | integer | 是否使用云会议室或个人会议ID召开预约会议。
|
isHasRecordFile | boolean | 是否有会议录制文件。仅历史会议查询时返回。
|
vmrConferenceID | string | 云会议室会议ID或个人会议ID,如果vmrFlag为"1",则该字段不为空。 |
confUUID | string | 会议的UUID。
|
partAttendeeInfo | Array of PartAttendee objects | 被邀请的部分与会者信息。 |
terminlCount | integer | 硬终端个数,如IdeaHub,TE30等。 |
normalCount | integer | 软终端个数,如PC端、手机端App等。 |
deptName | string | 会议预定者的企业名称。 |
vmrID | string | 云会议室的ID。 |
role | string | 与会者角色。
|
webinar | boolean | 是否是网络研讨会。 |
onlineAttendeeAmount | integer | 当前在线与会人数。包含被邀入会和主动入会的与会者。
|
multiStreamFlag | integer | 标识是否为多流视频会议。
|
confMode | string | 会议类型模型。
|
scheduleVmr | boolean | VMR预约记录。 true: VMR预约记录 false:普通会议
|
concurrentParticipants | integer | 会议最大与会人数。默认值0。
|
supportSimultaneousInterpretation | boolean | 会议是否支持同声传译。默认值false。
|
picDisplay | MultiPicDisplayDO object | 多画面信息。 |
subConfs | Array of CycleSubConf objects | 周期子会议列表。 |
cycleSubConfID | string | 第一个周期子会议的UUID。 |
名称 | 类型 | 描述 |
---|---|---|
conferenceRole | string | 会议角色。
|
password | string | 会议中角色的密码(明文)。 |
名称 | 类型 | 描述 |
---|---|---|
startDate | string | 周期会议的开始日期,格式:YYYY-MM-DD。 开始日期不能早于当前日期。
|
endDate | string | 周期会议的结束日期,格式:YYYY-MM-DD。 开始日期和结束日期间的时间间隔最长不能超过1年。开始日期和结束日期之间最多允许50个子会议,若超过50个子会议,会自动调整结束日期。
|
cycle | string | 周期类型。
|
interval | integer | 子会议间隔。
|
point | Array of integers | 周期内的会议召开点。仅当按周和月时有效。
|
preRemindDays | integer | 提前通知天数。所有与会者在每个子会议开始前N天收到会议通知。取值范围[0,30]。 默认值是1。 |
名称 | 类型 | 描述 |
---|---|---|
isSendNotify | boolean | 是否需要发送会议邮件通知。默认值由企业级配置决定。
|
isSendSms | boolean | 是否需要发送会议短信通知。默认值由企业级配置决定。
|
isSendCalendar | boolean | 是否需要发送会议邮件日历通知。默认值由企业级配置决定。
|
isAutoMute | boolean | 来宾入会,软终端是否自动静音。默认值由企业级配置决定。
|
isHardTerminalAutoMute | boolean | 来宾入会,硬终端是否自动静音。默认值由企业级配置决定。
|
isGuestFreePwd | boolean | 是否来宾免密。
|
callInRestriction | integer | 允许加入会议的范围。
|
allowGuestStartConf | boolean | 是否允许来宾启动会议。
|
guestPwd | string | 来宾密码(4-16位长度的纯数字)。 |
vmrIDType | integer | 云会议室的会议ID模式。
|
prolongLength | integer | 自动延长会议时长(取值范围0-60)。
|
enableWaitingRoom | boolean | 开启或者关闭等候室。
|
isHostCameraOn | boolean | 主持人入会是否开启摄像头。
|
isGuestCameraOn | boolean | 来宾入会是否开启摄像头。
|
名称 | 类型 | 描述 |
---|---|---|
name | string | 与会者名称。 |
phone | string | 号码。SIP号码或者手机号码。 |
phone2 | string | 预留字段,取值类型同参数“phone”。 |
phone3 | string | 预留字段,取值类型同参数“phone”。 |
type | string | 终端类型,类型枚举如下:
|
role | integer | 用户入会时是否需要自动静音 。默认不静音。
|
isMute | integer | 用户入会时是否需要自动静音。默认不静音。
|
名称 | 类型 | 描述 |
---|---|---|
manualSet | integer | 是否为手工设置多画面。
|
imageType | string | 画面类型。取值范围:
|
subscriberInPics | Array of PicInfoNotify objects | 子画面列表。 |
switchTime | integer | 表示轮询间隔,单位:秒。当同一个子画面中包含有多个视频源时,此参数有效。 |
picLayoutInfo | PicLayoutInfo object | 自定义多画面布局信息。预留字段,当前不支持。 |
名称 | 类型 | 描述 |
---|---|---|
index | integer | 多画面中每个画面的编号,编号从1开始。 |
id | Array of strings | 每个画面中的与会者SIP号码。SIP号码可以通过查询企业通讯获取。 |
share | integer | 是否为辅流。
|
名称 | 类型 | 描述 |
---|---|---|
x | integer | 横向小格子数。 |
y | integer | 纵向小格子数。 |
subPicLayoutInfoList | Array of SubPicLayoutInfo objects | 多画面信息。 |
名称 | 类型 | 描述 |
---|---|---|
id | integer | 多画面信息。 |
left | integer | 子画面从左到右的索引。 |
top | integer | 子画面从上到下的索引。 |
xSize | integer | 子画面横向尺寸。 |
ySize | integer | 子画面横向尺寸。 |
名称 | 类型 | 描述 |
---|---|---|
cycleSubConfID | string | 子会议UUID。 |
conferenceID | string | 会议ID。 |
mediaType | string | 会议的媒体类型。
|
startTime | string | 会议起始时间(格式:YYYY-MM-DD HH:MM)。 |
endTime | string | 会议结束时间(格式:YYYY-MM-DD HH:MM)。 |
isAutoRecord | integer | 是否自动开启云录制。
|
confConfigInfo | CycleSubConfConfigDTO object | 周期子会议其他配置信息。 |
recordAuthType | integer | 观看/下载录播的鉴权方式。
|
description | string | 会议描述。长度限制为200个字符。 |
名称 | 类型 | 描述 |
---|---|---|
callInRestriction | integer | 允许加入会议的范围。
|
audienceCallInRestriction | integer | 允许加入网络研讨会的观众范围。
|
allowGuestStartConf | boolean | 是否允许来宾启动会议。
|
enableWaitingRoom | boolean | 是否启用等候室。 |
showAudienceCountInfo | ShowAudienceCountInfo object | 网络研讨会观众数显示策略。 |
名称 | 类型 | 描述 |
---|---|---|
showAudienceMode | integer | 观众显示策略。
|
baseAudienceCount | integer | 基础人数。范围是0~10000。 |
multiple | double | 倍增倍数。范围是1~10, 支持设置到小数点后1位。 |
参数异常。
名称 | 类型 | 描述 |
---|---|---|
error_code | string | 错误码。 |
error_msg | string | 错误码描述。 |
未鉴权或鉴权失败。
名称 | 类型 | 描述 |
---|---|---|
error_code | string | 错误码。 |
error_msg | string | 错误码描述。 |
服务端异常。
名称 | 类型 | 描述 |
---|---|---|
error_code | string | 错误码。 |
error_msg | string | 错误码描述。 |
"GET https://{endpoint}/v1/mmc/management/conferences/online"
操作成功。
{
"data": [
{
"conferenceID": "914694284",
"subject": "民主生活会",
"size": 1,
"timeZoneID": "56",
"startTime": "2020-02-27 09:06",
"endTime": "2020-02-27 10:06",
"mediaTypes": "Data,Voice,HDVideo",
"conferenceState": "Created",
"language": "zh-CN",
"accessNumber": "+991117",
"passwordEntry": [
{
"conferenceRole": "chair",
"password": "156775"
},
{
"conferenceRole": "general",
"password": ""
}
],
"userUUID": "ff80808167ef1edf0167f339533d05a6",
"scheduserName": "金秘书",
"conferenceType": 0,
"confType": "IMMEDIATELY",
"isAutoMute": 1,
"isAutoRecord": 0,
"chairJoinUri": "https://bmeeting.huaweicloud.com/#/j/914694284/556672392954944000000000000000000000000000000000",
"guestJoinUri": "https://bmeeting.huaweicloud.com/#/j/914694284",
"recordType": 0,
"confConfigInfo": {
"isSendNotify": false,
"isSendSms": false,
"isSendCalendar": false,
"isGuestFreePwd": true,
"isAutoMute": false,
"prolongLength": 15,
"dispatchMode": "MANUAL_DISPATCH",
"callInRestriction": 0,
"allowGuestStartConf": true,
"isHardTerminalAutoMute": true,
"enableWaitingRoom": true
},
"vmrFlag": 1,
"vmrConferenceID": "912731059",
"confUUID": "870517df591311eaa7cd659f3b7af64a",
"partAttendeeInfo": [
{
"phone": "+991116006724",
"name": "苏州分部",
"type": "normal"
}
],
"terminlCount": 0,
"normalCount": 1,
"deptName": "企业协同云服务项目群",
"vmrID": "ff80808167ef1edf0167f339533f05a8"
}
],
"offset": 0,
"limit": 20,
"count": 1
}
参数异常。
{
"error_code": "MMC.111070001",
"error_msg": "CONF_BAD_REQUEST"
}
未鉴权或鉴权失败。
{
"error_code": "MMC.118000001",
"error_msg": "USER_TOKEN_AUTH_FAILED"
}
服务端异常。
{
"error_code": "MMC.11070003",
"error_msg": "CONF_EXCEPTION"
}