野象新媒体接口文档

新媒体对外接口文档


应用列表

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>获取应用列表</li> </ul> <h5>请求URL</h5> <ul> <li><code>/app/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, 100]</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;: 3,         &amp;quot;records&amp;quot;: [             {                 &amp;quot;appName&amp;quot;: &amp;quot;幻海剧场&amp;quot;,                 &amp;quot;appType&amp;quot;: 1,                 &amp;quot;contentType&amp;quot;: 2,                 &amp;quot;id&amp;quot;: 15136205259931648,                 &amp;quot;miniAppId&amp;quot;: &amp;quot;xxxxxxxxxxxxxxxxx&amp;quot;, &amp;quot;miniOriId&amp;quot;: &amp;quot;xxxxxxxxxxxxxxxxx&amp;quot;,                 &amp;quot;miniAppName&amp;quot;: &amp;quot;野鹿剧场&amp;quot;,                 &amp;quot;reportType&amp;quot;: 9, &amp;quot;wxOriginalId&amp;quot;: &amp;quot;xxxxxxxxxxxxxxxxx&amp;quot;,                 &amp;quot;wxAppId&amp;quot;: &amp;quot;wxxxxxxxxxxxxxxxxx&amp;quot;,                 &amp;quot;wxAppName&amp;quot;: &amp;quot;&amp;quot;             },             {                 &amp;quot;appName&amp;quot;: &amp;quot;大片剧院&amp;quot;,                 &amp;quot;appType&amp;quot;: 1,                 &amp;quot;contentType&amp;quot;: 1,                 &amp;quot;id&amp;quot;: 15135458145337344,                 &amp;quot;miniAppId&amp;quot;: &amp;quot;xxxxxxxxxxxxxxxxx&amp;quot;, &amp;quot;miniOriId&amp;quot;: &amp;quot;xxxxxxxxxxxxxxxxx&amp;quot;,                 &amp;quot;miniAppName&amp;quot;: &amp;quot;野鹿剧场&amp;quot;,                 &amp;quot;reportType&amp;quot;: 9, &amp;quot;wxOriginalId&amp;quot;: &amp;quot;xxxxxxxxxxxxxxxxx&amp;quot;,                 &amp;quot;wxAppId&amp;quot;: &amp;quot;wxxxxxxxxxxxxxxxxx&amp;quot;,                 &amp;quot;wxAppName&amp;quot;: &amp;quot;大片剧院&amp;quot;             }         ],         &amp;quot;size&amp;quot;: 2,         &amp;quot;total&amp;quot;: 5     },     &amp;quot;msg&amp;quot;: &amp;quot;OK&amp;quot;,     &amp;quot;traceId&amp;quot;: &amp;quot;24da3936-2883-42cd-9c54-6fa6260a8dec&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;">id          </td> <td style="text-align: left;">Long    </td> <td>应用 ID                </td> </tr> <tr> <td style="text-align: left;">appName    </td> <td style="text-align: left;">String  </td> <td>应用名称              </td> </tr> <tr> <td style="text-align: left;">wxOriginalId</td> <td style="text-align: left;">String</td> <td>授权微信公众号原始 ID</td> </tr> <tr> <td style="text-align: left;">wxAppId    </td> <td style="text-align: left;">String  </td> <td>授权公众号 ID  </td> </tr> <tr> <td style="text-align: left;">wxAppName  </td> <td style="text-align: left;">String  </td> <td>授权公众号名称</td> </tr> <tr> <td style="text-align: left;">miniAppId  </td> <td style="text-align: left;">String  </td> <td>小程序 ID              </td> </tr> <tr> <td style="text-align: left;">miniOriId  </td> <td style="text-align: left;">String  </td> <td>小程序原始 ID              </td> </tr> <tr> <td style="text-align: left;">miniAppName</td> <td style="text-align: left;">String  </td> <td>小程序名称            </td> </tr> <tr> <td style="text-align: left;">contentType</td> <td style="text-align: left;">Integer</td> <td>内容类型:&lt;/br&gt;1-小说;&lt;/br&gt;2-短剧;&lt;/br&gt;4-短篇。              </td> </tr> <tr> <td style="text-align: left;">appType    </td> <td style="text-align: left;">Integer</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;">reportType  </td> <td style="text-align: left;">Integer</td> <td>上报类型,参见枚举值页面              </td> </tr> <tr> <td style="text-align: left;">h5Domain  </td> <td style="text-align: left;">String</td> <td>小说H5域名              </td> </tr> </tbody> </table> <h5>备注</h5> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML