# 编辑作品

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:updateBook

该接口用于编辑作品编辑版的基础信息、章节顺序、分卷信息,不直接影响发布版,需要提审通过后才会更新发布版。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/wxa/book/updatebook?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用。

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:169

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String Parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填说明
book_idstring作品id
titlestring作品名。长度限制1-30字。
introstring作品简介。长度限制1-500字。
cover_media_idstring封面图 media_id,通过 新增临时素材上传得到。
authorstring作者名。长度限制1-100字。
first_category_idnumber一级类型id。可选类型见 小说作品类型
second_category_idnumber二级类型id
third_category_idnumber三级类型id
complete_statusnumber完结状态,1:连载中,2:已完结
chapter_id_listarray按照预期顺序传入章节id
need_volumeboolean是否需要分卷
volume_listobjarray分卷信息
chapter_order_methodnumber章节排序方式,0:追加,1:seq 递增
custom_infostring自定义信息。长度限制0-128字节。
update_keywordboolean是否更新题材关键词
keyword_listarray题材关键词。最多传入3个关键词,每个关键词长度限制1-4字。
awesome_paragraphstring精彩片段。需为本书内容,长度限制400-1000字。

# Body.volume_list(Array) Object Payload

分卷信息

参数名类型必填说明
volume_titlestring分卷名。长度限制1-100字。
start_indexnumber分卷起始章节下标,取值范围 [0, 章节总数)
end_indexnumber分卷截止章节下标,取值范围 [起始章节下标, 章节总数)

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息

# 4. 注意事项

  1. 除了 book_id 必填以外,其余字段是需要修改才设置。
  2. 若要修改作品类型,必须同时传入三级类型id。
  3. 审核中的作品不支持修改信息。
  4. 作品若需要分卷,则所有章节都需要被划入某个分卷,不能有某个章节未被划入分卷。
  5. 创建/删除章节后,需要主动修改作品分卷信息,否则无法提审。
  6. 分卷管理涉及两个字段 need_volume 和 volume_list。need_volume 不设置时为不修改分卷;need_volume 设置为 true 时表示需要用 volume_list 来修改作品分卷;need_volume 设置为 false 时表示作品不需要分卷,会清除当前作品的分卷信息。
  7. 分卷列表里需要按照分卷顺序传入参数,即第一卷的信息需要在第二卷之前,否则会报错。
  8. 分卷信息里的章节范围为左闭右闭,即包含 start_index 和 end_index 对应章节。第一卷的 start_index 应等于 0,后续每一卷的 start_index 应等于前一卷的 end_index + 1,最后一卷的 end_index 应等于作品章节总数 - 1。不同分卷的章节范围不能重叠,且合并所有分卷信息的区间应等于 [0, 章节总数 - 1]。
  9. 章节排序方式切换规则:从“追加”调整为“seq 递增”不保留当前章节顺序,自动按照章节 seq 重新排序;从“seq 递增”调整为“追加”会保留当前章节顺序,不清除章节 seq 信息。
  10. 题材关键词、精彩片段用于平台推荐场景。精彩片段需为本书内容

# 5. 代码示例

请求示例

{
    "book_id": "A1b2C3d4",
    "complete_status": 2,
    "need_volume": true,
    "volume_list": [
        {
            "volume_title": "第一卷",
            "start_index": 0,
            "end_index": 2
        },
        {
            "volume_title": "第二卷",
            "start_index": 2,
            "end_index": 5
        }
    ]
}

返回示例

{
    "errcode": 0,
    "errmsg": "ok"
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

错误码错误描述
-1系统失败
0成功
10140001无效参数
10140002请使用 utf-8 编码
10140003无效的作品名
10140004无效的作品简介
10140005无效的封面图
10140006无效的作者
10140007无效的作品类型
10140008无效的完结状态
10140009无效的上传场景
10140010无效的章节下标列表,请检查是否有重复或未覆盖所有章节
10140011无效的章节ID列表,请检查是否有重复、不属于该作品的章节ID或未覆盖所有章节
10140012无效的分卷列表,请检查分卷标题是否规范,区间是否存在交集或未覆盖所有章节
10140013缺少章节信息
10140014章节信息过多
10140015缺少作品ID
10140016作品ID过多
10140017无效的分页最大结果数
10140018无效的章节标题
10140019无效的章节内容
10140020无效的排序操作
10140021无效的章节排序方式
10140022缺少章节seq
10140023请求参数中存在重复的提供方主键
10140024无效的提供方主键
10140025无效的优先级
10140026无效的自定义信息
10141001找不到对应信息
10141002不允许操作
10141003作品正在审核中
10141004添加审核信息失败
10141005太多检查不通过项
10141006作品未审核通过,无法发布
10141007作品缺少章节
10141008作品分卷信息需要更新
10141009提供方主键冲突
10141010该接口与当前作品的章节排序方式不兼容,如需调用请先修改章节排序方式
10145001操作结果为空
10145002调用系统失败
10145003缺少入参
10145004授权作品ID无效
10145005授权者不是小说类目
10145006被授权者不是小说类目
10145007过期的时间信息/或者授权的时间异常
10145008一次提交授权的作品太多或者太少(count = 0 or count > 20)
10145009一次查询授权列表拉取的count太多(count > 100)
10145010添加的授权记录有部分失败
10145011appid无效
10145012授权者和被授权者不能相同

# 7. 适用范围

本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。