# 创建作品
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:createBook
该接口用于创建作品(小说)。
支持传入作品提供方主键用于去重。
支持两种章节排序方式
1)、追加(默认方式):新上传章节会追加到章节列表的最后,可调用“编辑作品”或“调整章节顺序”接口更改章节位置。
2)、seq 递增:上传章节时需要额外带上 seq 字段,根据章节 seq 从小到大进行稳定排序调整章节位置。
封面图支持的文件格式:jpg、jpeg、png。建议尺寸 600x800 像素。
题材关键词、精彩片段用于平台推荐场景。精彩片段需为本书内容。
# 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_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| title | string | 是 | 作品名,示例值:"斗破苍穹"。长度限制1-30字。 |
| intro | string | 是 | 作品简介。长度限制1-500字。 |
| cover_media_id | string | 是 | 封面图 media_id,通过新增临时素材接口上传得到 |
| author | string | 是 | 作者名。长度限制1-100字。 |
| first_category_id | number | 是 | 一级类型id。可选类型见小说作品类型 |
| second_category_id | number | 是 | 二级类型id |
| third_category_id | number | 是 | 三级类型id |
| complete_status | number | 是 | 完结状态,1:连载中,2:已完结 |
| original_id | string | 否 | 提供方作品主键,可用于去重。长度限制0-255字节。 |
| chapter_order_method | number | 否 | 章节排序方式,0:追加,1:seq 递增。默认值:0。 |
| custom_info | string | 否 | 自定义信息。长度限制0-128字节。 |
| keyword_list | array | 否 | 题材关键词。最多传入3个关键词,每个关键词长度限制1-4字。 |
| awesome_paragraph | string | 否 | 精彩片段。需为本书内容,长度限制400-1000字。 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| book_id | string | 作品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 | 添加的授权记录有部分失败 |
| 10145011 | appid无效 |
| 10145012 | 授权者和被授权者不能相同 |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。