1 標準語音驗證碼接口請求方式
使用默認的語音內容：您的驗證碼是xxxx。語音驗證碼API訪問的地址見Base URL。
1.1 Base URL
生產環境的Base URL：https://app.cloopen.com:8883
注意：為了確保數據隱私，云通訊平臺的REST API是通過HTTPS方式請求。
1.2 業務流程說明
1.3 統一請求包頭
URL格式：/2013-12-26/Accounts/{accountSid}/Calls/VoiceVerify?sig={SigParameter}
在URL格式中 {}內的內容表示為參數，非{}的內容固定不變。
屬性說明：
| 屬性 | 類型 | 約束 | 說明 |
|---|---|---|---|
| accountSid |
String | 必選 |
開發者主賬戶ACCOUNT SID。（登陸官網在管理控制臺獲取） |
| SigParameter |
String | 必選 |
REST API 驗證參數，生成規則如下 1.使用MD5加密（賬戶Id + 賬戶授權令牌 + 時間戳）。其中賬戶Id和賬戶授權令牌根據url的驗證級別對應主賬戶。 時間戳是當前系統時間，格式"yyyyMMddHHmmss"。時間戳有效時間為24小時，如：20140416142030 2.SigParameter參數需要大寫，如不能寫成sig=abcdefg而應該寫成sig=ABCDEFG |
1.4 HTTP標準包頭字段（必填）
Accept:application/xml;
Content-Type:application/xml;charset=utf-8;
Content-Length:256;
Authorization:
屬性說明:
| 屬性 | 類型 | 約束 | 說明 |
|---|---|---|---|
| Accept |
String | 必選 | 客戶端響應接收數據格式：application/xml、application/json |
| Content-Type |
String | 必選 | 類型：application/xml;charset=utf-8、application/json;charset=utf-8 |
| Content-Length |
String | 必選 | Content-Length |
| Authorization | String | 必選 | 驗證信息，生成規則詳見下方說明 1.使用Base64編碼（賬戶Id + 冒號 + 時間戳）其中賬戶Id根據url的驗證級別對應主賬戶 2.冒號為英文冒號 3.時間戳是當前系統時間，格式"yyyyMMddHHmmss"，需與SigParameter中時間戳相同。 |
1.5 請求包體
| 屬性 | 類型 | 約束 | 說明 |
|---|---|---|---|
| appId | String | 必選 | 應用Id |
| verifyCode | String | 必選 | 驗證碼內容，為數字和英文字母，不區分大小寫，長度4-8位 |
| to | String | 必選 | 接收號碼，被叫為座機時需要添加區號，如：01052823298；被叫為分機時分機號由'-'隔開，如： 01052823298-3627 |
| displayNum | String | 可選 | 顯示主叫號碼，顯示權限由服務側控制。 |
| playTimes | String | 可選 | 循環播放次數，1－3次，默認播放1次。 |
| respUrl | String | 可選 | 語音驗證碼狀態通知回調地址（必須符合URL規范），云通訊平臺將向該Url地址發送呼叫結果通知。 |
| lang | String | 可選 | 播放的語言類型（暫不支持設置en，默認zh）。取值en（英文）、zh（中文），默認值zh。 |
| userData | String | 可選 | 第三方私有數據，可在語音驗證碼狀態通知中獲取此參數。 |
| welcomePrompt | String | 可選 | wav格式的文件名，歡迎提示音，在播放驗證碼語音前播放此內容，配合verifyCode使用，默認值 空。語音文件通過官網上傳審核后才可使用，放音文件的格式樣本如 下：位速 128kbps，音頻采樣大小16位，頻道 1(單聲道)， 音頻采樣級別 8 kHz，音頻格式 PCM，這樣能保證放音的清晰度。 |
| maxCallTime | String | 可選 | 該通通話最大通話時長，到時間自動掛機 |
1.6 默認語音模板的XML請求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/Calls/VoiceVerify?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'?>
<VoiceVerify>
<appId>abcdefghijklmnopqrstuvwxyz123456</appId>
<verifyCode>0708</verifyCode>
<playTimes>2</playTimes>
<to>13811234567</to>
<displayNum>01052821234</displayNum>
<welcomePrompt>huanying.wav</welcomePrompt>
<maxCallTime>60</maxCallTime>
</VoiceVerify>
用戶收聽的效果是："huanying.wav+您的驗證碼是0708"
1.7 默認語音模板的JSON請求示例
POST /2013-12-26/Accounts/abcdefghijklmnopqrstuvwxyz012345/Calls/VoiceVerify?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=
{"appId":"abcdefghijklmnopqrstuvwxyz123456","verifyCode":"0708","playTimes":"2",
"to":"01052821234","displayNum":"01052821234","welcomePrompt":"huanying.wav","maxCallTime":"60"}
用戶收聽的效果是："huanying.wav+您的驗證碼是0708"
2 響應
此步響應只表明客戶的語音驗證碼請求發送成功，不表明運營商已經呼叫發送驗證碼成功。
2.1 響應包體
| 屬性 | 類型 | 約束 | 說明 |
|---|---|---|---|
| statusCode | String | 必選 | 請求狀態碼，取值000000（成功），可參考錯誤代碼。 |
| callSid | String | 必選 | 一個由32個字符組成的唯一電話標識符 |
| dateCreated | String | 必選 | 電話的創建時間 |
2.2 XML響應示例
HTTP/1.1 200 OK
Content-Length: 641
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response>
<statusCode>000000</statusCode>
<VoiceVerify>
<callSid>a346467ca321c71dbd5e12f627123456</callSid>
<dateCreated>2013-02-01 15:38:09</dateCreated>
</VoiceVerify>
</Response>
2.3 JSON響應示例
HTTP/1.1 200 OK
Content-Length: 641
{"statusCode":"000000","VoiceVerify":{"dateCreated":"2013-02-01 15:53:06",
"callSid":" ff8080813c373cab013c94be9fe300c5"}}