sms api文档


语音发送

<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;amp;sign=***&amp;amp;datetime=*** post请求载体:{&amp;quot;content&amp;quot;:&amp;quot;test&amp;quot;,&amp;quot;numbers&amp;quot;:&amp;quot;13611111111,13722222222&amp;quot;,&amp;quot;codeId&amp;quot;:&amp;quot;10001&amp;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> { &amp;quot;status&amp;quot;: 0, &amp;quot;message&amp;quot;: &amp;quot;****&amp;quot;, &amp;quot;data&amp;quot;: [ &amp;quot;success&amp;quot;: &amp;quot;2&amp;quot;, &amp;quot;fail&amp;quot;: &amp;quot;0&amp;quot;, &amp;quot;array&amp;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:黑号码限制&lt;br&gt;4:国码错误&lt;br&gt;3:未找到通道&lt;br&gt;2:发送失败&lt;br&gt;1:发送成功&lt;br&gt;0:提交成功&lt;br&gt;-1:认证错误&lt;br&gt;-2:IP访问受限&lt;br&gt;-3:短信内容含有敏感字符&lt;br&gt;-4:短信内容为空&lt;br&gt;-5:短信内容过长&lt;br&gt;-6:不是模板的短信或大陆、香港、澳门、台湾方向未报备&lt;br&gt;-7:号码个数过多&lt;br&gt;-8:号码为空&lt;br&gt;-9:号码异常&lt;br&gt;-10:该通道余额不足&lt;br&gt;-11:定时时间格式不对&lt;br&gt;-12:由于平台的原因,批量提交出错,请与管理员联系&lt;br&gt;-13:用户被锁定&lt;br&gt;-14:查询id异常&lt;br&gt;-15:请求频率过快&lt;br&gt;-16:超出时间范围限制&lt;br&gt;-17:短信模版不能为空&lt;br&gt;-18:国码ID不能为空&lt;br&gt;-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;amp;sign=***&amp;amp;datetime=*** post请求载体:{&amp;quot;content&amp;quot;:&amp;quot;test&amp;quot;,&amp;quot;numbers&amp;quot;:&amp;quot;150xxxxxxxx&amp;quot;,&amp;quot;codeId&amp;quot;:&amp;quot;10001&amp;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> { &amp;quot;status&amp;quot;: 0, &amp;quot;message&amp;quot;: &amp;quot;****&amp;quot;, &amp;quot;data&amp;quot;: [ &amp;quot;success&amp;quot;: &amp;quot;2&amp;quot;, &amp;quot;fail&amp;quot;: &amp;quot;0&amp;quot;, &amp;quot;batchNo&amp;quot;: &amp;quot;16685020111564&amp;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:黑号码限制&lt;br&gt;4:国码错误&lt;br&gt;3:未找到通道&lt;br&gt;2:发送失败&lt;br&gt;1:发送成功&lt;br&gt;0:提交成功&lt;br&gt;-1:认证错误&lt;br&gt;-2:IP访问受限&lt;br&gt;-3:短信内容含有敏感字符&lt;br&gt;-4:短信内容为空&lt;br&gt;-5:短信内容过长&lt;br&gt;-6:不是模板的短信或大陆、香港、澳门、台湾方向未报备&lt;br&gt;-7:号码个数过多&lt;br&gt;-8:号码为空&lt;br&gt;-9:号码异常&lt;br&gt;-10:该通道余额不足&lt;br&gt;-11:定时时间格式不对&lt;br&gt;-12:由于平台的原因,批量提交出错,请与管理员联系&lt;br&gt;-13:用户被锁定&lt;br&gt;-14:查询id异常&lt;br&gt;-15:请求频率过快&lt;br&gt;-16:超出时间范围限制&lt;br&gt;-17:短信模版不能为空&lt;br&gt;-18:国码ID不能为空&lt;br&gt;-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>

页面列表

ITEM_HTML