内容列表
<p>[TOC]</p>
<h5>简要描述</h5>
<ul>
<li>获取应用内容列表</li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>/content/list</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;">appId </td>
<td style="text-align: left;">是 </td>
<td style="text-align: left;">Long </td>
<td>应用 ID </td>
</tr>
<tr>
<td style="text-align: left;">contentType </td>
<td style="text-align: left;">是 </td>
<td style="text-align: left;">Integer</td>
<td>内容类型:</br>1-小说;</br>2-短剧;</br>4-短篇。</td>
</tr>
<tr>
<td style="text-align: left;">contentIdOrName</td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">String </td>
<td>内容 ID 或名称 </td>
</tr>
<tr>
<td style="text-align: left;">contentIds</td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">Array </td>
<td>内容 IDs 数组,最多100条 </td>
</tr>
<tr>
<td style="text-align: left;">contentChannel </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">Integer</td>
<td>频道:1-男频;2-女频</td>
</tr>
<tr>
<td style="text-align: left;">contentClassId </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">String </td>
<td>分类 </td>
</tr>
<tr>
<td style="text-align: left;">orderIndexStart</td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">Integer</td>
<td>派单指数开始区间</td>
</tr>
<tr>
<td style="text-align: left;">orderIndexEnd </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">Integer</td>
<td>派单指数结束区间</td>
</tr>
<tr>
<td style="text-align: left;">beginUpdateDateTime</td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">DateTime </td>
<td>内容更新开始时间<strong>(与结束时间配对使用)</strong>,<br/>格式“yyyy-MM-dd HH:mm:ss”,</br>例如:“2023-09-04 19:11:56”<br/>或者“yyyy-MM-dd”,</br>例如:“2023-09-04”,<br/><strong>注意包含开始时间</strong> </td>
</tr>
<tr>
<td style="text-align: left;">endUpdateDateTime </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">DateTime </td>
<td>内容更新结束时间<strong>(与开始时间配对使用)</strong>,<br/>格式“yyyy-MM-dd HH:mm:ss”,</br>例如:“2023-09-04 19:11:56”<br/>或者“yyyy-MM-dd”,</br>例如:“2023-09-04”,<br/><strong>注意包含结束时间</strong></td>
</tr>
<tr>
<td style="text-align: left;">contentKeywords</td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">String </td>
<td>任务角色名称 </td>
</tr>
<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],即最小值为1,最大值为100</td>
</tr>
</tbody>
</table>
<h5>请求示例</h5>
<pre><code>POST https://gateway-partner.nm-serv.cn/content/list
Auth-Id: 10031951729917988
Authorization: 2UoNZXWfg9ya9Rwj
Content-Type: application/json
{
&quot;appId&quot;: &quot;10055235410393366&quot;,
&quot;contentType&quot;: 1,
&quot;pageIndex&quot;: 1,
&quot;pageSize&quot;: 100
}</code></pre>
<h5>返回示例</h5>
<pre><code>{
&quot;code&quot;:0,
&quot;data&quot;:{
&quot;current&quot;:1,
&quot;pages&quot;:1,
&quot;records&quot;:[
{
&quot;chapterFirstFrameImageId&quot;:&quot;0&quot;,
&quot;chapterNum&quot;:6,
&quot;chargeType&quot;:null,
&quot;chargeTypeStr&quot;:&quot;&quot;,
&quot;code&quot;:10045,
&quot;contentChannel&quot;:1,
&quot;contentChannelStr&quot;:&quot;男频&quot;,
&quot;contentClassId&quot;:&quot;13631116309430272&quot;,
&quot;contentClassName&quot;:&quot;小说男频&quot;,
&quot;contentCoverFileId&quot;:&quot;16118818527248384&quot;,
&quot;contentCoverUrl&quot;:&quot;https://xxxx.1.jpg&quot;,
&quot;contentIconList&quot;:[
{
&quot;contentId&quot;:&quot;16116641045938176&quot;,
&quot;createDateTime&quot;:&quot;2023-07-31 10:03:15&quot;,
&quot;iconId&quot;:&quot;2072596837568512&quot;,
&quot;id&quot;:&quot;16821653174747136&quot;,
&quot;rgb&quot;:&quot;#0000ff&quot;,
&quot;title&quot;:&quot;青春浪漫&quot;
},
{
&quot;contentId&quot;:&quot;16116641045938176&quot;,
&quot;createDateTime&quot;:&quot;2023-07-31 10:03:15&quot;,
&quot;iconId&quot;:&quot;976064365379584&quot;,
&quot;id&quot;:&quot;16821653174747137&quot;,
&quot;rgb&quot;:&quot;#00ff00&quot;,
&quot;title&quot;:&quot;测试标题&quot;
},
{
&quot;contentId&quot;:&quot;16116641045938176&quot;,
&quot;createDateTime&quot;:&quot;2023-07-31 10:03:15&quot;,
&quot;iconId&quot;:&quot;975887978119168&quot;,
&quot;id&quot;:&quot;16821653174747138&quot;,
&quot;rgb&quot;:&quot;#ff0000&quot;,
&quot;title&quot;:&quot;测试标题2&quot;
}
],
&quot;contentName&quot;:&quot;御医笔记11&quot;,
&quot;contentType&quot;:1,
&quot;contentTypeStr&quot;:&quot;小说&quot;,
&quot;createDateTime&quot;:&quot;2023-07-29 11:21:47&quot;,
&quot;downloadPassword&quot;:null,
&quot;downloadTitle&quot;:null,
&quot;downloadUrl&quot;:null,
&quot;finishStatus&quot;:0,
&quot;finishStatusStr&quot;:&quot;连载&quot;,
&quot;id&quot;:&quot;16116641045938176&quot;,
&quot;introduce&quot;:&quot;一二三四⑤&quot;,
&quot;needPayChapterMinNo&quot;:null,
&quot;needSubscribeChapterMinNo&quot;:null,
&quot;operationalRecommendation&quot;:&quot;运运运话营运运营&quot;,
&quot;orderIndex&quot;:80,
&quot;priceAmount&quot;:null,
&quot;rankRecommendationFileId&quot;:&quot;16120780517801984&quot;,
&quot;rankRecommendationFileUrl&quot;:&quot;https://xxx.txt&quot;,
&quot;rankStartChapterNo&quot;:4,
&quot;rankSubscribeChapterNo&quot;:4,
&quot;tagList&quot;:[
{
&quot;id&quot;:&quot;16816500912685056&quot;,
&quot;name&quot;:&quot;标签11&quot;
},
{
&quot;id&quot;:&quot;16816500912685057&quot;,
&quot;name&quot;:&quot;标签22&quot;
},
{
&quot;id&quot;:&quot;16816500912685058&quot;,
&quot;name&quot;:&quot;标签33&quot;
},
{
&quot;id&quot;:&quot;15497627324125184&quot;,
&quot;name&quot;:&quot;现代1&quot;
}
],
&quot;updateDateTime&quot;:&quot;2023-07-31 10:13:56&quot;,
&quot;wordNum&quot;:10000
}
],
&quot;size&quot;:1,
&quot;total&quot;:1
},
&quot;msg&quot;:&quot;OK&quot;,
&quot;traceId&quot;:&quot;e8f30093-97d9-4027-8479-6f3b1239ecfd&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;">String </td>
<td>内容 ID,用于其它接口的内容 ID:<code>contentId</code> 入参 </td>
</tr>
<tr>
<td style="text-align: left;">createDateTime </td>
<td style="text-align: left;">DateTime</td>
<td>创建时间 </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;">code </td>
<td style="text-align: left;">Integer </td>
<td>内容 code </td>
</tr>
<tr>
<td style="text-align: left;">contentType </td>
<td style="text-align: left;">Integer </td>
<td>内容业务类型 </td>
</tr>
<tr>
<td style="text-align: left;">contentTypeStr </td>
<td style="text-align: left;">String </td>
<td>内容业务类型描述 </td>
</tr>
<tr>
<td style="text-align: left;">contentChannel </td>
<td style="text-align: left;">Integer </td>
<td>内容频道 ID </td>
</tr>
<tr>
<td style="text-align: left;">contentChannelStr </td>
<td style="text-align: left;">String </td>
<td>内容频道描述 </td>
</tr>
<tr>
<td style="text-align: left;">contentClassId </td>
<td style="text-align: left;">String </td>
<td>内容分类 ID </td>
</tr>
<tr>
<td style="text-align: left;">contentClassName </td>
<td style="text-align: left;">String </td>
<td>内容分类名称 </td>
</tr>
<tr>
<td style="text-align: left;">contentName </td>
<td style="text-align: left;">String </td>
<td>内容名称 </td>
</tr>
<tr>
<td style="text-align: left;">contentCoverFileId </td>
<td style="text-align: left;">String </td>
<td>封面文件 ID </td>
</tr>
<tr>
<td style="text-align: left;">contentCoverUrl </td>
<td style="text-align: left;">String </td>
<td>封面文件地址 </td>
</tr>
<tr>
<td style="text-align: left;">chapterFirstFrameImageId </td>
<td style="text-align: left;">String </td>
<td>默认章节首帧图片 ID </td>
</tr>
<tr>
<td style="text-align: left;">finishStatus </td>
<td style="text-align: left;">Integer </td>
<td>完结状态:0=连载 1=完结 </td>
</tr>
<tr>
<td style="text-align: left;">finishStatusStr </td>
<td style="text-align: left;">String </td>
<td>完结状态描述 </td>
</tr>
<tr>
<td style="text-align: left;">wordNum </td>
<td style="text-align: left;">Integer </td>
<td>字数 </td>
</tr>
<tr>
<td style="text-align: left;">chapterNum </td>
<td style="text-align: left;">Integer </td>
<td>章节规划数量 </td>
</tr>
<tr>
<td style="text-align: left;">introduce </td>
<td style="text-align: left;">String </td>
<td>简介 </td>
</tr>
<tr>
<td style="text-align: left;">priceAmount </td>
<td style="text-align: left;">Integer </td>
<td>价格金额;单位金币个数 </td>
</tr>
<tr>
<td style="text-align: left;">needPayChapterMinNo </td>
<td style="text-align: left;">Integer </td>
<td>起始收费章节序号 </td>
</tr>
<tr>
<td style="text-align: left;">needSubscribeChapterMinNo</td>
<td style="text-align: left;">Integer </td>
<td>起始关注章节序号 </td>
</tr>
<tr>
<td style="text-align: left;">orderIndex </td>
<td style="text-align: left;">Integer </td>
<td>派单指数 </td>
</tr>
<tr>
<td style="text-align: left;">operationalRecommendation</td>
<td style="text-align: left;">String </td>
<td>运营推荐话术 </td>
</tr>
<tr>
<td style="text-align: left;">rankRecommendationFileId </td>
<td style="text-align: left;">String </td>
<td>投放推荐话术文件 ID </td>
</tr>
<tr>
<td style="text-align: left;">rankRecommendationFileUrl</td>
<td style="text-align: left;">String </td>
<td>投放推荐话术文件 </td>
</tr>
<tr>
<td style="text-align: left;">rankStartChapterNo </td>
<td style="text-align: left;">Integer </td>
<td>推荐正文章节序号 </td>
</tr>
<tr>
<td style="text-align: left;">rankSubscribeChapterNo </td>
<td style="text-align: left;">Integer </td>
<td>推荐关注章节序号 </td>
</tr>
<tr>
<td style="text-align: left;">downloadTitle </td>
<td style="text-align: left;">String </td>
<td>下载标题 </td>
</tr>
<tr>
<td style="text-align: left;">downloadUrl </td>
<td style="text-align: left;">String </td>
<td>素材下载链接 </td>
</tr>
<tr>
<td style="text-align: left;">downloadPassword </td>
<td style="text-align: left;">String </td>
<td>下载密码 </td>
</tr>
<tr>
<td style="text-align: left;">contentIconList </td>
<td style="text-align: left;">List </td>
<td>角标信息 </td>
</tr>
<tr>
<td style="text-align: left;">tagList </td>
<td style="text-align: left;">List </td>
<td>标签列表 </td>
</tr>
<tr>
<td style="text-align: left;">chargeType </td>
<td style="text-align: left;">Integer </td>
<td>收费方式:1=按章节收费 2=按内容收费</td>
</tr>
<tr>
<td style="text-align: left;">chargeTypeStr </td>
<td style="text-align: left;">String </td>
<td>收费方式描述 </td>
</tr>
<tr>
<td style="text-align: left;">contentKeywords </td>
<td style="text-align: left;">String </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;">contentId </td>
<td style="text-align: left;">String </td>
<td>内容 ID </td>
</tr>
<tr>
<td style="text-align: left;">iconId </td>
<td style="text-align: left;">Stirng </td>
<td>角标 ID </td>
</tr>
<tr>
<td style="text-align: left;">createDateTime</td>
<td style="text-align: left;">String </td>
<td>创建时间 </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;">rgb </td>
<td style="text-align: left;">String </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>选项值 </td>
</tr>
<tr>
<td style="text-align: left;">name </td>
<td style="text-align: left;">String </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> "错误响应")页面描述</li>
</ul>