创建周期性会议
描述
该接口用于预约周期性会议。
调试
您可以在API Explorer中调试该接口。
接口原型
请求方法 |
POST |
---|---|
请求地址 |
/v1/mmc/management/cycleconferences |
传输协议 |
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 |
会议是否支持同声传译
|
状态码
HTTP状态码 |
描述 |
---|---|
200 |
操作成功。 |
400 |
参数异常。 |
401 |
未鉴权或鉴权失败。 |
403 |
权限受限。 |
500 |
服务端异常。 |
响应参数
参数 |
类型 |
描述 |
---|---|---|
[数组元素] |
Array of ConferenceInfo |
会议信息列表。 |
名称 |
类型 |
描述 |
---|---|---|
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 |
Confconfinginfo object |
周期子会议其他配置信息。 |
recordAuthType |
Integer |
观看/下载录播的鉴权方式。
|
description |
string |
会议描述。长度限制为200个字符。 |
名称 |
类型 |
描述 |
---|---|---|
callInRestriction |
Integer |
允许加入会议的范围。
|
audienceCallInRestriction |
Integer |
允许加入网络研讨会的观众范围。
|
allowGuestStartConf |
Boolean |
是否允许来宾启动会议。
说明:
仅随机会议ID有效。 |
enableWaitingRoom |
Boolean |
是否启用等候室。 |
showAudienceCountInfo |
ShowAudienceCountInfo object |
网络研讨会观众数显示策略。 |
请求消息示例
POST /v1/mmc/management/cycleconferences Connection: keep-alive X-Access-Token: cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN 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": "Data,Voice,HDVideo", "startTime": "", "length": 120, "timeZoneID": "56", "vmrFlag": 1, "vmrID": "ff80808167ef1edf0167f339533f05a8", "cycleParams": { "startDate": "2021-08-31", "endDate": "2021-09-02", "cycle": "Day", "interval": 1, "preRemindDays": 1 }, "attendees": [ { "userUUID": "ff80808167ef1edf0167f339533d05a6", "name": "苏州分部", "email": "******", "sms": "+991116006724", "deptName": "企业协同云服务项目群", "role": 0, "phone": "+99119*****724", "type": "normal" } ], "confConfigInfo": { "isSendNotify": "false", "isSendSms": "false", "isSendCalendar": "false" }, "recordType": 0 }
响应消息示例
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": "986256843", "mediaTypes": "HDVideo,Data,Voice", "subject": "例行周期会议", "size": 0, "timeZoneID": "56", "startTime": "2021-09-01 08:39", "endTime": "2021-09-01 09:09", "conferenceState": "Schedule", "accessNumber": "+86571150", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "chair", "password": "******" }, { "conferenceRole": "general", "password": "******" } ], "userUUID": "fe235be7aa6045b98a33f27b365cbca9", "scheduserName": "苏州分部", "multiStreamFlag": 1, "conferenceType": 2, "confType": "CYCLE", "cycleParams": { "startDate": "2021-09-01", "cycle": "Day", "endDate": "2021-09-02", "cycleCount": 0, "interval": 1, "preRemindDays": 1 }, "isAutoMute": 0, "isHardTerminalAutoMute": 0, "isSoftTerminalAutoMute": 0, "isAutoRecord": 0, "chairJoinUri": "https://100.95.188.184:443/#/j/986256843/fa4def332cb83f5b1ec74c64d0658a8570f45ad3e8d0df8c", "guestJoinUri": "https://100.95.188.184:443/#/j/986256843/53f55ec44263d666e8ed70594624aa10497c631a91d3b8c1", "recordType": 0, "recordAuxStream": 0, "recordAuthType": 2, "confConfigInfo": { "inviteMode": "AUTO_INVITE", "prolongLength": 15, "isGuestFreePwd": false, "isSendNotify": true, "isSendSms": true, "isSendCalendar": true, "isAutoMute": false, "isHardTerminalAutoMute": false, "callInRestriction": 0, "audienceCallInRestriction": 0, "allowGuestStartConf": true, "enableWaitingRoom": false }, "vmrFlag": 0, "scheduleVmr": false, "isHasRecordFile": false, "terminlCount": 0, "normalCount": 0, "deptName": "corpzxytest111", "confMode": "RTC", "webinar": false, "concurrentParticipants": 0, "subConfs": [ { "cycleSubConfID": "fe24d1350a3611ecbe71a328ac3ca004", "conferenceID": "986256843", "startTime": "2021-09-01 08:39", "endTime": "2021-09-01 09:09", "mediaType": "HDVideo,Data,Voice", "isAutoRecord": 0, "recordAuthType": 2, "confConfigInfo": { "callInRestriction": 0, "audienceCallInRestriction": 0, "allowGuestStartConf": true, "enableWaitingRoom": false } }, { "cycleSubConfID": "fe24d1360a3611ecbe71fdd2c36bc8c2", "conferenceID": "986256843", "startTime": "2021-09-02 08:39", "endTime": "2021-09-02 09:09", "mediaType": "HDVideo,Data,Voice", "isAutoRecord": 0, "recordAuthType": 2, "confConfigInfo": { "callInRestriction": 0, "audienceCallInRestriction": 0, "allowGuestStartConf": true, "enableWaitingRoom": false } } ] } ]
错误码
当您使用华为云会议服务端API时,如果遇到“MMC”或者“USG”开头的错误码,请参考华为云API错误中心。
CURL命令示例
curl -k -i -H 'content-type: application/json' -X POST -H 'X-Access-Token:cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN' -d '{"conferenceType": "2","subject": "user01 conference","mediaTypes": "HDVideo","attendees": [{"name": "user01","role": 1,"phone": "+8657*******"}], "cycleParams": {"startDate": "2021-08-31","endDate": "2021-09-02","cycle": "Day","interval": 1,"preRemindDays": 1}}' 'https://api.meeting.huaweicloud.com/v1/mmc/management/cycleconferences'