simApi

物联网平台API


基础信息查询

<h5>简要描述</h5> <ul> <li>查询网卡基础信息, 包括卡类型,卡状态,实名状态,所属运营商,流量使用情况</li> </ul> <h5>请求URL</h5> <ul> <li><code>http://域名/Api/IotApi/querySimInfo</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST</li> </ul> <h5>数据格式</h5> <ul> <li>表单(application/x-www-form-urlencoded)</li> </ul> <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;">appId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>appId</td> </tr> <tr> <td style="text-align: left;">simId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>卡号</td> </tr> <tr> <td style="text-align: left;">orderedData</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>是否需要返回已订购套餐数据;&lt;/br&gt; 1:返回 0:否</td> </tr> <tr> <td style="text-align: left;">isCache</td> <td style="text-align: left;">否</td> <td style="text-align: left;">int</td> <td>是否从缓存中快速获取数据(快照数据); &lt;/br&gt;1:是 0:否</td> </tr> <tr> <td style="text-align: left;">timeStamp</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</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>签名,参考通信规范章节中的 [《签名算法》][1]生成</td> </tr> </tbody> </table> <h5>返回示例 (Json)</h5> <pre><code>{ &amp;quot;code&amp;quot;: 0, &amp;quot;data&amp;quot;: { &amp;quot;trafficInfo&amp;quot;: { &amp;quot;expiration&amp;quot;: 1566835199, &amp;quot;total&amp;quot;: 10240, &amp;quot;used&amp;quot;: 1065.10 }, &amp;quot;status&amp;quot;: 1, &amp;quot;realNameStatus&amp;quot;: 0, &amp;quot;simType&amp;quot;: 1, &amp;quot;opType&amp;quot;: 1, &amp;quot;deadline&amp;quot;: 1601135999, &amp;quot;isBind&amp;quot;: 0, &amp;quot;isPool&amp;quot;: 0, &amp;quot;hideTf&amp;quot;: 0, &amp;quot;limitType&amp;quot;:1, &amp;quot;limitRate&amp;quot;:&amp;quot;0&amp;quot;, &amp;quot;authUrl&amp;quot;: &amp;quot;http://www.xxxx.com/card/uniAuth.png&amp;quot;, &amp;quot;sceneUrl&amp;quot;: &amp;quot;http://www.xxxx.com/Wx/Misc/simScene?id=4&amp;amp;cmkey=e0aee71b&amp;amp;dy=1066&amp;quot;, &amp;quot;agentName&amp;quot;:&amp;quot;test&amp;quot;, &amp;quot;svipdl&amp;quot;: 1601135999, &amp;quot;errMsg&amp;quot;:&amp;quot;&amp;quot; }, &amp;quot;msg&amp;quot;: &amp;quot;OK&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;">code</td> <td style="text-align: left;">int</td> <td>返回错误代码,0:成功; -101: 需要换卡; -102:卡被冻结</td> </tr> <tr> <td style="text-align: left;">data</td> <td style="text-align: left;">object</td> <td>返回数据,详情请查看下方data参数说明</td> </tr> <tr> <td style="text-align: left;">msg</td> <td style="text-align: left;">string</td> <td>当code不为0时,接口错误提示</td> </tr> </tbody> </table> <h6>data参数说明</h6> <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;">trafficInfo</td> <td style="text-align: left;">object</td> <td>当前计费周期流量信息,详情请查看下方trafficInfo参数说明</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">int</td> <td>卡状态,1:待激活; 2:正常; 3:断网; 4:停机; 5:异常; 6:注销</td> </tr> <tr> <td style="text-align: left;">realNameStatus</td> <td style="text-align: left;">int</td> <td>实名状态,0:未实名 1:已实名 2:未知(如果为2,请调用[查询实名状态接口][3]查询)</td> </tr> <tr> <td style="text-align: left;">simType</td> <td style="text-align: left;">int</td> <td>卡类型,由平台方定义,详情请查看[卡类型获取接口][2]</td> </tr> <tr> <td style="text-align: left;">opType</td> <td style="text-align: left;">int</td> <td>运营商类型,1:电信 2:联通 3:移动</td> </tr> <tr> <td style="text-align: left;">deadline</td> <td style="text-align: left;">int</td> <td>已订购套餐截止日期时间戳</td> </tr> <tr> <td style="text-align: left;">isBind</td> <td style="text-align: left;">int</td> <td>是否触发机卡绑定断网;1:是 0:否</td> </tr> <tr> <td style="text-align: left;">isPool</td> <td style="text-align: left;">int</td> <td>是否为流量池成员; 1:是 0:否</td> </tr> <tr> <td style="text-align: left;">limitType</td> <td style="text-align: left;">int</td> <td>支持限速类型,当卡为流量池成员时生效</td> </tr> <tr> <td style="text-align: left;">limitRate</td> <td style="text-align: left;">string</td> <td>限速值, 0为不限速;当卡为流量池成员时生效</td> </tr> <tr> <td style="text-align: left;">authUrl</td> <td style="text-align: left;">string</td> <td>实名地址,当realNameStatus=0 时有效并且出现此字段</td> </tr> <tr> <td style="text-align: left;">sceneUrl</td> <td style="text-align: left;">string</td> <td>卡使用场景提交地址,当卡需要提交此项资料才会出现</td> </tr> <tr> <td style="text-align: left;">errMsg</td> <td style="text-align: left;">string</td> <td>当所查询的卡出现错误时的提示</td> </tr> <tr> <td style="text-align: left;">orderedData</td> <td style="text-align: left;">object</td> <td>已订购套餐数据,当传递orderedData=1时返回此数据,详情请查看下方orderedData参数说明</td> </tr> <tr> <td style="text-align: left;">syscTime</td> <td style="text-align: left;">int</td> <td>数据快照时间,isCache=1时返回此字段</td> </tr> <tr> <td style="text-align: left;">agentName</td> <td style="text-align: left;">string</td> <td>代理商名字;特殊权限APPID返回</td> </tr> <tr> <td style="text-align: left;">svipdl</td> <td style="text-align: left;">int</td> <td>极速会员到期时间</td> </tr> <tr> <td style="text-align: left;">hideTf</td> <td style="text-align: left;">int</td> <td>是否需要隐藏总流量;1:是 0:否</td> </tr> </tbody> </table> <h6>trafficInfo参数说明</h6> <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;">expiration</td> <td style="text-align: left;">int</td> <td>当前有效流量截止日期时间戳</td> </tr> <tr> <td style="text-align: left;">total</td> <td style="text-align: left;">int</td> <td>总流量,单位: MB</td> </tr> <tr> <td style="text-align: left;">used</td> <td style="text-align: left;">float</td> <td>已用流量,单位: MB</td> </tr> </tbody> </table> <h6>orderedData参数说明</h6> <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;">name</td> <td style="text-align: left;">string</td> <td>套餐名字</td> </tr> <tr> <td style="text-align: left;">pkgId</td> <td style="text-align: left;">int</td> <td>套餐ID</td> </tr> <tr> <td style="text-align: left;">traffic</td> <td style="text-align: left;">int</td> <td>流量大小,单位:MB</td> </tr> <tr> <td style="text-align: left;">ntraffic</td> <td style="text-align: left;">float</td> <td>已用量,单位:MB</td> </tr> <tr> <td style="text-align: left;">starttime</td> <td style="text-align: left;">int</td> <td>套餐生效起始时间时间戳</td> </tr> <tr> <td style="text-align: left;">endtime</td> <td style="text-align: left;">int</td> <td>套餐生效结束时间时间戳</td> </tr> <tr> <td style="text-align: left;">addtime</td> <td style="text-align: left;">int</td> <td>订购时间时间戳</td> </tr> </tbody> </table> <h5>备注</h5> <ul> <li>更多返回错误代码请看首页的错误代码描述 [1]: <a href="https://www.showdoc.cc/916774523755909?page_id=4853199661052891">https://www.showdoc.cc/916774523755909?page_id=4853199661052891</a> &quot;《签名算法》&quot; [2]: <a href="https://www.showdoc.cc/916774523755909?page_id=4858492092033167">https://www.showdoc.cc/916774523755909?page_id=4858492092033167</a> &quot;卡类型获取接口&quot; [3]: <a href="https://www.showdoc.cc/916774523755909?page_id=4857645675506969">https://www.showdoc.cc/916774523755909?page_id=4857645675506969</a> &quot;查询实名状态接口&quot;</li> </ul>

页面列表

ITEM_HTML