# 小说作品管理接口
小程序在申请【文娱-网络小说】类目通过后,会自动开通以下API调用权限以及阅读器插件调用权限。
# 一、作品管理
每个作品均有编辑版、发布版两个版本。创建作品、编辑作品、上传章节、批量上传章节、删除章节只会更新编辑版的作品信息。作品信息编辑后需要重新提审,并且仅当所有信息审核通过后,才会更新作品的发布版信息。
阅读器插件只能获取到发布版的作品信息。
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 创建作品 | /wxa/book/createbook | 该接口用于创建作品(小说) |
| 编辑作品 | /wxa/book/updatebook | 该接口用于编辑作品编辑版的基础信息、章节顺序、分卷信息,不直接影响发布版,需要提审通过后才会更新发布版 |
| 删除作品 | /wxa/book/deletebook | 该接口用于删除作品,同时作用于编辑版和发布版 |
| 获取作品列表 | /wxa/book/listbook | 该接口用于获取所有作品列表,分为发布版列表和编辑版列表 |
| 获取作品信息 | /wxa/book/getbook | 该接口用于获取作品详细信息,同获取作品列表,这里也会区分发布版和编辑版 |
| 上传章节 | /wxa/book/createchapter | 该接口用于上传章节到作品编辑版信息里,不直接影响发布版,需要提审通过后才会更新发布版 |
| 批量上传章节 | /wxa/book/batchcreatechapter | 该接口用于批量上传章节到作品编辑版信息里,不直接影响发布版,需要提审通过后才会更新发布版 |
| 删除章节 | /wxa/book/deletechapter | 该接口用于删除作品编辑版里的章节,不直接影响发布版,需要提审通过后才会更新发布版 |
| 替换章节 | /wxa/book/replacechapter | 该接口用于替换作品编辑版里的已有章节内容,不直接影响发布版,需要提审通过后才会更新发布版 |
| 获取章节列表 | /wxa/book/listchapter | 该接口用于获取章节信息 |
| 获取章节信息 | /wxa/book/getchapter | 该接口用于获取章节信息 |
| 调整章节顺序 | /wxa/book/reorderchapter | 该接口用于调整作品编辑版信息中的章节顺序,不直接影响发布版,需要提审通过后才会更新发布版 |
| 调整章节相对顺序 | /wxa/book/updatechapterseq | 该接口用于调整作品编辑版信息中的章节顺序,不直接影响发布版,需要提审通过后才会更新发布版 |
| 作品提审 | /wxa/book/auditbook | 作品提交审核 |
# 二、小说授权
账号-小说授权是由主授权者账号(appid)-> 作品id -> 被授权者账号(appid)三维度所构建的数据关系,API提供对此关系数据进行增,删,改,查的能力。
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 新增账号-小说授权 | /wxa/book/addbookauth | 增加账号-小说的授权关系数据,主授权账号使用可一次调用新增多条授权关系(上限20条) |
| 查看主授权关系列表(查看被授权关系列表) | /wxa/book/querybookauth | 查看账号的小说授权关系列表,主授权账号使用 |
| 删除指定的授权关系 | /wxa/book/delbookauth | 删除账号的小说授权关系,主授权账号使用 |
# 三、账号授权
账号授权是由主授权者账号(appid) -> 被授权者账号(appid)所构建的数据关系,API提供对此关系数据进行增,删,改,查的能力。授权后,可将主授权账号的小说批量授权给被授权账号。
以下接口只维护账号级别授权信息,没有与小说级别授权信息整合。账号对小说的真实授权关系,取决于两种授权关系中的过期时间较晚的那一个。
secwxaapi_mmbizsecbookauth_addbookauthbyappid secwxaapi_mmbizsecbookauth_querybookauthv2 secwxaapi_mmbizsecbookauth_delbookauthbyappid
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 新增账号-账号授权 | /wxa/book/addbookauthbyappid | 增加账号-账号的授权关系数据,主授权账号可一次调用新增多条授权关系(上限20条) |
| 查看账号主授权关系列表 | /wxa/book/querybookauthv2 | 此接口可用于查看账号的授权关系列表,也可以看账号被授权关系列表 |
| 删除指定的账号授权关系 | /wxa/book/delbookauthbyappid | 删除账号维度授权关系,主授权账号使用 |
# 四、事件通知
如需监听作品审核状态事件,可阅读本章内容。具体接入方式可以参考公众平台的消息推送:
如果开发者是小程序商家,请移步:消息推送|微信开放文档
如果开发者是服务商第三方平台,请移步:创建与配置第三方平台准备工作|微信开放文档
第三方平台需新增小说阅读器管理权限集 169 并重新授权。
# 审核状态事件
# 请求参数
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| book_id | string | 是 | 作品id |
| audit_detail | BookAuditDetail | 是 | 作品审核结果。每一章的审核结果可通过「获取章节列表」查询。 |
BookAuditDetail
| 属性 | 类型 | 说明 |
|---|---|---|
| status | number | 2:审核不通过,3:审核通过 |
| create_time | number | 提审时间戳 |
| audit_time | number | 审核时间戳 |
<xml>
<ToUserName>gh_abcdefg</ToUserName>
<FromUserName>oABCD</FromUserName>
<CreateTime>12344555555</CreateTime>
<MsgType>event</MsgType>
<Event>secbook_audit_event</Event>
<audit_event>
<book_id>A1b2C3d4</book_id>
<audit_detail>
<status>3</status>
<create_time>168625255</create_time>
<audit_time>168626255</audit_time>
</audit_detail>
</audit_event>
</xml>
# 五、预览设置
当用户尚未付费解锁某章节时,会默认进入章节预览模式,默认预览 150 个字。如果有自定义需求则可通过预览设置接口进行设置。
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 预览设置修改 | /wxa/business/novelreader/setpreviewsetting | 设置书本章节预览字数 |
| 预览设置获取 | /wxa/business/novelreader/getpreviewsetting | 获取书本章节预览字数设置 |
# 六、运营能力
| 接口名称 | 请求路径 | 描述 |
|---|---|---|
| 读后推荐 | /wxa/business/novelreader/setrecmdnovel | 阅读器插件支持在阅读后推荐其他小说,开发者需要主动设置想要推荐的小说 |
# 七、更新记录
# 2025年12月2日
- 新增账号维度的小说授权接口,支持授权方批量将小说授权给其他账号。
# 2024年12月18日
- 支持删除作品
# 2024年11月27日
- 支持读后推荐功能
# 2024年05月21日
- 作品/章节支持传入自定义信息
# 2024年05月09日
- 获取作品列表新增 last_id 分页方式
# 2024年04月18日
- 支持第三方平台,权限集 ID 169
# 2024年04月12日
- 支持传入作品/章节提供方主键去重
- 支持切换作品章节排序方式,新增 seq 递增排序
- 新增替换章节、调整章节相对顺序接口
# 2024年03月12日
- 支持审核状态事件通知