创建会议
描述
该接口用于创建立即会议和预约会议。
调试
您可以在API Explorer中调试该接口。
接口原型
请求方法 |
POST |
---|---|
请求地址 |
/v1/mmc/management/conferences |
传输协议 |
HTTPS |
请求参数
参数 |
是否必须 |
类型 |
位置 |
描述 |
---|---|---|---|---|
userUUID |
否 |
String |
Query |
用户的UUID。
说明:
该参数将废弃,请勿使用。 |
X-Access-Token |
是 |
String |
Header |
授权令牌。获取“执行App ID鉴权”响应的accessToken。 |
X-Authorization-Type |
否 |
String |
Header |
标识是否为第三方portal过来的请求。
说明:
该参数将废弃,请勿使用。 |
X-Site-Id |
否 |
String |
Header |
用于区分到哪个HCSO站点鉴权。
说明:
该参数将废弃,请勿使用。 |
startTime |
否 |
String |
Body |
会议开始时间(UTC时间)。格式:yyyy-MM-dd HH:mm。
说明:
|
length |
否 |
Integer |
Body |
会议持续时长,单位分钟。默认30分钟。 最大1440分钟(24小时),最小15分钟。 |
subject |
否 |
String |
Body |
会议主题。最多128个字符。 |
mediaTypes |
是 |
String |
Body |
会议的媒体类型。
|
groupuri |
否 |
String |
Body |
软终端创建即时会议时在当前字段带临时群组ID,由服务器在邀请其他与会者时在或者conference-info头域中携带。 长度限制为31个字符。 |
attendees |
否 |
Array of Attendee objects |
Body |
与会者列表。 |
cycleParams |
否 |
CycleParams object |
Body |
周期会议的参数,当会议是周期会议的时候该参数必须填写。 |
isAutoRecord |
否 |
Integer |
Body |
会议是否自动启动录制,在录播类型为:录播、录播+直播时才生效。默认为不自动启动。
|
encryptMode |
否 |
Integer |
Body |
会议媒体加密模式。默认值由企业级的配置填充。
|
language |
否 |
String |
Body |
会议通知短信或邮件的语言。默认中文。
|
timeZoneID |
否 |
String |
Body |
会议通知中会议时间的时区信息。时区信息,参考时区映射关系。
说明:
|
recordType |
否 |
Integer |
Body |
录播类型。默认为禁用。
|
liveAddress |
否 |
String |
Body |
主流直播推流地址,在录播类型为 :直播、直播+录播时有效。最大不超过255个字符。 |
auxAddress |
否 |
String |
Body |
辅流直播推流地址,在录播类型为 :直播、直播+录播时有效。最大不超过255个字符。 |
recordAuxStream |
否 |
Integer |
Body |
是否录制辅流,在录播类型为:录播、录播+直播时有效。默认只录制视频主流,不录制辅流。
|
confConfigInfo |
否 |
ConfConfigInfo object |
Body |
会议其他配置信息。 |
recordAuthType |
否 |
Integer |
Body |
录播观看鉴权方式,在录播类型为:录播、直播+录播时有效。
|
vmrFlag |
否 |
Integer |
Body |
是否使用云会议室或者个人会议ID召开预约会议。默认0。
|
vmrID |
否 |
String |
Body |
绑定给当前创会账号的VMR ID。通过查询云会议室及个人会议ID接口获取。
说明:
|
concurrentParticipants |
否 |
Integer |
Body |
会议方数,会议最大与会人数限制。
|
supportSimultaneousInterpretation |
否 |
Boolean |
Body |
会议是否支持同声传译
|
参数 |
是否必须 |
类型 |
描述 |
---|---|---|---|
userUUID |
否 |
String |
与会者的用户UUID。 |
accountId |
否 |
String |
与会者的账号。
|
appId |
否 |
String |
App ID。如果是APP ID鉴权场景,此项必填。参考“”“App ID的申请”。 |
name |
否 |
String |
与会者名称。长度限制为96个字符。 |
role |
否 |
Integer |
会议中的角色。默认为普通与会者。
|
phone |
否 |
String |
号码。支持SIP号码或者手机号码。
说明:
|
phone2 |
否 |
String |
预留字段,取值类型同参数“phone”。 |
phone3 |
否 |
String |
预留字段,取值类型同参数“phone”。 |
|
否 |
String |
邮件地址。需要发邮件通知时填写。 |
sms |
否 |
String |
短信通知的手机号码。需要发短信通知时填写。 |
isMute |
否 |
Integer |
用户入会时是否需要自动静音 。默认不静音。
说明:
仅会中邀请与会者时才生效。 |
isAutoInvite |
否 |
Integer |
会议开始时是否自动邀请该与会者。默认值由企业级配置决定。
说明:
仅并发会议资源的随机会议ID会议才生效。 |
type |
否 |
String |
终端类型,类型枚举如下:
|
address |
否 |
String |
预留字段,终端所在会议室信息。 |
deptUUID |
否 |
String |
部门ID。 |
deptName |
否 |
String |
部门名称。最大不超过128个字符。 |
参数 |
是否必须 |
类型 |
描述 |
---|---|---|---|
startDate |
是 |
String |
周期会议的开始日期,格式:YYYY-MM-DD。 开始日期不能早于当前日期。
说明:
日期是timeZoneID指定的时区的日期,非UTC时间的日期。 |
endDate |
是 |
String |
周期会议的结束日期,格式:YYYY-MM-DD。 开始日期和结束日期间的时间间隔最长不能超过1年。开始日期和结束日期之间最多允许50个子会议,若超过50个子会议,会自动调整结束日期。
说明:
日期是timeZoneID指定的时区的日期,非UTC时间的日期。 |
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 |
是否来宾免密。
说明:
仅随机会议ID的会议生效。 |
callInRestriction |
否 |
Integer |
允许加入会议的范围。
|
allowGuestStartConf |
否 |
Boolean |
是否允许来宾启动会议。
说明:
仅随机会议ID的会议生效。 |
guestPwd |
否 |
String |
来宾密码(4-16位长度的纯数字)。 |
vmrIDType |
否 |
Integer |
云会议室的会议ID模式。
|
prolongLength |
否 |
Integer |
自动延长会议时长(取值范围0-60)。
说明:
|
enableWaitingRoom |
否 |
Boolean |
是否开启等候室(只对MMR企业生效)。
|
isHostCameraOn |
否 |
Boolean |
主持人入会是否开启摄像头。 |
isGuestCameraOn |
否 |
Boolean |
来宾入会是否开启摄像头。 |
状态码
HTTP状态码 |
描述 |
---|---|
200 |
操作成功。 |
400 |
参数异常。 |
401 |
未鉴权或鉴权失败。 |
403 |
权限受限。 |
500 |
服务端异常。 |
响应参数
参数 |
类型 |
描述 |
---|---|---|
[数组元素] |
Array of ConferenceInfo |
会议信息列表。 |
参数名称 |
参数类型 |
描述 |
---|---|---|
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组成,多个枚举时,每个枚举值之间通过”,”逗号分隔。如:mediaTypes:“Voice,Data,HDVideo”
|
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 |
ConfConfigInfo object |
会议其他配置信息。 |
vmrFlag |
Integer |
是否使用云会议室或个人会议ID召开预约会议。
|
isHasRecordFile |
Boolean |
是否有会议录制文件。仅历史会议查询时返回。 true:有录制文件。 false:没有录制文件。 |
vmrConferenceID |
String |
云会议室会议ID或个人会议ID。如果“vmrFlag”为“1”,则该字段不为空。 |
confUUID |
String |
会议的UUID。
说明:
|
partAttendeeInfo |
Array of PartAttendee objects |
被邀请的部分与会者信息。 |
terminlCount |
Integer |
硬终端个数,如IdeaHub,TE30等。 |
normalCount |
Integer |
软终端个数,如PC端、手机端App等。 |
deptName |
String |
会议预定者的企业名称。 |
role |
String |
与会者角色。
说明:
|
multiStreamFlag |
Integer |
标识是否为多流视频会议。
|
webinar |
Boolean |
是否是网络研讨会。 |
onlineAttendeeAmount |
Integer |
当前在线与会人数。包含被邀入会和主动入会的与会者。
说明:
仅在“查询在线会议列表”接口中返回。 |
confMode |
String |
会议模型。
|
scheduleVmr |
Boolean |
VMR预约记录。
说明:
该参数将废弃,请勿使用。 |
vmrID |
String |
云会议室ID。 |
concurrentParticipants |
Integer |
会议最大与会人数。默认值0。
|
supportSimultaneousInterpretation |
Boolean |
会议是否支持同声传译
|
picDisplay |
MultiPicDisplayDO object |
多画面信息。 |
subConfs |
Array of Subconfs objects |
周期子会议列表。 |
cycleSubConfID |
String |
第一个周期子会议的UUID。 |
参数 |
参数类型 |
描述 |
---|---|---|
conferenceRole |
String |
会议角色。
|
password |
String |
会议中角色的密码(明文)。 |
参数 |
参数类型 |
描述 |
---|---|---|
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 |
子画面纵向尺寸。 |
参数 |
类型 |
描述 |
---|---|---|
startDate |
String |
周期会议的开始日期,格式:YYYY-MM-DD。 开始日期不能早于当前日期。
说明:
日期是timeZoneID指定的时区的日期,非UTC时间的日期。 |
endDate |
String |
周期会议的结束日期,格式:YYYY-MM-DD。 开始日期和结束日期间的时间间隔最长不能超过1年。开始日期和结束日期之间最多允许50个子会议,若超过50个子会议,会自动调整结束日期。
说明:
日期是timeZoneID指定的时区的日期,非UTC时间的日期。 |
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 |
是否来宾免密(仅随机会议有效)。
说明:
仅随机会议ID的会议生效。 |
callInRestriction |
Integer |
允许加入会议的范围。
|
allowGuestStartConf |
Boolean |
是否允许来宾启动会议。
说明:
仅随机会议ID的会议生效。 |
guestPwd |
String |
来宾密码(4-16位长度的纯数字)。 |
vmrIDType |
Integer |
云会议室的会议ID模式。
|
prolongLength |
Integer |
自动延长会议时长(取值范围0-60)。
说明:
|
enableWaitingRoom |
Boolean |
开启或者关闭等候室。
|
isHostCameraOn |
Boolean |
主持人入会是否开启摄像头。 |
isGuestCameraOn |
Boolean |
来宾入会是否开启摄像头。 |
请求消息示例
POST /v1/mmc/management/conferences Connection: keep-alive X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC Content-Type: application/json user-agent: WeLink-desktop Content-Length: 548 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "subject": "例行会议", "mediaTypes": "HDVideo", "startTime": "2022-08-30 12:00", "length": 60, "attendees": [ { "accountId": "zhangshan@huawei.com", "appId": "caaab5a3e584497990f6a9b582a0ae42" } ], "confConfigInfo": { "isSendNotify": false, "isSendSms": false, "isSendCalendar": false } }
响应消息示例
HTTP/1.1 200 Date: Wed, 18 Dec 2019 06:20:40 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 1153 Connection: keep-alive http_proxy_id: 79ea4d8bdb461a4b811a117f9cf3dbde Server: api-gateway X-Request-Id: 1ccc1d7937dd0f66067aeecb9f1df241 [ { "conferenceID": "914673889", "mediaTypes": "Data,Voice,HDVideo", "subject": "例行会议", "size": 1, "timeZoneID": "56", "startTime": "2022-08-30 12:00", "endTime": "2022-08-30 13:00", "conferenceState": "Schedule", "accessNumber": "+991117", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "chair", "password": "******" }, { "conferenceRole": "general", "password": "******" } ], "userUUID": "ff80808167ef1edf0167f339533d05a6", "scheduserName": "金秘书", "conferenceType": 0, "confType": "FUTURE", "isAutoMute": 1, "isAutoRecord": 0, "chairJoinUri": "https://c.meeting.huaweicloud.com/#/j/914673889/6a30b8b5a325105da031442627828e496f91021ece36405f", "guestJoinUri": "https://c.meeting.huaweicloud.com/#/j/914673889/9505dc3349228b1ce0db8165590cc977bcff89785130fe0d", "recordType": 2, "confConfigInfo": { "isSendNotify": false, "isSendSms": false, "isAutoMute": true }, "vmrFlag": 0, "partAttendeeInfo": [ { "phone": "+99111********4158", "name": "张三", "type": "normal" } ], "terminlCount": 0, "normalCount": 1, "deptName": "企业协同云服务项目群" } ]
错误码
当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心。
CURL命令示例
curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d '{"conferenceType": "0","subject": "user01 conference","mediaTypes": "HDVideo","attendees": [{"name": "user01","role": 1,"phone": "+8657*******"}]}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/conferences'