API: Voice/XSend - 语音模板呼叫
概览
Voice/xsend 是 SUBMAIL 的语音通知 API，语音通知仅支持验证码及通知类内容。
URL
https://api-v4.mysubmail.com/voice/xsend
支持格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/voice/xsend.json（默认） |
xml | https://api-v4.mysubmail.com/voice/xsend.xml |
yaml | https://api-v4.mysubmail.com/voice/xsend.yaml |
http 请求方式
| 请求方式 | content-type设置 |
|---|---|
http post | multipart/form-data、x-www-form-urlencoded、application/json |
是否需要授权
是
参阅 API 授权和验证机制
请求参数
| 参数 | 类型 | 必需/可选 | 默认 | 描述 |
|---|---|---|---|---|
appid | string | 必需 | 无 | 在 SUBMAIL 应用集成中创建的语音应用 ID |
to | string | 必需 | 无 | 收件人手机号码，该参数现在仅能提交一个位联系人。 |
project | string | 必需 | 无 | 项目标记，在 SUBMAIL > Voice >项目中查看你所创建的语音项目标记。请参见获取项目 ID |
vars | jsonstring | 必需 | 无 | 使用文本变量动态控制语音中的文本。 参阅 了解如何创建和使用文本变量 |
timestamp | UNIX 时间戳 | 可选 | 无 | 参阅 API 授权与验证机制 > Timestamp UNIX 时间戳 |
sign_type | string | 可选 | normal | API 授权模式（ md5 or sha1 or normal ）参阅 API 授权与验证机制 > 授权和验证方式 |
sign_version | string | 可选 | 1 | signature加密计算方式(当sign_version传2时，vars参数不参与加密计算) |
signature | string | 必需 | 无 | 应用密匙或数字签名 参阅 API授权与验证机制 > 授权和验证方式 |
代码示例
发送一封测试语音
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 发送一封测试短信
发送 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
}返回值
请求成功
{
"status":"success"
"send_id":"093c0a7df143c087d6cba9cdf0cf3738"
"fee":1,
"money_account":14197
}请求失败
{
"status":"error",
"code":"1xx",
"msg":"error message"
}