語音通知
語音通知是云通訊平臺提供的一種語音通話能力，通過此REST API可以方便的對您的客戶進行外呼放音服務。并通過請求時傳入的外呼通知狀態通知回調地址進行呼叫狀態回調。
REST API: 語音通知
通過HTTPS POST方式提交請求，云通訊平臺收到請求后，向對象電話終端發起呼叫，接通電話后播放指定語音。
接口Demo示例可在REST Server Demo中找到，開發者可根據使用的語言下載對應的Demo
1、請求
1.1 請求地址
/{SoftVersion}/Accounts/{accountSid}/Calls/LandingCalls/
1.2 請求包頭
請參閱：《Rest 介紹》統一請求包頭，使用主賬戶進行驗證
1.3 請求包體
| 屬性 |
類型 | 約束 | 說明 |
|---|---|---|---|
| appId |
String |
必選 | 應用id |
| to |
String | 必選 | 被叫號碼，被叫為座機時需要添加區號，如：01052823298；被叫為分機時分機號由‘-’隔開，如：01052823298-3627 |
| mediaName |
String |
可選 |
語音文件名稱，格式 wav，播放多個文件用英文分號隔開。與mediaTxt不能同時為空。當不為空時mediaTxt屬性失效。測試用默認語音：ccp_marketingcall.wav |
| mediaNameType |
String |
可選 |
語音文件名的類型，默認值為0，表示用戶語音文件； 值為1表示平臺通用文件。 此為json參數，在xml時為屬性type值 |
| mediaTxt |
String | 可選 | 文本內容，文本中漢字要求utf8編碼，默認值為空。當mediaName為空才有效。 |
| displayNum |
String |
可選 |
來電顯示的號碼，根據平臺側顯號規則控制(有顯號需求請聯系云通訊商務，并且說明顯號的方式)，不在平臺規則內或空則顯示云通訊平臺默認號碼。默認值空。注：來電顯示的號碼不能和呼叫的號碼相同，否則顯示云通訊平臺默認號碼。 |
| playTimes |
String | 可選 | 循環播放次數，1－3次，默認播放1次。 |
| respUrl |
String |
可選 |
外呼通知狀態通知回調地址（必須符合URL規范），云通訊平臺將向該Url地址發送呼叫結果通知。 |
| userData |
String | 可選 | 第三方私有數據，可在外呼通知狀態通知中獲取此參數。 |
| txtSpeed |
String | 可選 | 文本轉語音后的發音速度，取值范圍：-500至500，當mediaTxt有效才生效,默認值為0。 |
| txtVolume |
String | 可選 | 文本轉語音后的音量大小，取值范圍：-20至20，當mediaTxt有效才生效，默認值為0。 |
| txtPitch |
String | 可選 | 文本轉語音后的音調，取值范圍：-500至500，當mediaTxt有效才生效，默認值為0。 |
| txtBgsound |
String |
可選 |
文本轉語音后的背景音編號，目前云通訊平臺支持6種背景音，1到6的六種背景音編碼，0為不需要背景音。暫時不支持第三方自定義背景音。當mediaTxt有效才生效。 |
| playMode |
String |
可選 |
是否同時播放文本和語音文件 , 0、否 1、是，默認0。優先播放文本。 |
注意：顯號設置需要云平臺開放相關權限，如需開通請聯系云通訊商務人員或撥打400-610-1019
1.4 XML請求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/Calls/LandingCalls?sig=C1F20E7A9733CE94F680C70A1DBABCDE HTTP/1.1 Host:192.168.0.1:8883 content-length: 139 Accept:application/xml; Content-Type:application/xml;charset=utf-8; Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE= <?xml version="1.0" encoding="utf-8"?> <LandingCall> <appId>11112222333344445555666677778888</appId> <to>008613912345678</to> <mediaName>1.wav;2.wav</mediaName> <displayNum>13131313131</displayNum> </LandingCall>
1.5 JSON請求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/Calls/LandingCalls?sig=C1F20E7A9733CE94F680C70A1DBABCDE HTTP/1.1
Host:192.168.0.1:8883
content-length: 139
Accept:application/json;
Content-Type:application/json;charset=utf-8;
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
{"mediaName":"1.wav","to":"01052821234","appId":"111122222333333444444","displayNum":"13912345678"}
2、響應
2.1 響應包體
| 屬性 | 類型 | 約束 | 說明 |
|---|---|---|---|
| statusCode | String | 必選 | 請求狀態碼，000000為成功，其他錯誤碼則為失敗，錯誤碼可參考Rest 錯誤代碼。 |
| callSid | String | 必選 | 一個由32個字符組成的通話唯一標識符，需要應用側進行保存以便提供給云通訊的技術支持進行相關問題的查詢，云通訊根據這唯一標識符進行快速的問題定位，以便能更快的解決問題。 |
| dateCreated | String |
必選 |
電話的創建時間，時間格式為2013-02-01 15:53:06。 |
| orderid |
String |
可選 |
話單id |
2.2 XML請求示例
HTTP/1.1 200 OK
Content-Length: 641
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
<statusCode>000000</statusCode>
<LandingCall>
<callSid>a346467ca321c71dbd5e12f627123456</callSid>
<dateCreated>2013-02-01 15:38:09</dateCreated>
</LandingCall>
</Response>
2.3 JSON請求示例
HTTP/1.1 200 OK
Content-Length: 641
{"statusCode":"000000","LandingCall":{"dateCreated":"2013-02-01 15:53:06","callSid":" ff8080813c373cab013c94be9fe300c5"}}
文檔更新時間：2016年10月21日