API: Voice/XSend - 語(yǔ)音模板呼叫
概覽
Voice/xsend 是 SUBMAIL 的語(yǔ)音通知 API，語(yǔ)音通知僅支持驗(yàn)證碼及通知類內(nèi)容。
URL
https://api-v4.mysubmail.com/voice/xsend
支持格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/voice/xsend.json（默認(rèn)） |
xml | https://api-v4.mysubmail.com/voice/xsend.xml |
yaml | https://api-v4.mysubmail.com/voice/xsend.yaml |
http 請(qǐng)求方式
| 請(qǐng)求方式 | content-type設(shè)置 |
|---|---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
是否需要授權(quán)
是
參閱 API 授權(quán)和驗(yàn)證機(jī)制
請(qǐng)求參數(shù)
| 參數(shù) | 類型 | 必需/可選 | 默認(rèn) | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 無(wú) | 在 SUBMAIL 應(yīng)用集成中創(chuàng)建的語(yǔ)音應(yīng)用 ID |
to | string | 必需 | 無(wú) | 收件人手機(jī)號(hào)碼，該參數(shù)現(xiàn)在僅能提交一個(gè)位聯(lián)系人。 |
project | string | 必需 | 無(wú) | 項(xiàng)目標(biāo)記，在 SUBMAIL > Voice >項(xiàng)目中查看你所創(chuàng)建的語(yǔ)音項(xiàng)目標(biāo)記。請(qǐng)參見(jiàn)獲取項(xiàng)目 ID |
vars | jsonstring | 必需 | 無(wú) | 使用文本變量動(dòng)態(tài)控制語(yǔ)音中的文本。 參閱 了解如何創(chuàng)建和使用文本變量 |
timestamp | UNIX 時(shí)間戳 | 可選 | 無(wú) | 參閱 API 授權(quán)與驗(yàn)證機(jī)制 > Timestamp UNIX 時(shí)間戳 |
sign_type | string | 可選 | normal | API 授權(quán)模式（ md5 or sha1 or normal ）參閱 API 授權(quán)與驗(yàn)證機(jī)制 > 授權(quán)和驗(yàn)證方式 |
sign_version | string | 可選 | 1 | signature加密計(jì)算方式(當(dāng)sign_version傳2時(shí)，vars參數(shù)不參與加密計(jì)算) |
signature | string | 必需 | 無(wú) | 應(yīng)用密匙或數(shù)字簽名 參閱 API授權(quán)與驗(yàn)證機(jī)制 > 授權(quán)和驗(yàn)證方式 |
代碼示例
發(fā)送一封測(cè)試語(yǔ)音
POST URL
https://api-v4.mysubmail.com/voice/xsend.jsonPOST DATA
appid=your_app_id
&to=138xxxxxxxx
&project=ThJBE4
&signature=your_app_key返回
{
"status":"success"
"send_id":"093c0a7df143c087d6cba9cdf0cf3738"
"fee":1,
"money_account":14197
}使用 CURL 發(fā)送一封測(cè)試短信
發(fā)送 CURL
url -d 'appid=your_app_id&to=138xxxxxxxx&project=ThJBE4&signature=your_app_key' https://api-v4.mysubmail.com/voice/xsend.json返回
{
"status":"success"
"send_id":"093c0a7df143c087d6cba9cdf0cf3738"
"fee":1,
"money_account":14197
}返回值
請(qǐng)求成功
{
"status":"success"
"send_id":"093c0a7df143c087d6cba9cdf0cf3738"
"fee":1,
"money_account":14197
}請(qǐng)求失敗
{
"status":"error",
"code":"1xx",
"msg":"error message"
}