野象新媒体接口文档

新媒体对外接口文档


子分销商专员列表

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>获取【分销商(子分销商)】专员(账户)列表</li> </ul> <h5>请求URL</h5> <ul> <li><code>/partner/list</code></li> </ul> <h5>请求方式</h5> <ul> <li>GET</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;">pageIndex</td> <td style="text-align: left;">是  </td> <td style="text-align: left;">Long</td> <td>页码:最小值 1  </td> </tr> <tr> <td style="text-align: left;">pageSize  </td> <td style="text-align: left;">是  </td> <td style="text-align: left;">Long</td> <td>页大小范围:[1, 500],即最小值为1,最大值为500</td> </tr> </tbody> </table> <h5>返回示例</h5> <pre><code>{     &amp;quot;code&amp;quot;: 0,     &amp;quot;data&amp;quot;: {         &amp;quot;current&amp;quot;: 1,         &amp;quot;pages&amp;quot;: 1,         &amp;quot;records&amp;quot;: [             {                 &amp;quot;appId&amp;quot;: &amp;quot;10055235410333696&amp;quot;,                 &amp;quot;appType&amp;quot;: 2,                 &amp;quot;state&amp;quot;: 1,                 &amp;quot;subPartnerId&amp;quot;: &amp;quot;10055232482709504&amp;quot;,                 &amp;quot;subPartnerName&amp;quot;: &amp;quot;测试&amp;quot;, &amp;quot;subPartnerUserName&amp;quot;: &amp;quot;测试&amp;quot;             }, ...             {                 &amp;quot;appId&amp;quot;: &amp;quot;16169125814730752&amp;quot;,                 &amp;quot;appType&amp;quot;: 1,                 &amp;quot;state&amp;quot;: 1,                 &amp;quot;subPartnerId&amp;quot;: &amp;quot;16169125378523136&amp;quot;,                 &amp;quot;subPartnerName&amp;quot;: &amp;quot;心智我行&amp;quot;, &amp;quot;subPartnerUserName&amp;quot;: &amp;quot;mvptest&amp;quot;             }         ],         &amp;quot;size&amp;quot;: 10,         &amp;quot;total&amp;quot;: 7     },     &amp;quot;msg&amp;quot;: &amp;quot;OK&amp;quot;,     &amp;quot;traceId&amp;quot;: &amp;quot;67e3eab6-031e-4dd0-98e8-969233860614&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;">Integer</td> <td>返回码          </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;">traceId</td> <td style="text-align: left;">String  </td> <td>链路追踪 ID      </td> </tr> <tr> <td style="text-align: left;">data    </td> <td style="text-align: left;">Object  </td> <td>分页子分销专员列表响应</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;">current</td> <td style="text-align: left;">Long</td> <td>分页-页码  </td> </tr> <tr> <td style="text-align: left;">pages  </td> <td style="text-align: left;">Long</td> <td>分页-总页数</td> </tr> <tr> <td style="text-align: left;">records</td> <td style="text-align: left;">List</td> <td>子分销商专员列表    </td> </tr> <tr> <td style="text-align: left;">size    </td> <td style="text-align: left;">Long</td> <td>分页-页大小</td> </tr> <tr> <td style="text-align: left;">total  </td> <td style="text-align: left;">Long</td> <td>分页-总行数</td> </tr> </tbody> </table> <h6>子分销商专员列表项结构说明</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;">subPartnerId  </td> <td style="text-align: left;">Long    </td> <td>子分销商 ID  </td> </tr> <tr> <td style="text-align: left;">subPartnerName</td> <td style="text-align: left;">String  </td> <td>子分销商名称 </td> </tr> <tr> <td style="text-align: left;">subPartnerUserName</td> <td style="text-align: left;">String</td> <td>子分销商登录名</td> </tr> <tr> <td style="text-align: left;">appId  </td> <td style="text-align: left;">String  </td> <td>应用 ID  </td> </tr> <tr> <td style="text-align: left;">appType</td> <td style="text-align: left;">String  </td> <td>应用类型:&lt;/br&gt;1-微信公众号;&lt;/br&gt;2-微信小程序;&lt;/br&gt;3-抖音小程序;&lt;/br&gt;4-快手小程序;&lt;/br&gt;5-快手联运;&lt;/br&gt;6-快应用。</td> </tr> <tr> <td style="text-align: left;">state  </td> <td style="text-align: left;">String  </td> <td>状态:1-正常;0-停用</td> </tr> </tbody> </table> <h5>备注</h5> <ul> <li>返回错误代码请查看[错误响应](<a href="https://www.showdoc.com.cn/gatewaypartnerv1/10903560257841502">https://www.showdoc.com.cn/gatewaypartnerv1/10903560257841502</a> &quot;错误响应&quot;)页面描述</li> </ul>

页面列表

ITEM_HTML