更新時間:2019-11-19
管理員或普通用戶可以通過該接口創(chuàng)建會議。
請求方法 |
POST |
---|---|
請求地址 |
/conferences |
傳輸協(xié)議 |
HTTPS |
參數(shù) |
是否必須 |
類型 |
位置 |
描述 |
---|---|---|---|---|
Authorization |
是 |
String |
Header |
授權(quán)令牌。將執(zhí)行鑒權(quán)響應的accessToken 樣例:Basic Base64(accessToken) |
conferenceType |
否 |
Int |
Body |
0 : 普通會議。 1:周期會議,此時“cycleParams”必須填寫。(預留字段) 默認值為0。 |
startTime |
否 |
String |
Body |
會議開始時間。使用UTC時間。
說明:
創(chuàng)建預約會議時,如果沒有指定開始時間或填空串,則表示會議馬上開始。 格式:YYYY-MM-DD HH:MM。 |
length |
否 |
Int |
Body |
會議持續(xù)時長,單位分鐘,最大值為1440。 默認值為30。 |
subject |
否 |
String |
Body |
會議主題。長度限制為128個字符。 |
mediaTypes |
是 |
String |
Body |
會議的媒體類型。 由1個或多個枚舉String組成,多個枚舉時,每個枚舉值之間通過“,”逗號分隔,枚舉值如下:
|
attendees |
否 |
Attendee[0..*] |
Body |
預定會議時,指定的與會者列表。 該與會者列表可以用于發(fā)送會議通知、會議提醒、會議開始時候進行自動邀請。 |
cycleParams |
有條件必選 |
Body |
周期會議的參數(shù),當會議是周期會議的時候該參數(shù)必須填寫,否則服務器忽略該參數(shù)。 該參數(shù)包括周期會議的開始日期、結(jié)束日期、會議的周期和周期中的開會時間點。 (預留字段) |
|
isAutoRecord |
否 |
Int |
Body |
會議是否自動啟動錄制,在錄播類型為:錄播、錄播+直播時才生效。
默認值為0。 |
encryptMode |
否 |
Int |
Body |
會議媒體加密模式。默認值由企業(yè)級的配置填充
|
language |
否 |
String |
Body |
會議的默認語言,默認值由會議AS定義。 對于系統(tǒng)支持的語言,按照RFC3066規(guī)范傳遞。
|
timeZoneID |
否 |
String |
Body |
開始時間的時區(qū)信息。 時區(qū)信息,參考時區(qū)映射關(guān)系。 |
recordType |
否 |
Int |
Body |
錄播類型。
默認值:0 |
liveChannelID |
否 |
String |
Body |
直播推流頻道ID,召開會議時,優(yōu)先根據(jù)此ID查詢頻道的URL,查詢不到則放棄推流;若不存在頻道ID則直接使用liveAddress/ auxAddress兩個URL。 |
liveAddress |
否 |
String |
Body |
主流直播地址,最大不超過255個字符,在錄播類型為:直播、錄播+直播時才生效。 |
auxAddress |
否 |
String |
Body |
輔流直播地址,最大不超過255個字符,在錄播類型為:直播、錄播+直播時才生效。 |
recordAuxStream |
否 |
Int |
Body |
是否錄制輔流,在錄播類型為:錄播、錄播+直播時才生效。
默認不錄制。 |
confConfigInfo |
否 |
Body |
會議其他配置信息。 |
|
vmrFlag |
否 |
Int |
Body |
是否使用VMR召開預約會議。
默認值:0 |
vmrID |
否 |
String |
Body |
用于識別用戶開會時綁定的VMR會議室。
|
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
userUUID |
否 |
String |
與會者的用戶uuid |
accountId |
否 |
String |
與會者帳號,兼容終端老版本。如果沒有攜帶userUUID,就通過accountId查詢用戶信息。 |
name |
否 |
String |
與會者名稱或昵稱。長度限制為96個字符。 長度:0-96。 |
role |
否 |
Int |
會議中的角色。
默認值為0。 |
phone |
是 |
String |
電話號碼(可支持SIP、TEL號碼格式)。最大不超過127個字符。
說明:
當“type”為“telepresence”時,且設備為三屏智真,則該字段填寫中屏號碼。(三屏智真為預留字段) |
phone2 |
否 |
String |
取值類型同參數(shù)“phone”。(預留字段)
說明:
當“type”為“telepresence”時,且設備為三屏智真,則該字段填寫左屏號碼。 |
phone3 |
否 |
String |
取值類型同參數(shù)“phone”。(預留字段)
說明:
當“type”為“telepresence”時,且設備為三屏智真,則該字段填寫右屏號碼。 |
|
否 |
String |
郵件地址。最大不超過255個字符。 |
sms |
否 |
String |
短信通知的手機號碼。最大不超過32個字符。 |
isAutoInvite |
否 |
Int |
會議開始時是否自動邀請該與會者。
默認值:1。 |
type |
否 |
String |
默認值由會議AS定義,號碼類型枚舉如下:
默認值為“normal”。 |
address |
否 |
String |
終端所在會議室信息。 |
deptName |
否 |
String |
組織名稱。最大不超過128個字符。 |
參數(shù) |
是否必須 |
類型 |
描述 |
---|---|---|---|
startDate |
是 |
String |
周期會議的開始日期,格式:YYYY-MM-DD。 開始日期不能早于當前日期。 |
endDate |
否 |
String |
周期會議的結(jié)束日期,格式:YYYY-MM-DD。 開始日期和結(jié)束日期間的時間間隔最長不能超過1年。 |
cycle |
是 |
String |
周期類型。
|
Interval |
否 |
Int |
默認值都為1。 |
poInt |
否 |
Int[0..*] |
周期內(nèi)的會議召開點。僅當按周和月時有效。 例如:
|
參數(shù) |
類型 |
描述 |
---|---|---|
returnCode |
Int |
返回碼。 |
returnDesc |
String |
返回描述。 |
data |
ConferenceInfo[0..*] |
會議信息。 |
參數(shù)名稱 |
參數(shù)類型 |
描述 |
---|---|---|
conferenceID |
String |
會議ID。長度限制為32個字符。 |
subject |
String |
會議主題。長度限制為128個字符。 |
size |
Int |
會議方數(shù)。 |
timeZoneID |
String |
時區(qū)參考。 |
startTime |
String |
會議起始時間 (YYYY-MM-DD HH:MM )。 |
endTime |
String |
會議結(jié)束時間 (YYYY-MM-DD HH:MM )。 |
mediaTypes |
String |
會議的媒體類型。 由1個或多個枚舉String組成,多個枚舉時,每個枚舉值之間通過”,”逗號分隔。
|
conferenceState |
String |
(目前只會返回Created和Schedule狀態(tài), 如果會議已經(jīng)召開返回Created狀態(tài),否則返回Schedule狀態(tài))
|
language |
String |
會議語言。 |
accessNumber |
String |
會議接入碼。 |
passwordEntry |
會議密碼條目。預訂者返回主席密碼和來賓密碼。
|
|
userUUID |
String |
會議預訂者userUUID。 |
scheduserName |
String |
會議預訂者帳號名稱。長度最大限制為96個字符。 |
multiStreamFlag |
Int |
標識是否為多流視頻會議。
|
conferenceType |
Int |
|
cycleParams |
周期會議的參數(shù)。當會議是周期會議的時候攜帶該參數(shù)。 該參數(shù)包括周期會議的開始日期、結(jié)束日期、會議的周期和周期中的開會時間點。 (預留字段) |
|
isAutoMute |
Int |
是否入會自動靜音。 |
isAutoRecord |
Int |
是否自動開啟錄音。 |
chairJoinUri |
String |
主席會議鏈接地址。 |
guestJoinUri |
String |
普通與會者會議鏈接地址。 |
recordType |
Int |
錄播類型。
|
auxAddress |
String |
輔流直播地址。 |
liveAddress |
String |
主流直播地址。 |
recordAuxStream |
Int |
是否錄制輔流。
|
liveUrl |
String |
直播地址。 |
confConfigInfo |
會議其他配置信息。 |
|
vmrFlag |
Int |
是否使用VMR召開預約會議。
|
vmrConferenceID |
String |
如果“vmrFlag”為“1”,則該字段不為空。 |
confUUID |
String |
會議的UUID。 |
isHasRecordFile |
Boolean |
|
partAttendeeInfo |
Attendee[0..*] |
與會方信息。硬件終端/與會人最多各顯示20條記錄。 |
terminlCount |
Int |
硬終端個數(shù)。 |
normalCount |
Int |
普通終端個數(shù)。 |
deptName |
String |
會議預定者的組織名稱。 |
POST /conferences Connection: keep-alive Authorization: Basic VFZQdG9tOUcwN2NMWGhMQ1phaXpRUDFsNkdlUzVvT05Q 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) { "mediaTypes": "Voice,Data", "attendees": [ { "name": "user01", "role": 1, "phone": "+8657*******" }], "conferenceType": 0, "subject": "user01的會議" }
HTTP/1.1 200 Date: Sat, 09 Mar 2019 07:11:20 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 { "returnCode": 0, "returnDesc": "Success", "data": [ { "conferenceID": "914271782", "mediaTypes": "Voice,Data,Video", "subject": "user01的會議", "size": 1, "timeZoneID": "56", "startTime": "2019-03-10 00:00", "endTime": "2019-03-10 02:00", "conferenceState": "Created", "accessNumber": "+8657*******", "language": "zh-CN", "passwordEntry": [ { "conferenceRole": "chair", "password": "222400" }, { "conferenceRole": "general", "password": "896775" }], "userUUID": "ff8080816933ab4801694865840a00c2", "scheduserName": "user01", "multiStreamFlag": 1, "conferenceType": 0, "isAutoMute": 1, "isAutoRecord": 0, "chairJoinUri": "https://nmeeting.huaweicloud.com:443/#/j/914271782?p=488a106894bf2d6f6bb6586a88b92e3f7e524a72bec23840", "guestJoinUri": "https://nmeeting.huaweicloud.com:443/#/j/914271782?p=47bc6947ee90a1f1be3b90c6f6e2bac59fb448e9bd90cc3c", "recordType": 0, "recordAuxStream": 0, "confConfigInfo": { "inviteMode": "AUTO_INVITE", "prolongLength": 15, "dispatchMode": "AUTO_DISPATCH", "isGuestFreePwd": false, "isSendNotify": true, "isSendSms": true, "isAutoMute": true }, "vmrFlag": 0, "scheduleVmr": false, "isHasRecordFile": false, "partAttendeeInfo": [ { "phone": "+8657*******", "name": "user01", "role": 1, "isMute": 1, "type": "normal" }], "terminlCount": 0, "normalCount": 0, "deptName": "huawei_ffl ", "confUUID": "19d6009f67fe11e9b78bbf16aed73b3c" }] }
curl -k -i -H 'content-type: application/json' -X POST -H 'Authorization:Basic T2FmNUppeGxvYms0MkZ4am45ZmdPR0dBOE1EYVZtMFBP'' -d '{"conferenceType": "0","subject": "user01 conference","mediaTypes": "HDVideo","attendees": [{"name": "user01","role": 1,"phone": "+8657*******"}]}' 'https://api.meeting.huaweicloud.com/conferences'