1、基礎業務通知消息
云通訊平臺向應用服務器側發起的請求消息，包括啟動業務、結束業務、按鍵信息上報、錄音完成通知、被咨詢側應答通知、咨詢通話設置時間結束咨詢側通知、被咨詢側掛機通知、咨詢側主動結束咨詢呼叫、呼轉請求、指定呼轉、通話結束后發給被咨詢側的通知、默認通知接口、DTMF發送結果通知、咨詢通話設置時間結束被咨詢側通知、被咨詢側未接聽掛機通知等。
1.1 啟動業務
用戶呼叫到達云通訊平臺后，云平臺向應用服務器發送此請求消息。消息關鍵字為startservice(URL中的消息關鍵字“startservice”內容為固定內容，不可變)。
請求地址
POST /startservice?appid={appid}&callid={callid}&from={from}&to={to}&direction={direction}&userdata={userdata} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
必須 |
一個由32位數字、字符組成的唯一呼叫標識符 |
| from |
可選 | 主叫電話號碼，IVR呼入的主叫號碼。通過外呼方式則會為空。 |
| to |
必須 |
被叫電話號碼 |
| direction |
必須 |
呼叫方向，取值有0（呼入），1（呼出） |
| appid | 必須 |
應用id |
| userdata | 可選 | 用戶參數，Dial命令中使用，來源IVR外呼請求中的userdata參數 |
1.2 結束業務
用戶業務session結束后，由云平臺向應用側發起的請求,url中錄音信息為咨詢呼叫的錄音內容。消息關鍵字為stopservice。
請求地址
POST /stopservice?appid={appid}&callid={callid}&starttime={starttime}&endtime={endtime}&callduration={callduration}&sstime={sstime}&setime={setime}&seccallduration={seccallduration}&recordurl={recordurl}&recordid={recordid}&errorcode={errorcode} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
必須 |
一個由32位數字、字符組成的唯一呼叫標識符 |
| callduration |
可選 |
主叫的通話時長，單位：秒 |
| recordurl |
有錄音必須 |
錄音存放地址 |
| recordid |
有錄音必須 |
錄音文件Id |
| errorcode |
必須 |
一個6位的數字串 |
| appid |
必須 |
應用id |
| seccallduration | 必須 | 主叫與被叫的通話時長。只記錄最后一次的通話時長，單位是秒，注：此參數對于坐席通話不生效 |
| starttime | 可選 | 主叫開始時間，格式yyyyMMddHHmmss，當callduration=0時不帶此參數 |
| endtime | 可選 |
主叫結束時間，格式yyyyMMddHHmmss，當callduration=0時不帶此參數 |
| sstime | 可選 | 被叫開始時間，格式yyyyMMddHHmmss，當seccallduration=0時不帶此參數 |
| setime | 可選 |
被叫結束時間，格式yyyyMMddHHmmss，當seccallduration=0時不帶此參數 |
1.3 按鍵信息上報
當使用獲取按鍵命令用戶有按鍵時，云平臺會向應用側發起此請求上報按鍵內容，URL中的“dtmfreport”內容可由<Get>命令的action屬性自定義。消息關鍵字為dtmfreport。
請求地址
POST /dtmfreport?appid={appid}&callid={callid}&digits={digits} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
必須 |
一個由32位數字、字符組成的唯一呼叫標識符 |
| digits |
必須 |
用戶的按鍵內容，為0123456789#*值 |
| appid | 必須 | 應用id |
1.4 錄音完成通知
錄音時完成錄音(打斷錄音、錄音時間到、錄音中掛機)后，由云平臺向應用側發起的請求消息，URL中“recordover”可通過<Record>命令中的action屬性和<Record>命令中的recordurl屬性自定義。消息關鍵字為recordover。
請求地址
POST /recordover?appid={appid}&callid={callid}&recordduration={recordduration}&recordurl={recordurl} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
必須 |
一個由32位數字、字符組成的唯一呼叫標識符 |
| recordduration |
可選 |
通話時長，單位：秒 |
| recordurl |
有錄音必須 |
錄音存放地址 |
| appid | 必須 | 應用id |
1.5 被咨詢側應答通知
當咨詢呼叫命令中訂閱此通知(<ConsultationCall>命令中有action屬性)時，被咨詢側應答時云平臺會向應用側發起此請求，URL中<answerurl>內容可通過<ConsultationCall>命令中的action屬性自定義，若為空則不發送此請求。消息關鍵字為answerurl。
請求地址
POST /answerurl?appid={appid}&callid={callid}&mcallid={mcallid}&answertime={answertime} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
必須 |
一個由32位數字、字符組成的唯一呼叫標識符 |
| mcallid |
必須 |
主叫用戶的callid |
| answertime |
必須 |
咨詢側應答時間 |
| appid |
必須 |
應用id |
1.6 咨詢通話設置時間結束咨詢側通知
當咨詢呼叫設置通話時間到后，云平臺會向應用側發起此請求，以通知應用側咨詢側通話時間到處理咨詢側后續邏輯。URL中<calltimeover>內容可通過<ConsultationCall>命令中的calltimeoverurl屬性自定義，若為空則不發送此請求。消息關鍵字為calltimeover。
請求地址
POST /calltimeover?appid={appid}&callid={callid} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
必須 |
一個由32位數字、字符組成的唯一呼叫標識符 |
| appid |
必須 |
應用id |
1.7 被咨詢側掛機通知
咨詢呼叫或呼叫轉接在通話中咨詢側掛機時云平臺會向應用側發起此請求，URL中的<hangup>內容可通過<ConsultationCall>或<TransferCall>命令中的hangupurl屬性自定義相對url，若為空則不發送此請求。消息關鍵字為hangup。
請求地址
POST /hangup?appid={appid}&callid={callid}&reason={reason}&callduration={callduration} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
必須 |
一個由32位數字、字符組成的唯一呼叫標識符 |
| reason |
必須 |
0 咨詢側主動掛機 |
| callduration |
可選 |
咨詢通話時長，單位：秒 |
| appid |
必須 |
應用id |
1.8 咨詢側主動結束咨詢呼叫
在咨詢呼叫中被咨詢側未接通前咨詢側可主動結束咨詢呼叫。在<ConsultationCall>命令中“finishkey”參數設置結束鍵，“cancelurl”參數設置自定義回調URL。
請求地址
POST /<custom>?appid={appid}&callid={callid} HTTP 1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
必須 |
一個由32位數字、字符組成的唯一呼叫標識符 |
| appid |
必須 |
應用id |
1.9 呼轉請求
由應用側控制由云平臺向應用側發起的業務跳轉請求。消息關鍵字為redirect。
請求地址
POST /redirect?appid={appid}&callid={callid}&tag={tag} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
必須 |
一個由32位數字、字符組成的唯一呼叫標識符 |
| tag |
可選 |
在<Redirect>命令指定的標識值，正整數。默認為0 |
| appid |
必須 |
應用id |
1.10 指定呼轉
咨詢呼叫或呼叫轉接接通后，被咨詢者按“*號鍵+分機號+＃號鍵”后，云平臺會向AS側發送此通知。AS側可根據此分機號查詢新號碼后為主叫再次發起咨詢呼叫。URL中的<custom>內容可通過<ConsultationCall>和<TransferCall>命令中的transferurl屬性自定義相對url，若為空則不發送此請求。消息關鍵字為transferurl。
請求地址
POST /<custom>?appid={appid}&callid={callid}&extension={extension} HTTP 1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
必須 |
一個由32位數字、字符組成的唯一呼叫標識符 |
| extension |
必須 |
電話分機號 |
| appid |
必須 |
應用id |
1.11 通話結束后發給被咨詢側的通知
咨詢呼叫或呼叫轉接時咨詢側與被咨詢側通話結束或咨詢側掛斷電話后，若命令中“consulurlafterhangup”參數不為空，則向AS側發送此通知。AS側回復其它IVR命令可對被咨詢側通話進行業務邏輯控制。URL中的<custom>內容可通過<ConsultationCall>命令中的consulurlafterhangup屬性自定義相對url，若為空則不發送此請求。消息關鍵字為consulurlafterhangup。
請求地址
POST /<custom>?appid={appid}&callid={callid} HTTP 1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
必須 |
一個由32位數字、字符組成的唯一呼叫標識符 |
| appid |
必須 |
應用id |
1.12 默認通知接口
云平臺向AS側發送的通知請求無其它參數的，都使用此接口進行通知。
請求地址
POST /<custom>?appid={appid}&callid={callid} HTTP 1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
必須 |
一個由32位數字、字符組成的唯一呼叫標識符 |
| appid |
必須 |
應用id |
1.13 DTMF發送結果通知
發送dtmf完成后，由云平臺向應用側發起的請求消息，URL中“<custom>”可通過<SendDTMF>命令中的action屬性自定義。
請求地址
POST /<custom>?appid={appid}&callid={callid}&result={result}&dtmf={dtmf} HTTP/1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| callid |
必須 |
一個由32位數字、字符組成的唯一呼叫標識符 |
| result | 必須 | 0為成功，其他值為失敗 |
| dtmf | 必須 | 發送dtmf的內容 |
| appid | 必須 | 應用id |
1.14 咨詢通話設置時間結束被咨詢側通知
在咨詢呼叫設置通話時間到后，云平臺會向應用側發起此請求，以通知應用側被咨詢側通話時間到處理被咨詢側后續邏輯。URL中<custom>內容可通過<ConsultationCall>命令中的calltimeoverconsulurl屬性自定義，若為空則不發送此請求。消息關鍵字為calltimeoverconsul。
請求地址
POST /<custom>?appid={appid}&callid={callid} HTTP 1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| appid | 必須 | 應用id |
| callid | 必須 | 一個由32位數字、字符組成的唯一呼叫標識符 |
1.15 被咨詢側未接聽掛機通知
在咨詢呼叫中被咨詢側未接通超時、拒接或者關機等造成的被咨詢側掛機的通知請求。URL中<custom>內容可通過<ConsultationCall>命令中的noanswerurl屬性自定義，若為空則不發送此請求。
請求地址
POST /<custom>?appid={appid}&callid={callid} HTTP 1.1
請求參數
| 參數名 |
約束 |
說明 |
|---|---|---|
| appid | 必須 |
應用id |
| callid | 必須 | 一個由32位數字、字符組成的唯一呼叫標識符 |