状态报告
<h1>状态报告查询</h1>
<h5>简要描述</h5>
<ul>
<li>本接口用于查询短信发送报告</li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>http://ip:port/v1/sms/report</code></li>
</ul>
<h5>请求方式</h5>
<ul>
<li>GET</li>
</ul>
<h5>请求示例</h5>
<pre><code> http://ip:port/v1/sms/report?account=***&amp;sign=***&amp;datetime=***&amp;ids=48d5112288668ebb049dbb9034402910,c11d34242000e541f63fbdef3e36b1db</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;">ids</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">string</td>
<td>指定查询发送结果的短信id（该id在提交时由系统返回, 多个以英文逗号分隔(最多200个）</td>
</tr>
</tbody>
</table>
<h5>返回示例</h5>
<pre><code> {
&quot;status&quot;:0,
&quot;msg&quot;:&quot;****&quot;,
&quot;data&quot;:[
&quot;success&quot;:1,
&quot;fail&quot;:1,
&quot;unsent&quot;:0,
&quot;sending&quot;:0,
&quot;nofound&quot;:0,
&quot;array&quot;:[
[48d5112288668ebb049dbb9034402910,&quot;86136****1111&quot;,1628847497,0],
[c11d34242000e541f63fbdef3e36b1db,&quot;8613722222222&quot;,1628847497,3]
]
]
}</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>0:提交成功；<br>-1:认证错误;</td>
</tr>
<tr>
<td style="text-align: left;">msg</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['unsent']</td>
<td style="text-align: left;">int</td>
<td>未发送条数</td>
</tr>
<tr>
<td style="text-align: left;">data['sending']</td>
<td style="text-align: left;">int</td>
<td>正在发送的条数</td>
</tr>
<tr>
<td style="text-align: left;">data['nofound']</td>
<td style="text-align: left;">int</td>
<td>id没有找到的条数</td>
</tr>
<tr>
<td style="text-align: left;">data['array']</td>
<td style="text-align: left;">array</td>
<td>单个数组中依次包含<br>array[0]：唯一消息ID(string)<br>array[1]：号码(string)<br>array[2]：发送时间(GMT+8时区的时间戳)<br>array[3]：状态(int) 0：正在发送;1：发送成功;非0,1:发送失败</td>
</tr>
</tbody>
</table>
<h1>状态报告推送</h1>
<h5>简要描述</h5>
<ul>
<li>本接口主动推送短信状态报告至发送方，短信发送完成时后，系统主动推送状态报告至发送方服务器，发送方需提供接受接口的URL，并在接收到推送后回复200 OK响应</li>
</ul>
<h5>请求方式</h5>
<ul>
<li>POST</li>
</ul>
<h5>请求Header</h5>
<ul>
<li>Content-Type: application/json</li>
</ul>
<h5>请求示例</h5>
<pre><code> {
&quot;type&quot;:&quot;sms&quot;,
&quot;cnt&quot;:2,
&quot;array&quot;:[
[&quot;48d5112288668ebb049dbb9034402910&quot;,&quot;86136****1111&quot;,1628847497,1,&quot;success&quot;,&quot;20221102xxxxx&quot;],
[&quot;c11d34242000e541f63fbdef3e36b1db&quot;,&quot;8613722222222&quot;,1628847497, -9, &quot;number error&quot;,&quot;20221102xxxxx&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;">type</td>
<td style="text-align: left;">string</td>
<td>该消息的字符串类型，默认值："report"</td>
</tr>
<tr>
<td style="text-align: left;">cnt</td>
<td style="text-align: left;">int</td>
<td>本次推送中包含的报告条数（一个请求最多不会超多50条）</td>
</tr>
<tr>
<td style="text-align: left;">array</td>
<td style="text-align: left;">array</td>
<td>发送报告的数组中依次包含:<br>array[0]：唯一消息ID(string)<br>array[1]：号码(string)<br>array[2]：发送时间(GMT+8时区的时间戳)<br>array[3]：状态(int) 0：正在发送;1：发送成功;非0,1:发送失败<br>array[4]:状态描述（string）<br>array[5]:批次号（string）</td>
</tr>
</tbody>
</table>