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