API: Voice/Send - 語音呼叫
概覽
voice/send 是 SUBMAIL 的語音通知 API。 當(dāng)使用 voice/send API 提交語音通知時，您無需創(chuàng)建語音模板，SUBMAIL會根據(jù)您傳入的內(nèi)容，自動為您創(chuàng)建語音模板。
URL
https://api-v4.mysubmail.com/voice/send
支持格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/voice/send.json（默認(rèn)） |
xml | https://api-v4.mysubmail.com/voice/send.xml |
yaml | https://api-v4.mysubmail.com/voice/send.yaml |
http 請求方式
| 請求方式 | content-type設(shè)置 |
|---|---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
是否需要授權(quán)
是
參閱 API 授權(quán)和驗證機(jī)制
請求參數(shù)
| 參數(shù) | 類型 | 必需/可選 | 默認(rèn) | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無 | 在 SUBMAIL 應(yīng)用集成中創(chuàng)建的語音應(yīng)用 ID |
to | string | 必需 | 無 | 收件人手機(jī)號碼，例：18688888888 |
content | string | 必需 | 無 | 語音正文(content 參數(shù)將會與您賬戶中的語音模板進(jìn)行匹配，如 API 返回 420 錯誤，請在您的賬戶中添加語音模板，并提交審核,請將語音正文控制在 255個字符以內(nèi)。) |
timestamp | UNIX 時間戳 | 可選 | 無 | 參閱 API 授權(quán)與驗證機(jī)制 > Timestamp UNIX 時間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式（ md5 or sha1 or normal ）參閱 API 授權(quán)與驗證機(jī)制 > 授權(quán)和驗證方式 |
sign_version | string | 可選 | 1 | signature加密計算方式(當(dāng)sign_version傳2時，content參數(shù)不參與加密計算) |
signature | string | 必需 | 無 | 應(yīng)用密匙或數(shù)字簽名 參閱 API授權(quán)與驗證機(jī)制 > 授權(quán)和驗證方式 |
代碼示例
發(fā)送一封測試語音
POST URL
https://api-v4.mysubmail.com/voice/send.jsonPOST DATA
appid=your_app_id
&to=138xxxxxxxx
&content= 親愛愛顧客，快遞員：XXX，因無法進(jìn)入單元，已將您的快遞包裹送至您小區(qū)的物業(yè)，請您及時取回，感謝您的惠顧
&signature=your_app_key返回
{
"status":"success"
"send_id":"093c0a7df143c087d6cba9cdf0cf3738"
"fee":1,
"money_account":"14197"
}使用 CURL 發(fā)送一封測試短信
發(fā)送 CURL
curl -d 'appid=your_app_id&to=17788xxxxxxxx&content=親愛愛顧客，快遞員：XXX，因無法進(jìn)入單元，已將您的快遞包裹送至您小區(qū)的物業(yè)，請您及時取回，感謝您的惠顧&signature=your_app_key' https://api-v4.mysubmail.com/voice/send.json返回
{
"status":"success"
"send_id":"093c0a7df143c087d6cba9cdf0cf3738"
"money_account":14197
}返回值
請求成功
{
"status":"success"
"send_id":"093c0a7df143c087d6cba9cdf0cf3738"
"fee":1,
"sms_credits":14197
}請求失敗
{
"status":"error",
"code":"1xx",
"msg":"error message"
}