语音发送
<h1>语音通知</h1>
<h5>简要描述</h5>
<ul>
<li>本接口用于发送语音通知,可单条发送,也可批量号码发送</li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>http://ip:port/api/v1/vos/notice</code></li>
</ul>
<h5>请求方式</h5>
<ul>
<li>POST</li>
</ul>
<h5>请求示例</h5>
<pre><code> POST方式:
http://ip:port/api/v1/vos/notice?account=***&amp;sign=***&amp;datetime=***
post请求载体:{&quot;content&quot;:&quot;test&quot;,&quot;numbers&quot;:&quot;13611111111,13722222222&quot;,&quot;codeId&quot;:&quot;10001&quot;}</code></pre>
<h5>请求参数说明</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">account</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>账号</td>
</tr>
<tr>
<td style="text-align: left;">sign</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>MD5签名(详细说明⻅接⼝说明Sign签名⽣成⽅法)</td>
</tr>
<tr>
<td style="text-align: left;">datetime</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>需传GMT+8当前半⼩时内时间,格式为时间戳</td>
</tr>
<tr>
<td style="text-align: left;">numbers</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>被叫号码,多个号码之间以英⽂逗号分隔,号码⽆需添加国码</td>
</tr>
<tr>
<td style="text-align: left;">content</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>发送内容,⻓度不能超过1024字节</td>
</tr>
<tr>
<td style="text-align: left;">codeId</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>参考国家国码表</td>
</tr>
<tr>
<td style="text-align: left;">showPhone</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>显示号码,联系客服获取指定ID</td>
</tr>
<tr>
<td style="text-align: left;">routing</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>需指定通道请联系平台进⾏索要</td>
</tr>
</tbody>
</table>
<h5>返回示例</h5>
<pre><code> {
&quot;status&quot;: 0,
&quot;message&quot;: &quot;****&quot;,
&quot;data&quot;: [
&quot;success&quot;: &quot;2&quot;,
&quot;fail&quot;: &quot;0&quot;,
&quot;array&quot;: [
[8613611111111,48d5112288668ebb049dbb9034402910],
[8613722222222,c11d34242000e541f63fbdef3e36b1db]
]
]
}</code></pre>
<h5>返回参数说明</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">status </td>
<td style="text-align: left;">int</td>
<td>5:黑号码限制<br>4:国码错误<br>3:未找到通道<br>2:发送失败<br>1:发送成功<br>0:提交成功<br>-1:认证错误<br>-2:IP访问受限<br>-3:短信内容含有敏感字符<br>-4:短信内容为空<br>-5:短信内容过长<br>-6:不是模板的短信或大陆、香港、澳门、台湾方向未报备<br>-7:号码个数过多<br>-8:号码为空<br>-9:号码异常<br>-10:该通道余额不足<br>-11:定时时间格式不对<br>-12:由于平台的原因,批量提交出错,请与管理员联系<br>-13:用户被锁定<br>-14:查询id异常<br>-15:请求频率过快<br>-16:超出时间范围限制<br>-17:短信模版不能为空<br>-18:国码ID不能为空<br>-19:国码ID错误 </td>
</tr>
<tr>
<td style="text-align: left;">message </td>
<td style="text-align: left;">string</td>
<td>错误提示信息 </td>
</tr>
<tr>
<td style="text-align: left;">data['success'] </td>
<td style="text-align: left;">int</td>
<td>提交成功的个数 </td>
</tr>
<tr>
<td style="text-align: left;">data['fail'] </td>
<td style="text-align: left;">int</td>
<td>提交失败的个数 </td>
</tr>
<tr>
<td style="text-align: left;">data['array'] </td>
<td style="text-align: left;">Array</td>
<td>提交短信成功的数组,数组中依次包含“号码、号码的发送结果查询ID”,均为字符串 </td>
</tr>
</tbody>
</table>
<h1>语音验证码发送</h1>
<h5>简要描述</h5>
<ul>
<li>本接口用于单个号码发送验证码</li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>http://ip:port/api/v1/vos/otp</code></li>
</ul>
<h5>请求方式</h5>
<ul>
<li>POST</li>
</ul>
<h5>请求示例</h5>
<pre><code> POST方式:
http://ip:port/api/v1/vos/otp?account=***&amp;sign=***&amp;datetime=***
post请求载体:{&quot;content&quot;:&quot;test&quot;,&quot;numbers&quot;:&quot;150xxxxxxxx&quot;,&quot;codeId&quot;:&quot;10001&quot;}</code></pre>
<h5>请求参数说明</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">必选</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">account</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>账号</td>
</tr>
<tr>
<td style="text-align: left;">sign</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>MD5签名(详细说明⻅接⼝说明Sign签名⽣成⽅法)</td>
</tr>
<tr>
<td style="text-align: left;">datetime</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>需传GMT+8当前半⼩时内时间,格式为时间戳</td>
</tr>
<tr>
<td style="text-align: left;">numbers</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>被叫号码,多个号码之间以英⽂逗号分隔,号码⽆需添加国码</td>
</tr>
<tr>
<td style="text-align: left;">content</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>发送内容,⻓度不能超过1024字节</td>
</tr>
<tr>
<td style="text-align: left;">codeId</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>参考国家国码表</td>
</tr>
<tr>
<td style="text-align: left;">showPhone</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>显示号码,联系客服获取指定ID</td>
</tr>
<tr>
<td style="text-align: left;">routing</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">string</td>
<td>需指定通道请联系平台进⾏索要</td>
</tr>
</tbody>
</table>
<h5>返回示例</h5>
<pre><code> {
&quot;status&quot;: 0,
&quot;message&quot;: &quot;****&quot;,
&quot;data&quot;: [
&quot;success&quot;: &quot;2&quot;,
&quot;fail&quot;: &quot;0&quot;,
&quot;batchNo&quot;: &quot;16685020111564&quot;
]
}</code></pre>
<h5>返回参数说明</h5>
<table>
<thead>
<tr>
<th style="text-align: left;">参数名</th>
<th style="text-align: left;">类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">status </td>
<td style="text-align: left;">int</td>
<td>5:黑号码限制<br>4:国码错误<br>3:未找到通道<br>2:发送失败<br>1:发送成功<br>0:提交成功<br>-1:认证错误<br>-2:IP访问受限<br>-3:短信内容含有敏感字符<br>-4:短信内容为空<br>-5:短信内容过长<br>-6:不是模板的短信或大陆、香港、澳门、台湾方向未报备<br>-7:号码个数过多<br>-8:号码为空<br>-9:号码异常<br>-10:该通道余额不足<br>-11:定时时间格式不对<br>-12:由于平台的原因,批量提交出错,请与管理员联系<br>-13:用户被锁定<br>-14:查询id异常<br>-15:请求频率过快<br>-16:超出时间范围限制<br>-17:短信模版不能为空<br>-18:国码ID不能为空<br>-19:国码ID错误 </td>
</tr>
<tr>
<td style="text-align: left;">message </td>
<td style="text-align: left;">string</td>
<td>错误提示信息 </td>
</tr>
<tr>
<td style="text-align: left;">data['success'] </td>
<td style="text-align: left;">int</td>
<td>提交成功的个数 </td>
</tr>
<tr>
<td style="text-align: left;">data['fail'] </td>
<td style="text-align: left;">int</td>
<td>提交失败的个数 </td>
</tr>
<tr>
<td style="text-align: left;">data['batchNo'] </td>
<td style="text-align: left;">string</td>
<td>提交批量短信返回的批次号 </td>
</tr>
</tbody>
</table>