API渠道服务-接口文档

API渠道服务,提供除充值API以外的标准接口能力。


京东E卡发送验证码

<p>[TOC]</p> <h5>接口描述</h5> <ul> <li>本接口专用于京东E卡直充下单前,充值账号为手机号时,调用获取手机短信验证码。</li> <li>短信验证码有效期为5分钟。当获取验证码成功后,需间隔5分钟才能再次获取验证码。</li> <li>本接口返回的sms_sign值有效期5分钟,与短信验证码是一对一关系,需在福禄开放平台的<strong>[直充下单接口](<a href="https://docs.open.fulu.com/apiDocument?productSolutionId=86ce7354-c80f-42df-8043-7aaf4b1d7d68&amp;id=2d2ef863-395e-4a90-8418-d7b39b4d0852">https://docs.open.fulu.com/apiDocument?productSolutionId=86ce7354-c80f-42df-8043-7aaf4b1d7d68&amp;id=2d2ef863-395e-4a90-8418-d7b39b4d0852</a> &quot;直充下单接口&quot;)</strong>的<code>charge_password</code>字段中传递。</li> </ul> <h5>接口地址</h5> <ul> <li><code>/api/Sms/JdECardSmsCode</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST</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;">app_key</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>开放平台分配给商户的app_key</td> </tr> <tr> <td style="text-align: left;">encrypt_data</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>加密的业务报文,采用AES加密</td> </tr> </tbody> </table> <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;">phone</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;phone&amp;quot;: &amp;quot;17620132013&amp;quot; }</code></pre> <h5>公共请求参数示例</h5> <pre><code> { &amp;quot;app_key&amp;quot;: &amp;quot;i4esv1l+76l/7NQCL3QudG90Fq+YgVfFGJAWgT+7qO1Bm9o/adG/1iwO2qXsAXNB&amp;quot;, &amp;quot;encrypt_data&amp;quot;: &amp;quot;Xik5F60nwXy+dgU5gWNAwFKCM/tW3s6ukBSAKQNoGKI=&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;">code</td> <td style="text-align: left;">是</td> <td style="text-align: left;">int</td> <td>返回码,详见底部《业务错误码》</td> </tr> <tr> <td style="text-align: left;">message</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>返回码描述,详见底部《业务错误码》</td> </tr> <tr> <td style="text-align: left;">result</td> <td style="text-align: left;">否</td> <td style="text-align: left;">string</td> <td>响应结果,json字符串</td> </tr> </tbody> </table> <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;">sms_sign</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>短信sign</td> </tr> </tbody> </table> <h5>成功响应示例</h5> <pre><code> { &amp;quot;code&amp;quot;: 0, &amp;quot;message&amp;quot;: &amp;quot;发送验证码成功&amp;quot;, &amp;quot;result&amp;quot;: &amp;quot;{\&amp;quot;sms_sign\&amp;quot;:\&amp;quot;8kM3DVKEJVOMT8sGqu44VoUdg\&amp;quot;}&amp;quot; }</code></pre> <h5>异常响应示例</h5> <pre><code> { &amp;quot;code&amp;quot;: 4013, &amp;quot;message&amp;quot;: &amp;quot;请勿频繁发送,验证码5分钟内有效&amp;quot;, &amp;quot;result&amp;quot;: &amp;quot;&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;">0</td> <td style="text-align: left;">发送验证码成功</td> <td>接口调用成功,按正常流程处理</td> </tr> <tr> <td style="text-align: left;">1005</td> <td style="text-align: left;">必须传入app_key</td> <td>请检查请求参数app_key是否为空</td> </tr> <tr> <td style="text-align: left;">1006</td> <td style="text-align: left;">无效的app_key</td> <td>1、检查appkey是否复制错误;&lt;br&gt;2、沙箱环境与生产环境数据不互通;&lt;br&gt;3、沙箱环境只能使用沙箱数据;</td> </tr> <tr> <td style="text-align: left;">1020</td> <td style="text-align: left;">接口权限验证失败,请联系接口提供方</td> <td>请联系接口提供方</td> </tr> <tr> <td style="text-align: left;">1021</td> <td style="text-align: left;">Api渠道未启用</td> <td>请联系接口提供方启用Api渠道</td> </tr> <tr> <td style="text-align: left;">1022</td> <td style="text-align: left;">应用加解密Key未配置</td> <td>请联系接口提供方配置应用加解密Key,并提供给您</td> </tr> <tr> <td style="text-align: left;">1023</td> <td style="text-align: left;">接口权限未配置</td> <td>请联系接口提供方配置接口权限</td> </tr> <tr> <td style="text-align: left;">1024</td> <td style="text-align: left;">加密的业务报文为空</td> <td>请检查请求参数encrypt_data是否为空</td> </tr> <tr> <td style="text-align: left;">1025</td> <td style="text-align: left;">业务参数:手机号不能为空</td> <td>请检查加密前的业务报文中phone是否为空</td> </tr> <tr> <td style="text-align: left;">1026</td> <td style="text-align: left;">业务参数:手机号不符合格式</td> <td>请检查加密前的业务报文中phone格式是否正确</td> </tr> <tr> <td style="text-align: left;">4008</td> <td style="text-align: left;">发送验证码失败</td> <td>提供请求报文,联系接口提供方排查</td> </tr> <tr> <td style="text-align: left;">4013</td> <td style="text-align: left;">请勿频繁发送,验证码5分钟内有效</td> <td>5分钟后再尝试获取验证码</td> </tr> <tr> <td style="text-align: left;">5001</td> <td style="text-align: left;">系统异常</td> <td>提供请求报文,联系接口提供方排查</td> </tr> </tbody> </table>

页面列表

ITEM_HTML