云通訊平臺(tái)為開(kāi)發(fā)者提供了IVR外呼接口,以便開(kāi)發(fā)者通過(guò)IVR方式開(kāi)展業(yè)務(wù)。本接口發(fā)起外呼命令,執(zhí)行后云通訊平臺(tái)會(huì)向第三方發(fā)起IVR啟動(dòng)業(yè)務(wù)通知(詳見(jiàn)IVR API > IVR 基礎(chǔ)通知消息)。開(kāi)發(fā)者可通過(guò)后續(xù)的IVR命令開(kāi)展業(yè)務(wù)。
REST API: 語(yǔ)音通知
通過(guò)HTTPS POST方式提交請(qǐng)求,云通訊平臺(tái)收到請(qǐng)求后,向?qū)ο箅娫捊K端發(fā)起呼叫,接通電話后播放指定語(yǔ)音。
接口Demo示例可在REST Server Demo中找到,開(kāi)發(fā)者可根據(jù)使用的語(yǔ)言下載對(duì)應(yīng)的Demo
1、請(qǐng)求
1.1 請(qǐng)求地址
/{SoftVersion}/Accounts/{accountSid}/ivr/dial
1.2 請(qǐng)求包頭
請(qǐng)參閱:Rest 介紹》統(tǒng)一請(qǐng)求包頭,使用主賬戶進(jìn)行驗(yàn)證
1.3 請(qǐng)求包體
屬性 | 類(lèi)型 | 約束 | 說(shuō)明 |
---|---|---|---|
Appid |
String | 必選 | 應(yīng)用Id |
number |
String | 必選 | 待呼叫號(hào)碼,為Dial節(jié)點(diǎn)的屬性 |
userdata | String |
可選 | 用戶數(shù)據(jù),需要base64加密,在<startservice>通知中返回,為Dial節(jié)點(diǎn)的屬性 |
record |
String |
可選 |
是否錄音,可填項(xiàng)為true和false,默認(rèn)值為false不錄音,為Dial節(jié)點(diǎn)的屬性 |
disnumber |
String |
可選 |
用戶方的顯號(hào)號(hào)碼,根據(jù)平臺(tái)側(cè)顯號(hào)規(guī)則控制。 |
注意:顯號(hào)設(shè)置需要云平臺(tái)開(kāi)放相關(guān)權(quán)限,如需開(kāi)通請(qǐng)聯(lián)系云通訊商務(wù)人員或撥打400-610-1019
1.4 請(qǐng)求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/ivr/dial?sig=155EAA68C5DFB6B762A42D88F406ABCD HTTP/1.1 Accept:application/xml; Host:192.168.0.1:8883 content-length: 139 Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version="1.0" encoding="UTF-8"?> <Request> <Appid>12345678</Appid> <Dial number="13812345678" userdata="1" record="true"></Dial> </Request>
2、響應(yīng)
2.1 響應(yīng)包體
屬性 | 類(lèi)型 | 約束 | 說(shuō)明 |
---|---|---|---|
statusCode | String | 必選 | 請(qǐng)求狀態(tài)碼,000000為成功,其他錯(cuò)誤碼則為失敗,錯(cuò)誤碼可參考Rest 錯(cuò)誤代碼。 |
callSid | String | 必選 | 一個(gè)由32個(gè)字符組成的通話唯一標(biāo)識(shí)符,需要應(yīng)用側(cè)進(jìn)行保存以便提供給云通訊的技術(shù)支持進(jìn)行相關(guān)問(wèn)題的查詢,云通訊根據(jù)這唯一標(biāo)識(shí)符進(jìn)行快速的問(wèn)題定位,以便能更快的解決問(wèn)題。 |
2.2 響應(yīng)示例
HTTP/1.1 200 OK Content-Length:586 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> <statusCode>000000</statusCode> <callSid>a346467ca321c71dbd5e12f627123456</callSid> </Response>
文檔更新時(shí)間:2016年11月10日