1、會議功能通知消息
云通訊平臺向應用服務器發送的請求消息，包括會議創建通知、加入會議通知、退出會議通知、會議DTMF上報通知、會議邀請結果通知、會議媒體控制結果通知、會議被刪除通知、設置(取消)會議計時鬧鐘結果通知、會議狀態通知、會議鬧鐘到時后通知、解散會議操作結果通知等。
1.1 會議創建通知
會議創建成功會發送此請求，URL中<createconfsucc>可通過<CreateConf>命令中的action屬性自定義
請求地址
POST /<createconfsucc>?appid={appid}&callid={callid}&confid={confid}&createtime={createtime} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
必須 |
創建會議的用戶callid， 一個由32位數字、字符組成的唯一通話標識符，若由RestAPI創建的會議此參數為空。 |
| confid |
必須 |
一個由4－8位數字組成標識符。 |
| createtime |
必須 |
會議創建時間，格式yyyymmddhhmm |
| appid |
必須 |
應用id |
1.2 加入會議通知
云平臺會向應用服務器側發送此請求消息，包括創建會議、加入會議、邀請加入會議操作通知。 URL中<custom>可通過<JoinConf>命令中的action屬性和<CreateConf>、<InviteJoinConf>命令中的joinurl屬性自定義。當<JoinConf>、<InviteJoinConf>命令中有action或joinurl屬性，則回調joinurl配置的地址，否則回調<CreateConf>命令中的joinurl屬性地址。
請求地址
POST /<custom>?appid={appid}&callid={callid}&confid={confid}&jointime={jointime} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
必須 |
一個由32位數字、字符組成的唯一標識符。 |
| confid |
必須 | 加入會議的會議id。 |
| jointime |
必須 |
加入會議時間，格式yyyymmddhhmm |
| number |
可選 |
手機號、座機號或通訊帳號 |
| appid |
必須 |
應用id |
1.3 退出會議通知
退出會議后會發送此請求，包括在創建會議和退出會議都有此通知。URL中<quitconfsucc>可通過<QuitConf>命令中的action屬性和<CreateConf>指令中的quiturl屬性自定義。當<QuitConf>命令中有action屬性，則回調action配置的地址，否則回調<CreateConf>命令中的quiturl屬性地址。
請求地址
POST /<quitconfsucc>?appid={appid}&callid={callid}&quittime={quittime} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
必須 |
一個由32位數字、字符組成的唯一標識符。 |
| quittime |
必須 |
退出會議時間，格式yyyymmddhhmm。 |
| confid |
必須 |
會議id |
| appid |
必須 |
應用id |
1.4 會議DTMF上報通知
向應用服務器上報用戶在會議中按鍵，在創建會議中配置此URL。URL中<customurl>可通過<CreateConf>命令中的dtmfreporturl屬性自定義
請求地址
POST /<customurl>?appid={appid}&confid={confid}&callid={callid}&digits={digits} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
必須 |
一個由32位數字、字符組成的唯一標識符。 |
| confid |
必須 |
會議id。 |
| digits |
必須 |
用戶按鍵內容。 |
| appid |
必須 |
應用id |
1.5 會議邀請結果通知
應用服務器側發起邀請加入會議消息后，結果通過此請求通知應用服務器，和startservice通知消息意義相同。但當用戶結束通話后會有stopservice通知消息。URL中custom可通過<InviteJoinConf>命令中的action屬性自定義。
請求地址
POST /<custom>?appid={appid}&callid={callid}&confid={confid}&result={result}&number={number} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
可選 |
被邀請者呼叫id。result=0時callid才有效。 |
| jointime |
可選 |
加入會議時間，格式yyyymmddhhmm。 |
| confid |
必須 |
會議ID。 |
| result |
必須 |
操作結果?！?成功 ，其它值為失敗。 |
| number |
可選 |
被邀請者號碼。 |
| appid |
必須 |
應用id |
1.6 會議媒體控制結果通知
云平臺會向應用服務器側發送此請求消息，包括靜音、取消靜音、會議放音、停止會議放音、會議錄音、停止會議錄音、調節會議音量、會議成員禁聽、取消會議成員禁聽、創建會議操作通知。當應用服務器側調用<ConfPlay>、<ConfStopPlay>、<ConfRecord>、<ConfstopRecord>、<ConfVolumeAdjust> 、<ConfMute>、<ConfUnMute>、<ConfMemberPause>、<ConfMemberResume>命令時，若屬性action有內容則會上報結果事件，在<CreateConf>命令中的mediaopturl屬性也可以設置此回調地址。當發起以上命令（除了創建會議）時，若有action屬性，則回調action配置的地址，否則回調<CreateConf>命令中的mediaopturl屬性地址。
請求地址
POST /<coustom>?appid={appid}&confid={confid}&callid={callid}¬ifytype={notifytype}&result={result}&state={state}&recordurl={recordurl}&recordduration={recordduration} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| confid |
必須 |
會議ID。 |
| callid |
可選 |
呼叫id。對參會者操作時值有效。 |
| notifytype |
必須 |
操作類型 1放音、2錄音、3調大音量、4靜音5禁聽6收鍵；11停止放音、12停止錄音、13調小音量、14取消靜音、15取消禁聽。 |
| result |
必須 |
操作結果?！?成功 ，其它值為失敗。 |
| state |
可選 |
會議或用戶狀態，空值或0無意義。只有result為0時此值才有意義。 會議狀態：1放音中、2錄音中、11放音完成、12錄音完成。 用戶狀態：4靜音、14取消靜音5禁聽、15取消禁聽、6收鍵中，callid有值有效。 |
| recordurl |
可選 |
錄音文件下載地址當notifytype=12、result=0、state=12時，此參數才有內容。 |
| recordduration |
可選 |
錄音時長。 |
| appid |
必須 |
應用id |
1.7 會議被刪除通知
當會議中的最一個人退出會議后，會議被自動刪除，包括創建會議、解散會議操作時會發此請求通知應用側服務器。URL中<delreporturl>可通過<DismissConf>、<CreateConf> 命令中的delurl屬性自定義。當<DismissConf>命令中有delurl屬性，則回調delurl配置的地址，否則回調<CreateConf>命令中的delurl屬性地址。
請求地址
POST /<delreporturl>?appid={appid}&confid={confid}&deltime={deltime}&recordurl={recordurl} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| confid | 必須 |
一個由4-8位數字組成的標識符。 |
| deltime |
必須 |
會議被刪除時間，格式yyyymmddhhmm。 |
| appid | 必須 | 應用id |
1.8 設置(取消)會議計時鬧鐘結果通知
設置計時鬧鐘成功或失敗結果會發送此請求。URL中<customurl>可通過<ConfAlarmClock>命令中的action屬性自定義
請求地址
POST /<customurl>?appid={appid}&confid={confid}&status={status}&time={time}&clockid={clockid} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| confid |
必須 |
一個由4-8位數字組成的標識符。 |
| status |
必須 |
結果值0成功，其它值為失敗。 |
| appid | 必須 |
應用id |
| time | 必須 |
鬧鐘時長，以秒為單位。若有多個以%23分隔 |
| clockid | 必須 |
鬧鐘時長，以秒為單位。若有多個以%23分隔 |
1.9 會議狀態通知
查詢會議狀態后發送的通知請求。URL中<customurl>可通過<QueryConfState>命令中的action屬性自定義
請求地址
POST /<customurl>?appid={appid}&confid={confid}&count={count}&createtime={createtime}&state={state} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| confid |
必須 |
會議ID，一個由4-8位數字組成的標識符。 |
| count |
可選 |
當前會議人數。 |
| createtime |
可選 |
會議創建時間，格式yyyymmddhhmm。 |
| state |
必須 |
當前會議狀態0會議解散，其它值參考會議媒體控制結果通知參數。 |
| appid |
必須 |
應用id |
1.10 會議鬧鐘到時后通知
設置計時鬧鐘時間到后發送的通知請求，URL中<custom>可通過<ConfAlarmClock>命令中的clockurl屬性自定義。
請求地址
POST /<customurl>?appid={appid}&confid={confid}&clockid={clockid} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| confid |
必須 |
會議ID，一個由4-8位數字組成的標識符。 |
| clockid | 必選 | 由數字字母組成的字符串。 |
| appid | 必須 | 應用id |
1.11 解散會議操作結果通知
執行解散會議命令后的操作結果
POST /<customurl>?appid={appid}&confid={confid}&status={status} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| confid |
必須 |
一個由4-8位數字組成的標識符。 |
| status |
必須 |
結果值0成功，其它值為失敗。 |
| appid | 必須 |
應用id |