云通訊平臺為開發者提供了IVR外呼接口,以便開發者通過IVR方式開展業務。本接口發起外呼命令,執行后云通訊平臺會向第三方發起IVR啟動業務通知(詳見IVR API > IVR 基礎通知消息)。開發者可通過后續的IVR命令開展業務。
REST API: 語音通知
通過HTTPS POST方式提交請求,云通訊平臺收到請求后,向對象電話終端發起呼叫,接通電話后播放指定語音。
接口Demo示例可在REST Server Demo中找到,開發者可根據使用的語言下載對應的Demo
1、請求
1.1 請求地址
/{SoftVersion}/Accounts/{accountSid}/ivr/dial
1.2 請求包頭
請參閱:Rest 介紹》統一請求包頭,使用主賬戶進行驗證
1.3 請求包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
Appid |
String | 必選 | 應用Id |
number |
String | 必選 | 待呼叫號碼,為Dial節點的屬性 |
userdata | String |
可選 | 用戶數據,需要base64加密,在<startservice>通知中返回,為Dial節點的屬性 |
record |
String |
可選 |
是否錄音,可填項為true和false,默認值為false不錄音,為Dial節點的屬性 |
disnumber |
String |
可選 |
用戶方的顯號號碼,根據平臺側顯號規則控制。 |
注意:顯號設置需要云平臺開放相關權限,如需開通請聯系云通訊商務人員或撥打400-610-1019
1.4 請求示例
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、響應
2.1 響應包體
屬性 | 類型 | 約束 | 說明 |
---|---|---|---|
statusCode | String | 必選 | 請求狀態碼,000000為成功,其他錯誤碼則為失敗,錯誤碼可參考Rest 錯誤代碼。 |
callSid | String | 必選 | 一個由32個字符組成的通話唯一標識符,需要應用側進行保存以便提供給云通訊的技術支持進行相關問題的查詢,云通訊根據這唯一標識符進行快速的問題定位,以便能更快的解決問題。 |
2.2 響應示例
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>
文檔更新時間:2016年11月10日