# 创建作品

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

接口英文名:createBook

该接口用于创建作品(小说)。

  1. 支持传入作品提供方主键用于去重。

  2. 支持两种章节排序方式

    1)、追加(默认方式):新上传章节会追加到章节列表的最后,可调用“编辑作品”或“调整章节顺序”接口更改章节位置。

    2)、seq 递增:上传章节时需要额外带上 seq 字段,根据章节 seq 从小到大进行稳定排序调整章节位置。

  3. 封面图支持的文件格式:jpg、jpeg、png。建议尺寸 600x800 像素。

  4. 题材关键词、精彩片段用于平台推荐场景。精彩片段需为本书内容。

# 1. 调用方式

# HTTPS 调用

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

# 云调用

  • 本接口不支持云调用。

# 第三方调用

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

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

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

# 2. 请求参数

# 查询参数 Query String Parameters

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

# 请求体 Request Payload

参数名类型必填说明
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:已完结
original_idstring提供方作品主键,可用于去重。长度限制0-255字节。
chapter_order_methodnumber章节排序方式,0:追加,1:seq 递增。默认值:0。
custom_infostring自定义信息。长度限制0-128字节。
keyword_listarray题材关键词。最多传入3个关键词,每个关键词长度限制1-4字。
awesome_paragraphstring精彩片段。需为本书内容,长度限制400-1000字。

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber错误码
errmsgstring错误信息
book_idstring作品id。非定长,不超过 64 字节。

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

请求示例

{
    "title": "香蕉牛奶",
    "intro": "香蕉牛奶的奇幻之旅。",
    "cover_media_id": "xxx",
    "author": "香蕉和牛奶",
    "first_category_id": 10001,
    "second_category_id": 10002,
    "third_category_id": 10003,
    "complete_status": 1
}

返回示例

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

# 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. 适用范围

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