野象新媒体接口文档

新媒体对外接口文档


获取活动模板列表

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>获取活动模板列表</li> </ul> <h5>请求 URL</h5> <ul> <li><code>/activity/template/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;">Integer</td> <td>页码:最小值 1              </td> </tr> <tr> <td style="text-align: left;">pageSize      </td> <td style="text-align: left;">是  </td> <td style="text-align: left;">Integer</td> <td>页大小范围:[1, 100],即最小值为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;: 21, &amp;quot;records&amp;quot;: [ { &amp;quot;backgroundImgFileId&amp;quot;: &amp;quot;0&amp;quot;, &amp;quot;backgroundImgUrl&amp;quot;: null, &amp;quot;bannerImgFileId&amp;quot;: &amp;quot;75522843018006528&amp;quot;, &amp;quot;bannerImgUrl&amp;quot;: &amp;quot;https://mv-oss.zwlab.cn/new-media/test/content/cover/opeixxxaug.png&amp;quot;, &amp;quot;buttonImgFileId&amp;quot;: &amp;quot;0&amp;quot;, &amp;quot;buttonImgUrl&amp;quot;: null, &amp;quot;contentText&amp;quot;: &amp;quot;2&amp;quot;, &amp;quot;createDateTime&amp;quot;: &amp;quot;2024-01-09 09:40:54&amp;quot;, &amp;quot;id&amp;quot;: &amp;quot;75522866300583936&amp;quot;, &amp;quot;layerImgFileId&amp;quot;: &amp;quot;75522854485233664&amp;quot;, &amp;quot;layerImgUrl&amp;quot;: &amp;quot;https://mv-oss.zwlab.cn/new-media/test/content/cover/ozgxxxl3h6.png&amp;quot;, &amp;quot;name&amp;quot;: &amp;quot;1&amp;quot;, &amp;quot;state&amp;quot;: 1, &amp;quot;stateStr&amp;quot;: &amp;quot;启用&amp;quot; }, { &amp;quot;backgroundImgFileId&amp;quot;: &amp;quot;0&amp;quot;, &amp;quot;backgroundImgUrl&amp;quot;: null, &amp;quot;bannerImgFileId&amp;quot;: &amp;quot;47341611226759168&amp;quot;, &amp;quot;bannerImgUrl&amp;quot;: &amp;quot;https://mv-oss.zwlab.cn/new-media/test/content/cover/ru6exxklp.jpg&amp;quot;, &amp;quot;buttonImgFileId&amp;quot;: &amp;quot;0&amp;quot;, &amp;quot;buttonImgUrl&amp;quot;: null, &amp;quot;contentText&amp;quot;: &amp;quot;快应用赠币&amp;quot;, &amp;quot;createDateTime&amp;quot;: &amp;quot;2023-10-23 15:19:01&amp;quot;, &amp;quot;id&amp;quot;: &amp;quot;47341699701407744&amp;quot;, &amp;quot;layerImgFileId&amp;quot;: &amp;quot;47341671213703168&amp;quot;, &amp;quot;layerImgUrl&amp;quot;: &amp;quot;https://mv-oss.zwlab.cn/new-media/test/content/cover/0f1xx77.png&amp;quot;, &amp;quot;name&amp;quot;: &amp;quot;快应用赠币&amp;quot;, &amp;quot;state&amp;quot;: 1, &amp;quot;stateStr&amp;quot;: &amp;quot;启用&amp;quot; } ], &amp;quot;size&amp;quot;: 2, &amp;quot;total&amp;quot;: 41 }, &amp;quot;msg&amp;quot;: &amp;quot;OK&amp;quot;, &amp;quot;traceId&amp;quot;: &amp;quot;289360b4-a05c-4339-ad18-3c079b3b79d8&amp;quot; }</code></pre> <h5>返回参数说明</h5> <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;">String  </td> <td>模板 ID                  </td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">String</td> <td>模板名称</td> </tr> <tr> <td style="text-align: left;">bannerImgUrl          </td> <td style="text-align: left;">String  </td> <td>banner 图               </td> </tr> <tr> <td style="text-align: left;">backgroundImgUrl      </td> <td style="text-align: left;">String  </td> <td>背景图                   </td> </tr> <tr> <td style="text-align: left;">buttonImgUrl          </td> <td style="text-align: left;">String  </td> <td>按钮图                   </td> </tr> <tr> <td style="text-align: left;">layerImgUrl          </td> <td style="text-align: left;">String  </td> <td>弹层图                  </td> </tr> <tr> <td style="text-align: left;">bannerImgFileId      </td> <td style="text-align: left;">String  </td> <td>banner 图 ID        </td> </tr> <tr> <td style="text-align: left;">backgroundImgFileId  </td> <td style="text-align: left;">String  </td> <td>背景图 ID           </td> </tr> <tr> <td style="text-align: left;">buttonImgFileId      </td> <td style="text-align: left;">String  </td> <td>按钮图 ID           </td> </tr> <tr> <td style="text-align: left;">layerImgFileId        </td> <td style="text-align: left;">String  </td> <td>弹层图 ID           </td> </tr> <tr> <td style="text-align: left;">contentText</td> <td style="text-align: left;">String</td> <td>文案</td> </tr> <tr> <td style="text-align: left;">state</td> <td style="text-align: left;">Integer</td> <td>0-无效;1-有效</td> </tr> <tr> <td style="text-align: left;">stateStr</td> <td style="text-align: left;">String</td> <td>0-无效;1-有效,默认为 1</td> </tr> <tr> <td style="text-align: left;">createDateTime</td> <td style="text-align: left;">DateTime</td> <td>创建时间</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