# 获取作品列表

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

接口英文名：listBook

该接口用于获取所有作品列表，分为发布版列表和编辑版列表。

发布版列表只包括审核通过的作品。编辑版列表包括所有审核状态的作品的最新信息。

例如：某个作品审核通过后再次修改作品名，并且未提审。该接口获取的发布版列表返回的是该作品上一次审核通过的作品名，而编辑版列表返回的是修改后的作品名。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/wxa/book/listbook?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`

参数名	类型	必填	说明
limit	number	否	分页拉取的最大返回结果数。取值范围 1-100，默认值：100
offset	number	否	分页拉取的起始偏移量，默认值：0。offset 和 last_id 二选一，优先使用 last_id。
last_id	number	否	分页 id。首次调用填 0，后续调用填上次返回参数里的 last_id。offset 和 last_id 二选一，优先使用 last_id。
need_edited_data	boolean	否	true：编辑版信息，false：发布版信息。默认值：false

# 3. 返回参数

# 返回体 `Response Payload`

参数名	类型	示例	说明
errcode	number		错误码
errmsg	string	ok	错误信息
book_list	objarray	-	作品信息列表
total_cnt	number	-	作品总数
last_id	number	-	分页 id。仅当请求参数有设置 last_id 且作品信息列表不为空时才有该字段

# Res.book_list(Array) `Object Payload`

作品信息列表

参数名	类型	说明
book_id	string	作品id
title	number	作品名
intro	string	作品简介
cover_url	string	封面图url
author	string	作者名
first_category_id	number	一级类型id
second_category_id	number	二级类型id
third_category_id	number	三级类型id
complete_status	number	完结状态，1：连载中，2：已完结
upload_scene	number	上传场景，1：本地上传，2：API上传
chapter_cnt	number	章节数量
volume_cnt	number	分卷数量
total_word_cnt	number	作品总字数
audit_info	object	审核信息。未发起审核不返回该字段。
create_time	number	创建时间戳
original_id	string	提供方作品主键
chapter_order_method	number	章节排序方式，0：追加，1：seq 递增
custom_info	string	自定义信息
ban_status	number	管控状态，0：正常，1：下架

# Res.book_list(Array).audit_info `Object Payload`

审核信息。未发起审核不返回该字段。

参数名	类型	说明
audit_status	number	0：未提审，1：审核中，2：审核不通过，3：审核通过
create_time	number	提审时间戳
audit_time	number	审核时间戳
reason	string	审核原因
suggestion	string	修改建议。审核不通过时才会有该字段

# 4. 注意事项

offset + limit 分页方式在作品数量超过10万时会失败，建议使用 last_id + limit 分页方式

# 5. 代码示例

请求示例

// offset + limit
{
    "offset": 0,
    "limit": 1
}

// last_id + limit 推荐方式!
{
    "last_id": 0,
    "limit": 1
}

返回示例

// offset + limit
{
    "errcode": 0,
    "errmsg": "ok",
    "book_list": [
        {
            "book_id": "A1b2C3d4",
            "title": "香蕉牛奶",
            "intro": "香蕉牛奶的奇幻之旅。",
            "cover_url": "https://xxx.jpg",
            "author": "香蕉和牛奶",
            "first_category_id": 10001,
            "second_category_id": 10002,
            "third_category_id": 10003,
            "complete_status": 2,
            "upload_scene": 1,
            "chapter_cnt": 6,
            "volume_cnt": 3,
            "total_word_cnt": 15234,
            "create_time": 1704715412,
            "original_id": "",
            "chapter_order_method": 0
        }
    ],
    "total_cnt": 1
}

// last_id + limit 推荐方式!
{
    "errcode": 0,
    "errmsg": "ok",
    "book_list": [
        {
            "book_id": "A1b2C3d4",
            "title": "香蕉牛奶",
            "intro": "香蕉牛奶的奇幻之旅。",
            "cover_url": "https://xxx.jpg",
            "author": "香蕉和牛奶",
            "first_category_id": 10001,
            "second_category_id": 10002,
            "third_category_id": 10003,
            "complete_status": 2,
            "upload_scene": 1,
            "chapter_cnt": 6,
            "volume_cnt": 3,
            "total_word_cnt": 15234,
            "create_time": 1704715412,
            "original_id": "",
            "chapter_order_method": 0
        }
    ],
    "total_cnt": 1,
    "last_id": 1
}

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

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