野象新媒体接口文档

新媒体对外接口文档


内容列表

<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>内容类型:&lt;/br&gt;1-小说;&lt;/br&gt;2-短剧;&lt;/br&gt;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>,&lt;br/&gt;格式“yyyy-MM-dd HH:mm:ss”,&lt;/br&gt;例如:“2023-09-04 19:11:56”&lt;br/&gt;或者“yyyy-MM-dd”,&lt;/br&gt;例如:“2023-09-04”,&lt;br/&gt;<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>,&lt;br/&gt;格式“yyyy-MM-dd HH:mm:ss”,&lt;/br&gt;例如:“2023-09-04 19:11:56”&lt;br/&gt;或者“yyyy-MM-dd”,&lt;/br&gt;例如:“2023-09-04”,&lt;br/&gt;<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 { &amp;quot;appId&amp;quot;: &amp;quot;10055235410393366&amp;quot;, &amp;quot;contentType&amp;quot;: 1, &amp;quot;pageIndex&amp;quot;: 1, &amp;quot;pageSize&amp;quot;: 100 }</code></pre> <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;chapterFirstFrameImageId&amp;quot;:&amp;quot;0&amp;quot;,                 &amp;quot;chapterNum&amp;quot;:6,                 &amp;quot;chargeType&amp;quot;:null,                 &amp;quot;chargeTypeStr&amp;quot;:&amp;quot;&amp;quot;,                 &amp;quot;code&amp;quot;:10045,                 &amp;quot;contentChannel&amp;quot;:1,                 &amp;quot;contentChannelStr&amp;quot;:&amp;quot;男频&amp;quot;,                 &amp;quot;contentClassId&amp;quot;:&amp;quot;13631116309430272&amp;quot;,                 &amp;quot;contentClassName&amp;quot;:&amp;quot;小说男频&amp;quot;,                 &amp;quot;contentCoverFileId&amp;quot;:&amp;quot;16118818527248384&amp;quot;,                 &amp;quot;contentCoverUrl&amp;quot;:&amp;quot;https://xxxx.1.jpg&amp;quot;,                 &amp;quot;contentIconList&amp;quot;:[                     {                         &amp;quot;contentId&amp;quot;:&amp;quot;16116641045938176&amp;quot;,                         &amp;quot;createDateTime&amp;quot;:&amp;quot;2023-07-31 10:03:15&amp;quot;,                         &amp;quot;iconId&amp;quot;:&amp;quot;2072596837568512&amp;quot;,                         &amp;quot;id&amp;quot;:&amp;quot;16821653174747136&amp;quot;,                         &amp;quot;rgb&amp;quot;:&amp;quot;#0000ff&amp;quot;,                         &amp;quot;title&amp;quot;:&amp;quot;青春浪漫&amp;quot;                     },                     {                         &amp;quot;contentId&amp;quot;:&amp;quot;16116641045938176&amp;quot;,                         &amp;quot;createDateTime&amp;quot;:&amp;quot;2023-07-31 10:03:15&amp;quot;,                         &amp;quot;iconId&amp;quot;:&amp;quot;976064365379584&amp;quot;,                         &amp;quot;id&amp;quot;:&amp;quot;16821653174747137&amp;quot;,                         &amp;quot;rgb&amp;quot;:&amp;quot;#00ff00&amp;quot;,                         &amp;quot;title&amp;quot;:&amp;quot;测试标题&amp;quot;                     },                     {                         &amp;quot;contentId&amp;quot;:&amp;quot;16116641045938176&amp;quot;,                         &amp;quot;createDateTime&amp;quot;:&amp;quot;2023-07-31 10:03:15&amp;quot;,                         &amp;quot;iconId&amp;quot;:&amp;quot;975887978119168&amp;quot;,                         &amp;quot;id&amp;quot;:&amp;quot;16821653174747138&amp;quot;,                         &amp;quot;rgb&amp;quot;:&amp;quot;#ff0000&amp;quot;,                         &amp;quot;title&amp;quot;:&amp;quot;测试标题2&amp;quot;                     }                 ],                 &amp;quot;contentName&amp;quot;:&amp;quot;御医笔记11&amp;quot;,                 &amp;quot;contentType&amp;quot;:1,                 &amp;quot;contentTypeStr&amp;quot;:&amp;quot;小说&amp;quot;,                 &amp;quot;createDateTime&amp;quot;:&amp;quot;2023-07-29 11:21:47&amp;quot;,                 &amp;quot;downloadPassword&amp;quot;:null,                 &amp;quot;downloadTitle&amp;quot;:null,                 &amp;quot;downloadUrl&amp;quot;:null,                 &amp;quot;finishStatus&amp;quot;:0,                 &amp;quot;finishStatusStr&amp;quot;:&amp;quot;连载&amp;quot;,                 &amp;quot;id&amp;quot;:&amp;quot;16116641045938176&amp;quot;,                 &amp;quot;introduce&amp;quot;:&amp;quot;一二三四⑤&amp;quot;,                 &amp;quot;needPayChapterMinNo&amp;quot;:null,                 &amp;quot;needSubscribeChapterMinNo&amp;quot;:null,                 &amp;quot;operationalRecommendation&amp;quot;:&amp;quot;运运运话营运运营&amp;quot;,                 &amp;quot;orderIndex&amp;quot;:80,                 &amp;quot;priceAmount&amp;quot;:null,                 &amp;quot;rankRecommendationFileId&amp;quot;:&amp;quot;16120780517801984&amp;quot;,                 &amp;quot;rankRecommendationFileUrl&amp;quot;:&amp;quot;https://xxx.txt&amp;quot;,                 &amp;quot;rankStartChapterNo&amp;quot;:4,                 &amp;quot;rankSubscribeChapterNo&amp;quot;:4,                 &amp;quot;tagList&amp;quot;:[                     {                         &amp;quot;id&amp;quot;:&amp;quot;16816500912685056&amp;quot;,                         &amp;quot;name&amp;quot;:&amp;quot;标签11&amp;quot;                     },                     {                         &amp;quot;id&amp;quot;:&amp;quot;16816500912685057&amp;quot;,                         &amp;quot;name&amp;quot;:&amp;quot;标签22&amp;quot;                     },                     {                         &amp;quot;id&amp;quot;:&amp;quot;16816500912685058&amp;quot;,                         &amp;quot;name&amp;quot;:&amp;quot;标签33&amp;quot;                     },                     {                         &amp;quot;id&amp;quot;:&amp;quot;15497627324125184&amp;quot;,                         &amp;quot;name&amp;quot;:&amp;quot;现代1&amp;quot;                     }                 ],                 &amp;quot;updateDateTime&amp;quot;:&amp;quot;2023-07-31 10:13:56&amp;quot;,                 &amp;quot;wordNum&amp;quot;:10000             }         ],         &amp;quot;size&amp;quot;:1,         &amp;quot;total&amp;quot;:1     },     &amp;quot;msg&amp;quot;:&amp;quot;OK&amp;quot;,     &amp;quot;traceId&amp;quot;:&amp;quot;e8f30093-97d9-4027-8479-6f3b1239ecfd&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;">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> &quot;错误响应&quot;)页面描述</li> </ul>

页面列表

ITEM_HTML