获取活动列表
<p>[TOC]</p>
<h5>简要描述</h5>
<ul>
<li>获取活动列表</li>
</ul>
<h5>请求 URL</h5>
<ul>
<li><code>/activity/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;">activityType </td>
<td style="text-align: left;">是 </td>
<td style="text-align: left;">Integer</td>
<td>活动类型：<br/>1-充值活动；<br/>2-赠币活动 </td>
</tr>
<tr>
<td style="text-align: left;">title </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">String </td>
<td>活动标题 </td>
</tr>
<tr>
<td style="text-align: left;">name </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">String </td>
<td>活动名称 </td>
</tr>
<tr>
<td style="text-align: left;">activityState</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">Integer</td>
<td>活动状态：<br/>1-未开始；<br/>2-进行中；<br/>3-暂停；<br/>4-已结束；<br/>5-已关闭</td>
</tr>
<tr>
<td style="text-align: left;">state </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">Integer</td>
<td>启用状态：<br/>1-启用；<br/>0-禁用 </td>
</tr>
<tr>
<td style="text-align: left;">toastState </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">Integer</td>
<td>是否展示弹窗：<br/>1-展示；<br/>0-不展示 </td>
</tr>
<tr>
<td style="text-align: left;">activityBeginTime </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">String </td>
<td>活动创建开始时间（例如：2024-11-01 00:00:00） </td>
</tr>
<tr>
<td style="text-align: left;">activityEndTIme </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">String </td>
<td>活动创建结束时间（例如：2024-11-01 23:59:59） </td>
</tr>
<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>{
&quot;code&quot;: 0,
&quot;data&quot;: {
&quot;current&quot;: 1,
&quot;pages&quot;: 43,
&quot;records&quot;: [
{
&quot;activityStat&quot;: 1,
&quot;activityStatStr&quot;: &quot;未开始&quot;,
&quot;activityTemplateId&quot;: &quot;20894853143724032&quot;,
&quot;activityType&quot;: 1,
&quot;coinsBonus&quot;: null,
&quot;coinsBuy&quot;: null,
&quot;contentType&quot;: 1,
&quot;createDateTime&quot;: &quot;2024-01-25 18:18:41&quot;,
&quot;daysSubscribe&quot;: null,
&quot;endDate&quot;: &quot;2024-02-28 00:00:00&quot;,
&quot;feShowPeriodState&quot;: 1,
&quot;id&quot;: &quot;81451375179333632&quot;,
&quot;limitTimes&quot;: 5,
&quot;limitType&quot;: 2,
&quot;name&quot;: &quot;测试活动01&quot;,
&quot;pageUrl&quot;: &quot;https://wx-open-h5-test.zwlab.cn/activity/81451375179333632?max_app_id=19743565588729856&quot;,
&quot;partnerName&quot;: &quot;西南剧场&quot;,
&quot;portraitList&quot;: [
{
&quot;portraitId&quot;: &quot;13&quot;,
&quot;portraitName&quot;: &quot;尾号偶数vip用户&quot;,
&quot;productId&quot;: &quot;81437541731401728&quot;,
&quot;productName&quot;: &quot;测试&quot;
}
],
&quot;portraitProductRela&quot;: &quot;[{\&quot;portraitId\&quot;:\&quot;13\&quot;,
\&quot;portraitName\&quot;:\&quot;尾号偶数vip用户\&quot;,
\&quot;productId\&quot;:\&quot;81437541731401728\&quot;,
\&quot;productName\&quot;:\&quot;测试\&quot;}]&quot;,
&quot;price&quot;: 0,
&quot;productId&quot;: &quot;0&quot;,
&quot;productName&quot;: null,
&quot;productType&quot;: 0,
&quot;productTypeStr&quot;: &quot;&quot;,
&quot;showPersonType&quot;: 1,
&quot;startDate&quot;: &quot;2024-01-31 00:00:00&quot;,
&quot;state&quot;: 1,
&quot;stateStr&quot;: &quot;启用&quot;,
&quot;templateInfo&quot;: null,
&quot;title&quot;: &quot;测试活动01&quot;,
&quot;toastPosition&quot;: 63,
&quot;toastPositionList&quot;: [
1,
2,
4,
8,
16,
32
],
&quot;toastStat&quot;: 1,
&quot;todayClickPersonCount&quot;: 0,
&quot;todayGainPersonCount&quot;: 0,
&quot;todayPayPersonCount&quot;: 0,
&quot;todayRechargeAmount&quot;: 0,
&quot;todayRechargePersonCount&quot;: 0,
&quot;totalClickPersonCount&quot;: 0,
&quot;totalGainPersonCount&quot;: 0,
&quot;totalPayPersonCount&quot;: 0,
&quot;totalRechargeAmount&quot;: 0,
&quot;totalRechargePersonCount&quot;: 0,
&quot;updateDateTime&quot;: &quot;2024-01-25 18:18:41&quot;
},
{
&quot;activityStat&quot;: 4,
&quot;activityStatStr&quot;: &quot;已结束&quot;,
&quot;activityTemplateId&quot;: &quot;47341699701407744&quot;,
&quot;activityType&quot;: 1,
&quot;coinsBonus&quot;: null,
&quot;coinsBuy&quot;: null,
&quot;contentType&quot;: 1,
&quot;createDateTime&quot;: &quot;2023-12-29 10:23:46&quot;,
&quot;daysSubscribe&quot;: null,
&quot;endDate&quot;: &quot;2024-01-17 00:00:00&quot;,
&quot;feShowPeriodState&quot;: 0,
&quot;id&quot;: &quot;71547386669305856&quot;,
&quot;limitTimes&quot;: 1,
&quot;limitType&quot;: 2,
&quot;name&quot;: &quot;1111122&quot;,
&quot;pageUrl&quot;: &quot;https://wx-open-h5-test.zwlab.cn/activity/71547386669305856?max_app_id=19743565588729856&quot;,
&quot;partnerName&quot;: &quot;西南剧场&quot;,
&quot;portraitList&quot;: null,
&quot;portraitProductRela&quot;: &quot;&quot;,
&quot;price&quot;: 0,
&quot;productId&quot;: &quot;0&quot;,
&quot;productName&quot;: null,
&quot;productType&quot;: 0,
&quot;productTypeStr&quot;: &quot;&quot;,
&quot;showPersonType&quot;: 0,
&quot;startDate&quot;: &quot;2023-12-06 00:00:00&quot;,
&quot;state&quot;: 1,
&quot;stateStr&quot;: &quot;启用&quot;,
&quot;templateInfo&quot;: null,
&quot;title&quot;: &quot;12&quot;,
&quot;toastPosition&quot;: 0,
&quot;toastPositionList&quot;: [],
&quot;toastStat&quot;: 0,
&quot;todayClickPersonCount&quot;: 0,
&quot;todayGainPersonCount&quot;: 0,
&quot;todayPayPersonCount&quot;: 0,
&quot;todayRechargeAmount&quot;: 0,
&quot;todayRechargePersonCount&quot;: 0,
&quot;totalClickPersonCount&quot;: 0,
&quot;totalGainPersonCount&quot;: 0,
&quot;totalPayPersonCount&quot;: 0,
&quot;totalRechargeAmount&quot;: 0,
&quot;totalRechargePersonCount&quot;: 0,
&quot;updateDateTime&quot;: &quot;2023-12-29 10:23:46&quot;
}
],
&quot;size&quot;: 2,
&quot;total&quot;: 85
},
&quot;msg&quot;: &quot;OK&quot;,
&quot;traceId&quot;: &quot;1bae256e-8550-44cb-98a9-1304ab7e8a7f&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;">title </td>
<td style="text-align: left;">String </td>
<td>活动标题 </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;">productId </td>
<td style="text-align: left;">String </td>
<td>商品 ID </td>
</tr>
<tr>
<td style="text-align: left;">activityType </td>
<td style="text-align: left;">Integer </td>
<td>活动类型：<br/>1-充值活动；<br/>2-赠币活动</td>
</tr>
<tr>
<td style="text-align: left;">startDate</td>
<td style="text-align: left;">DateTime</td>
<td>活动开始时间</td>
</tr>
<tr>
<td style="text-align: left;">endDate</td>
<td style="text-align: left;">DateTime</td>
<td>活动结束时间</td>
</tr>
<tr>
<td style="text-align: left;">activityTemplateId </td>
<td style="text-align: left;">String </td>
<td>活动模板 ID </td>
</tr>
<tr>
<td style="text-align: left;">limitType </td>
<td style="text-align: left;">Integer </td>
<td>限购类型：<br/>1-按活动；<br/>2-按用户 </td>
</tr>
<tr>
<td style="text-align: left;">limitTimes </td>
<td style="text-align: left;">Integer </td>
<td>限购次数 </td>
</tr>
<tr>
<td style="text-align: left;">toastStat </td>
<td style="text-align: left;">Integer </td>
<td>是否展示弹窗：<br/>1-展示；<br/>0-不展示</td>
</tr>
<tr>
<td style="text-align: left;">toastPosition </td>
<td style="text-align: left;">Integer </td>
<td>弹窗位置，多选，分<br/><strong>小程序：</strong><br/>0-全部；<br/>1-小程序首页；<br/>2-追剧页；<br/>4-个人中心；<br/>8-继续观看；<br/>16-播放页。<br/><br/><strong>H5:</strong> <br/>0-全部；<br/>1-男频；<br/>2-女频；<br/>4-最近阅读；<br/>8-个人中心；<br/>16-分类；<br/>32-阅读页。 </td>
</tr>
<tr>
<td style="text-align: left;">toastPositionList</td>
<td style="text-align: left;">Array</td>
<td>弹窗位置集合</td>
</tr>
<tr>
<td style="text-align: left;">feShowPeriodState </td>
<td style="text-align: left;">Integer </td>
<td>前端展示活动有效期：<br/>0-不展示；<br/>1-展示 </td>
</tr>
<tr>
<td style="text-align: left;">updateDateTime</td>
<td style="text-align: left;">DateTime</td>
<td>更新时间</td>
</tr>
<tr>
<td style="text-align: left;">contentType</td>
<td style="text-align: left;">Integer</td>
<td>内容类型：</br>1-小说；</br>2-短剧；</br>4-短篇。</td>
</tr>
<tr>
<td style="text-align: left;">partnerName</td>
<td style="text-align: left;">String</td>
<td>分销商名称</td>
</tr>
<tr>
<td style="text-align: left;">showPersonType </td>
<td style="text-align: left;">Integer </td>
<td>展示用户类型：</br>0-全部用户；</br>1-按用户画像 </td>
</tr>
<tr>
<td style="text-align: left;">portraitProductRela </td>
<td style="text-align: left;">String </td>
<td>画像和商品关联关系 </td>
</tr>
<tr>
<td style="text-align: left;">portraitList</td>
<td style="text-align: left;">List<Object></td>
<td>画像商品关系 当 showPersonType为 1 时有值</td>
</tr>
<tr>
<td style="text-align: left;">pageUrl</td>
<td style="text-align: left;">String</td>
<td>活动页面</td>
</tr>
<tr>
<td style="text-align: left;">activityStat</td>
<td style="text-align: left;">Integer</td>
<td>活动状态：<br/>1-未开始；<br/>2-进行中；<br/>3-暂停；<br/>4-已结束；<br/>5-已关闭</td>
</tr>
<tr>
<td style="text-align: left;">activityStatStr</td>
<td style="text-align: left;">String</td>
<td>活动状态字符串</td>
</tr>
<tr>
<td style="text-align: left;">stateStr</td>
<td style="text-align: left;">String</td>
<td>启用状态字符串</td>
</tr>
<tr>
<td style="text-align: left;">productType</td>
<td style="text-align: left;">Integer</td>
<td>商品类型：<br/>1-金币充值；<br/>2- VIP 充值</td>
</tr>
<tr>
<td style="text-align: left;">productTypeStr</td>
<td style="text-align: left;">String</td>
<td>商品类型字符串</td>
</tr>
<tr>
<td style="text-align: left;">productName</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>启用状态：<br/>1-启用；<br/>0-禁用 </td>
</tr>
<tr>
<td style="text-align: left;">price</td>
<td style="text-align: left;">Integer</td>
<td>原价，单位：分</td>
</tr>
<tr>
<td style="text-align: left;">totalRechargePersonCount</td>
<td style="text-align: left;">Long</td>
<td>总下单人数(充值活动专用)</td>
</tr>
<tr>
<td style="text-align: left;">todayRechargePersonCount</td>
<td style="text-align: left;">Long</td>
<td>今日下单人数(充值活动专用)</td>
</tr>
<tr>
<td style="text-align: left;">totalPayPersonCount</td>
<td style="text-align: left;">Long</td>
<td>总充值人数(充值活动专用)</td>
</tr>
<tr>
<td style="text-align: left;">todayPayPersonCount</td>
<td style="text-align: left;">Long</td>
<td>今日充值人数(充值活动专用)</td>
</tr>
<tr>
<td style="text-align: left;">totalRechargeAmount</td>
<td style="text-align: left;">BigDecimal</td>
<td>总充值金额(充值活动专用)</td>
</tr>
<tr>
<td style="text-align: left;">todayRechargeAmount</td>
<td style="text-align: left;">BigDecimal</td>
<td>今日充值金额(充值活动专用)</td>
</tr>
<tr>
<td style="text-align: left;">totalGainPersonCount</td>
<td style="text-align: left;">Long</td>
<td>总领取人数(赠送活动专用)</td>
</tr>
<tr>
<td style="text-align: left;">todayGainPersonCount</td>
<td style="text-align: left;">Long</td>
<td>今日领取人数(赠送活动专用)</td>
</tr>
<tr>
<td style="text-align: left;">totalClickPersonCount</td>
<td style="text-align: left;">Long</td>
<td>总点击人数(赠送活动专用)</td>
</tr>
<tr>
<td style="text-align: left;">todayClickPersonCount</td>
<td style="text-align: left;">Long</td>
<td>今日点击人数(赠送活动专用)</td>
</tr>
<tr>
<td style="text-align: left;">coinsBuy</td>
<td style="text-align: left;">Integer</td>
<td>获得金币数</td>
</tr>
<tr>
<td style="text-align: left;">coinsBonus</td>
<td style="text-align: left;">Integer</td>
<td>赠送金币数</td>
</tr>
<tr>
<td style="text-align: left;">daysSubscribe</td>
<td style="text-align: left;">Integer</td>
<td>VIP 订阅天数</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> "错误响应")页面描述</li>
</ul>