# API 接口

# 获取全量书籍 ID 列表

简要描述：该 API 用于获取合作方所有书籍的 ID 列表，分页返回。（建议每页 100 条，每日定时请求 1 次。）

请求方式：GET（HTTPS）

请求地址：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=booklist

请求参数：（查看通用请求参数）

请求参数 是否必须 类型 说明
pageNo 是 int 页号
pageSize 是 int 每页大小

返回字段：（查看通用返回字段）

字段名称 字段类型 说明 业务说明
cbids string[] 书籍 ID 列表 书籍 ID 列表
totalCount int 全部书籍总数 总数

请求示例：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=booklist&appKey=xxx&appToken=xxxx&pageNo=XX&pageSize=XX

返回示例：

{
  "returnCode": 0,
  "returnMsg": "Success",
  "result": {
    "cbids": [
      "2615346700004302",
      "2624123100103102",
      "2624302000106402",
      "2624837300114502",
      "2625311300119702",
      "2626889200137702",
      "2626346000130402",
      "2628846200148302",
      "2628097100146402",
      "2629087701085301"
    ],
    "totalCount": 925367
  }
}

# 获取书籍基本信息

简要描述：该 API 用于获取书籍信息。书籍的付费/免费，可参考（书籍付费/免费规则）。

epub 书含义，参考 epub 书规则。

请求方式：GET（HTTPS）

请求地址:

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=bookinfo

请求参数：（查看通用请求参数）

请求参数 是否必须 类型 说明
CBID 是 long 书籍 ID

返回字段：（查看通用返回字段）

字段名称 字段类型 说明 业务说明
cBID long 书籍 ID 作品唯一标识
allwords int 总字数 作品当前全部正文章节的字数
authorname string 作家笔名 作者对用户展示的写作笔名
categoryid int 二级分类 作品所属的大类 例：玄幻/奇幻阅文分类 ID 和名称 (opens new window)
coverurl string 封面图 获取封面图片的 URL 地址
createtime string 创建时间 作品进入阅文书库的时间
status int 50:已完结，其它都为“连载” 一本作品的状态
subcategoryid int 三级分类 作品所属大类下的小分类 例：东方玄幻/西方奇幻阅文分类 ID 和名称 (opens new window)
title string 小说名 书名
vipstatus int Vip 标志 -1: 公众 1:VIP 一本作品是否已经开始销售的标识，可能存在是 VIP 作品但未添加 VIP 章节的情况
viptime string VIP 时间 被设置成为收费作品的时间
intro string 书籍简介 作者添加的书籍简介
tag string 标签 标签可以体现一本书的特征或流派等信息
updatetime string 最新更新时间 书籍的最近更新时间
site int 1：创世 2：云起 3：起点女生 5: 起点男生 6：阅文集团 9：起点文学网 22:潇湘 23: 红袖添香 24：言情小说吧 37：昆仑男生 38: 昆仑女生 作品在阅文的首发站点，可以体现授权来源
cPID long 1：创世 2：云起 3：起点女生 5: 起点男生 9：起点文学网 23: 红袖添香 24：言情小说吧 56029：小说阅读网 47626：潇湘书院 作品结算方，在后台出账对账过程中会用到
form int -1:原创 1:出版 原创书，出版书标识
chargetype int 计费方式 1:按章 2:按本 按章则每章价格：可在章节信息中直接通过amount字段获取
按本则整本价格：totalprice
unitprice int 千字价格，单位:分
totalprice int 按本计费价格 totalprice 与 unitprice 不能共存
file_format int 按位标识本书全部文件格式 1:仅支持 txt
2 或 4:仅支持 epub
7: txt 和 epub 都支持
monthlyallowed int 是否允许包月 -1:否 1:是
monthlytime string 允许包月时间
canclemonthlytime string 取消包月时间
freetype int 一级分类 作品所属的一级分类
1:男频
2:女频
3:其他
publisher string 出版社 出版社
isbn string Isbn 编号 Isbn 编号
publishprice int 出版价格 出版价格
checklevel int 审核等级 15:上架
10:可阅读购买搜索，不可人工或自动运营
9:可阅读购买，不可搜索 、人工或自动运营
8:不可搜索 、购买、 人工或自动运营，只可阅读已购买
其他值，下架
smartTagIds array 智能标签 书籍智能标签列表 。并非所有书都有智能标签
operateStatus int 书籍付免状态 1:支持包月
2:支持免费模式
3:支持包月+免费
4:支持付费模式
5:支持付费+包月
6:支持免费+付费
7:支持付费+免费+包月

请求示例：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=bookinfo&CBID=22037867000124502&appKey=xxxxxxxxxx&appToken=xxxxxxxxx

返回示例：

{
  "returnCode": 0,
  "returnMsg": "Success",
  "result": {
    "book": {
      "allwords": 110043,
      "authorname": "国土部长",
      "cBID": 2615346700004302,
      "cPID": 5,
      "canclemonthlytime": "0",
      "categoryid": 20019,
      "chargetype": 1,
      "checklevel": 15,
      "coverurl": "https://ccstatic-1252317822.file.myqcloud.com/bookcoverimg/cover/2016-09-28/f6f762a402e3020657a37664963edb73.jpg",
      "createtime": "2015-10-22 11:01:30",
      "file_format": 1,
      "form": -1,
      "intro": "  他抚着琴，来到了韩国，他一头长发随风飘舞，他站在首尔街头，看着街上那些的妖孽们，他知道他飞升了。\r\n  这是一个降妖除魔的故事，这是一个李修缘在韩国肆虐的故事，这是一个国土部长写的故事。",
      "isbn": "",
      "monthlyallowed": -1,
      "monthlytime": "0",
      "operateStatus": 4,
      "publisher": "",
      "publishprice": 0,
      "freetype":1,
      "site": 5,
      "smartTagIds":
	  [ 61000007,
        61000012
		],
      "status": 105,
      "subcategoryid": 20022,
      "tag": "21058:明星",
      "title": "古人的韩娱",
      "totalprice": -1,
      "unitprice": 5,
      "updatetime": "2022-03-14 18:05:12",
      "vipstatus": -1,
      "viptime": "1970-01-01 08:00:00"
    }
  }
}

# 获取书籍的卷列表

简要描述：该 API 用于获取指定书籍的卷列表（参考目录结构说明）

请求方式：GET（HTTPS）

请求地址：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=volumelist

请求参数：（查看通用请求参数）

请求参数 是否必须 类型 说明
CBID 是 long 书籍 ID

返回字段：（查看通用返回字段）

字段名称 字段类型 说明 业务说明
cVID long 卷 ID，主键 作品分卷的唯一标识
cBID long 书籍 ID 书籍唯一 ID
volumesort int 卷序号 分卷的排序
volumename string 卷名 作者定义的分卷名称
volumedesc string 卷描述 作者对分卷内容的概述

请求示例：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=volumelist&CBID=2624837300114502&appKey=xxxxxxxxxx&appToken=xxxxxxxxx

返回示例：

{
  "returnCode": 0,
  "returnMsg": "Success",
  "result": {
    "pageCount": 2,
    "resultData": [
      {
        "cBID": 2624837300114502,
        "cVID": 7045994246651936,
        "volumedesc": "",
        "volumename": "第一卷 初鸣1988",
        "volumesort": 2
      },
      {
        "cBID": 2624837300114502,
        "cVID": 8176676060070264,
        "volumedesc": "",
        "volumename": "第二卷 辉煌 ",
        "volumesort": 3
      }
    ]
  }
}

# 获取书籍单卷的章节列表

简要描述：该 API 用于获取指定书籍卷的章节列表。（参考目录结构说明）

备注：因历史数据原因，部分书的会有空卷（即卷下面无章节），调用方可根据自己业务诉求处理是否隐藏空卷。

请求方式：GET（HTTPS）

请求地址：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=volumechapterlist

请求参数：（查看通用请求参数）

请求参数 是否必须 类型 说明
CBID 是 long 书籍 ID
CVID 是 long 卷 Id
pageNo 是 int 页号
pageSize 是 int 每页大小

返回字段：（查看通用返回字段）

字段名称 字段类型 说明 业务说明
cCID long 章号 作品章节的唯一标识
cBID long 书籍 ID 书籍唯一 ID
chaptersort long 序号 章节排序
chaptertitle string 章节名 作家定义的章节名
originalwords int 计费字数 一个章节首次发布时的有效字数
vipflag int VIP 类型：-1:非 vip 1:vip 章节是否为收费章节 Vip 为收费，非 vip 不收费
chaptertype int -1:免费
1:收费
2:感言
3:编辑推荐		 章节类型，和 vipflag 一起判断章节收费属性，当 chaptertype=1 且 vipflag=1 时章节收费
cVID long 卷号 所属分卷
amount int 价格 以千字价格计算出的本章售价，单位分
updatetime string 更新时间 本章节最近有过更新的时间
content_md5 string 内容 MD5 用于对章节内容的一致性进行验证，验证章节内容是否被修改

请求示例：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=volumechapterlist&CBID=2624837300114502&CVID=7045994246668320&appKey=xxxxxxxxxxxxx&appToken=xxxxxxxxxx&pageNo=1&pageSize=10

返回示例：

{
  "returnCode": 0,
  "returnMsg": "Success",
  "result": {
    "resultData": [
      {
        "amount": 11,
        "cBID": 2624837300114502,
        "cCID": 7045994246668320,
        "cVID": 7045994246651936,
        "chaptersort": 1000001024,
        "chaptertitle": "第一章 穿越1988",
        "chaptertype": -1,
        "content_md5": "ee2999103167c573fe72ccaa6b97a786",
        "originalwords": 2238,
        "status": 2,
        "updatetime": "2015-10-31 09:08:47",
        "vipflag": -1
      },
      {
        "amount": 11,
        "cBID": 2624837300114502,
        "cCID": 7105538064629857,
        "cVID": 7045994246651936,
        "chaptersort": 1000002048,
        "chaptertitle": "第二章 音乐之家",
        "chaptertype": -1,
        "content_md5": "a47d0cdc0fe94268816032ef2a38e9c9",
        "originalwords": 2395,
        "status": 2,
        "updatetime": "2015-10-31 20:04:26",
        "vipflag": -1
      }
    ],
    "totalCount": 140
  }
}

# 获取书籍的所有章节列表

简要描述：该 API 用于获取指定书籍所有章节列表（参考目录结构说明），带分页限制，每页最多 100 条章节信息（超过 100 条报错）

请求方式：GET（HTTPS）

请求地址：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=chapterlistPage

请求参数：（查看通用请求参数）

请求参数 是否必须 类型 说明
CBID 是 long 书籍 ID
pageNo 是 int 页号
pageSize 是 int 每页大小，不能超过 100

返回字段：（查看通用返回字段）

字段名称 字段类型 说明 业务说明
cCID long 章号 作品章节的唯一标识
cBID long 书籍 ID 书籍唯一 ID
chaptersort long 序号 章节排序
chaptertitle string 章节名 作家定义的章节名
originalwords int 计费字数 一个章节首次发布时的有效字数
vipflag int VIP 类型：-1:非 vip 1:vip 章节是否为收费章节 Vip 为收费，非 vip 不收费
chaptertype int -1:免费
1:收费
2:感言
3:编辑推荐		 章节类型，和 vipflag 一起判断章节收费属性，当 chaptertype=1 且 vipflag=1 时章节收费
cVID long 卷号 所属分卷
amount int 价格 以千字价格计算出的本章售价
updatetime string 更新时间 本章节最近有过更新的时间
content_md5 string 内容 MD5 用于对章节内容的一致性进行验证，验证章节内容是否被修改

请求示例：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=chapterlistPage&CBID=22037867000124502&appKey=xxxxxxxxxxxx&appToken=xxxxxxxxxxxx&pageNo=1&pageSize=10

返回示例：

{
  "returnCode": 0,
  "returnMsg": "Success",
  "result": {
    "resultData": [
      {
        "amount": 11,
        "cBID": 2624837300114502,
        "cCID": 7045994246668320,
        "cVID": 7045994246651936,
        "chaptersort": 1000001024,
        "chaptertitle": "第一章 穿越1988",
        "chaptertype": -1,
        "content_md5": "ee2999103167c573fe72ccaa6b97a786",
        "originalwords": 2238,
        "status": 2,
        "updatetime": "2015-10-31 09:08:47",
        "vipflag": -1
      },
      {
        "amount": 11,
        "cBID": 2624837300114502,
        "cCID": 7105538064629857,
        "cVID": 7045994246651936,
        "chaptersort": 1000002048,
        "chaptertitle": "第二章 音乐之家",
        "chaptertype": -1,
        "content_md5": "a47d0cdc0fe94268816032ef2a38e9c9",
        "originalwords": 2395,
        "status": 2,
        "updatetime": "2015-10-31 20:04:26",
        "vipflag": -1
      }
    ],
    "totalCount": 140
  }
}

# 获取书籍章节内容

简要描述：该 API 用于获取指定章节内容。

请求方式：GET（HTTPS）

请求地址：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=content

请求参数：（查看通用请求参数）

请求参数 是否必须 类型 说明
CBID 是 long 书籍 ID
CCID 是 long 章 Id

返回字段：（查看通用返回字段）

字段名称 字段类型 说明 业务说明
cCID long 章号 作品章节的唯一标识
cBID long 书籍 ID 书籍唯一 ID
content string 内容 作品的正文

如果在正文内容中包含以下字符，请您自行转义字符:

字符 转义符号 字符名称
& & & 符号
&lt; < 小于号
&gt; > 大于号
&quot; " 双引号
&apos; ' 单引号

请求示例：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=content&CBID=22037867000124502&CCID=93017000092209995&appKey=xxxxxxxxxx&appToken=xxxxxxxxxx

返回示例：

{
  "returnCode": 0,
  "returnMsg": "Success",
  "result": {
    "content": {
      "cBID": 24519013609945904,
      "cCID": 69623694338620344,
      "content": "有她这个“金手指”做后盾，不管哥哥们要做什么营生，她都有能力让他们一直走下去！\r\n "
    }
  }
}

# 获取指定时间内下架书籍

简要描述：该 API 用于获取指定时间段内下架书籍，推荐定期请求每 10 分钟 1 次。建议起止时间间隔不超过 2 小时，多次调用起止时间边界最好存在一定重合。参考书籍更新/上架/下架规则

注意：数据可查询的时间范围是最近 30 天，例：3 月 1 日 下架的书籍，3 月 31 日 将不可查询。

请求方式：GET（HTTPS）

请求地址：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=unshelfbooklist

请求参数：（查看通用请求参数）

请求参数 是否必须 类型 说明
startTime 是 string 开始时间 yyyy-MM-dd HH:mm:ss
endTime 是 string 结束时间 yyyy-MM-dd HH:mm:ss

返回字段：（查看通用返回字段）

字段名称 字段类型 说明 业务说明
cbids string[] 书籍 ID 列表 指定时间内下架书籍列表
totalCount int 下架书籍总数 指定时间内下架书籍总数

请求示例：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=unshelfbooklist&startTime=2015-09-11 19:00:00&endTime=2015-09-11 19:50:00&appKey=xxxxxxxxxx&appToken=xxxxxxxxxx

返回示例：

{
  "returnCode": 0,
  "returnMsg": "Success",
  "result": {
    "cbids": [
      "20139152601284606",
      "25565641901335204",
      "26911990804540704"
    ],
    "totalCount": 3
  }
}

# 获取指定时间内更新与上架书籍 ID

简要描述：该 API 用于获取指定时间段内更新与上架的书籍（新增授权、信息变更、章节变更的书籍），建议每 10 分钟 1 次请求。 建议起止时间间隔不超过 2 小时，多次调用起止时间边界最好存在一定重合。参考书籍更新/上架/下架规则

注意：数据可查询的时间范围是最近 30 天，例：3 月 1 日 更新或上架的书籍，3 月 31 日 将不可查询。

请求方式：GET（HTTPS）

请求地址：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=groundbooklist

请求参数：（查看通用请求参数）

请求参数 是否必须 类型 说明
startTime 是 string 开始时间 yyyy-MM-dd HH:mm:ss
endTime 是 string 结束时间 yyyy-MM-dd HH:mm:ss

返回字段：（查看通用返回字段）

字段名称 字段类型 说明 业务说明
cbids string[] 书籍 ID 列表 指定时间内更新与上架书籍列表
totalCount int 更新与上架书籍总数 指定时间内更新与上架书籍总数

请求示例：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=groundbooklist&startTime=2015-09-11 19:00:00&endTime=2015-09-11 19:50:00&appKey=xxxxxxxxxx&appToken=xxxxxxxxxx

返回示例：

{
  "returnCode": 0,
  "returnMsg": "Success",
  "result": {
    "cbids": [
      "20139152601284606",
      "25565641901335204",
      "26911990804540704"
    ],
    "totalCount": 3
  }
}

# 获取 epub 书籍文件下载地址

简要描述： 该 API 用于 epub 格式的书籍获取书内容信息，属于非通用接口，使用前需要与阅文方沟通开启权限。参考 epub 规则

请求方式：GET（HTTPS）

请求地址：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=getEpubUrl

请求参数：（查看通用请求参数）

请求参数 是否必须 类型 说明
CBID 是 long 书籍 ID
epub_format 是 int 2：试读版 4：完整版

返回字段：（查看通用返回字段）

字段名称 字段类型 说明 业务说明
cBID long 书籍 ID 书籍 ID
url string 下载地址 下载地址，获取下载地址下载文件

请求示例：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=getEpubUrl&appKey=xxxxxxxxxx&appToken=xxxxxxxxxx&CBID=3589535404290401&epub_format=4

返回示例：

{
  "returnCode": 0,
  "returnMsg": "Success",
  "result": {
    "cBID": 3590431004458601,
    "url": "https://epubservercos.yuewen.com/E073AC/3590431004458601/3590431004458601_epub.new?sign=1704959048-06bf958e24f64ddfa86ddc8d841db1dc-0-1819e89899021ab8cf13986f68ed30b0"
  }
}

# 获取分类信息列表

简要描述：该 API 用于获取分类列表。

请求方式：GET（HTTPS）

请求地址：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=bookcategorylist

请求参数：（查看通用请求参数）

返回字段：（查看通用返回字段）

字段名称 字段类型 说明 业务说明
iDX long 主键 主键 id
freetype int 一级分类 ID 一级分类 ID
freetypename string 一级分类名称 一级分类名称
categoryid int 二级分类 ID 二级分类 ID
categoryname string 二级分类名称 二级分类名称
subcategoryid int 三级分类 ID 三级分类 ID
subcategoryname string 三级分类名称 三级分类名称
status int 0:无效 1:有效 因历史数据原因，有些无效的分类下依旧有书

请求示例：

https://api.yuewen.com/content/cp/ServiceBus.do?service=CpNovel&action=bookcategorylist&appKey=xxxxxxxxxx&appToken=xxxxxxxxxx

返回示例：

{
  "returnCode": 0,
  "returnMsg": "Success",
  "result": {
    "totalCount": 948,
    "types": [
      {
        "categoryid": 20005,
        "categoryname": "奇幻",
        "freetype": 1,
        "freetypename": "男",
        "iDX": 1,
        "site": 1,
        "status": 1,
        "subcategoryid": 20007,
        "subcategoryname": "史诗奇幻"
      },
      {
        "categoryid": 20005,
        "categoryname": "奇幻",
        "freetype": 1,
        "freetypename": "男",
        "iDX": 2,
        "site": 1,
        "status": 1,
        "subcategoryid": 20006,
        "subcategoryname": "剑与魔法"
      }
          ]
  }
}

# 获取智能标签

简要描述：该 API 用于查询智能标签详细信息，属于非通用接口，使用前需要与阅文方沟通开启权限。

请求方式：GET（HTTPS）

请求地址： （注意域名的差异）

https://openapi.yuewen.com/cp/book/querySmartTagInfo

请求参数：

请求参数 是否必须 类型 说明
appKey 是 string Key 标志（参考阅文开放平台接入指南）
appToken 是 string Key 密码 (参考通用签名算法）
tagId 是 int 标签 id

返回字段：（查看通用返回字段）

字段名称 字段类型 说明 业务说明
tagId string 标签 id 标签 id
tagName string 标签名 标签名
description string 描述 标签描述
gender int 性别 1-男 2-女
type string 二级分类 二级分类

请求示例：

https://openapi.yuewen.com/cp/book/querySmartTagInfo?appKey=xxxxxxxxxx&appToken=xxxxxxxxxx&tagId=xxx

返回示例：

{
  "returnCode": 0,
  "returnMsg": "Success",
  "result": {
    "description": "指作品的基调比较轻松、愉悦，没有苦大仇深的故事情节。",
    "gender": 1,
    "tagId": "53000027",
    "tagName": "轻松",
    "type": "风格"
  }
}

# 消费订单回传

简要描述：用户购买书籍、章节后，合作方需要将订单回传给阅文。 注意：单用户多章购买时，请批量传入 ccids（单批次不建议超过 500 条），不要并发请求多次。因为接口加锁在 cbid+openid 上，如果同一个用户、对一本书并发购买，可能导致某些请求失败

请求方式：POST（HTTPS）

请求地址： （注意域名的差异）

https://cpapi-i.yuewen.com/booktake/authen

请求参数：

请求参数 是否必须 类型 说明
appflag 是 string 接入方唯一标识，在阅文开放平台获取的 appflag （参考阅文开放平台接入指南）
timestamp 是 int 服务器当前 unix 时间戳（秒），接口允许时间差为 ±300 秒
sign 是 string 签名，（参考数据回传签名算法）
cbid 是 string 书籍 id
type 是 string 购买类型：1 按章购买，2 按本购买
ccids 否 string 按章购买时必传，章节价格取自章节信息中的 amount 字段。
数据格式为：章节 id:章节价格(单位有价币，用户充值获取的虚拟币，1 元:100 有价币)，多章以英文逗号分隔。例如：1111:5,222:5,3333:5
openid 是 string 合作方用户 id
paymoney 是 int 消费有价币，多章时为所有章节价格总和(有价币)
paytime 是 int 消费时间戳(秒)
orderid 是 string 消费唯一订单号

返回字段：

参数 类型 说明
code int 业务状态码，0 为成功，其它参考错误码列表
msg string 业务状态码对应的信息

请求示例：

  • 使用场景 1，书籍信息字段 chargetype=1 按章购买： 用户 user1 按章批量购买了 cbid=10000 的两个章节，ccid 为 20000、20001，两章价格分别为 10、15 虚拟币(取自章节信息 amount 字段)，则请求示例如下：
https://cpapi-i.yuewen.com/booktake/authen
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'appflag=test' \
--data-urlencode 'timestamp=1700000000' \
--data-urlencode 'sign=XXXXX' \
--data-urlencode 'cbid=10000' \
--data-urlencode 'type=1' \
--data-urlencode 'ccids=20000:10,20001:15' \
--data-urlencode 'openid=user1' \
--data-urlencode 'paymoney=25' \
--data-urlencode 'paytime=1700000000' \
--data-urlencode 'orderid=order1'
  • 使用场景 2，书籍信息字段 chargetype=2 整本购买： 用户 user1 整本购买了书籍 cbid=10000，整本价格 1000 虚拟币(取自书籍信息 totalprice 字段)，则请求示例如下：
https://cpapi-i.yuewen.com/booktake/authen
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'appflag=test' \
--data-urlencode 'timestamp=1700000000' \
--data-urlencode 'sign=XXXXX' \
--data-urlencode 'cbid=10000' \
--data-urlencode 'type=2' \
--data-urlencode 'openid=user1' \
--data-urlencode 'paymoney=1000' \
--data-urlencode 'paytime=1700000000' \
--data-urlencode 'orderid=order1'

返回示例：

{
   "code":0,
   "msg":"成功"
}

# 充值订单回传

简要描述：用户充值虚拟币后，合作方将订单回传给阅文 注意：单批次不可超过 1000 条

请求方式：POST（HTTPS）

请求地址： （注意域名的差异）

https://cpapi-i.yuewen.com/report/charge

请求参数：

请求参数 是否必须 类型 说明
appflag 是 string 接入方唯一标识，在阅文开放平台获取的 appflag（参考阅文开放平台接入指南）
timestamp 是 int 服务器当前 unix 时间戳（秒），接口允许时间差为 ±300 秒
sign 是 string 签名，（参考数据回传签名算法）
logs 是 string 多条记录以英文逗号分隔。单次请求不超过 1000 条，
格式为：用户 openid:订单号:充值金额(人民币分):充值时间戳(秒)，
例如：user1:order1:1200:1700000000,user2:order2:2200:1700000000

返回字段：

参数 类型 说明
code int 业务状态码，0 为成功，其它参考错误码列表
msg string 业务状态码对应的信息

请求示例：

https://cpapi-i.yuewen.com/report/charge
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'appflag=test' \
--data-urlencode 'timestamp=1700000000' \
--data-urlencode 'sign=XXXXX' \
--data-urlencode 'logs=user1:order1:100:1700000000,user2:order2:200:1700000000'

返回示例：

{
   "code":0,
   "msg":"成功"
}

# 阅读时长回传

简要描述：用户阅读章节后，合作方将阅读时长回传给阅文 注意：阅读页需要维护一个开始阅读时间戳(毫秒)，在用户切章(手动点击上下章、目录切章、连续阅读切章)或者阅读持续一定时长(如 30 秒)或退出阅读页时，上报一次并重置开始阅读时间戳，单批次不可超过 1000 条

请求方式：POST（HTTPS）

请求地址： （注意域名的差异）

https://cpapi-i.yuewen.com/report/reading

请求参数：

请求参数 是否必须 类型 说明
appflag 是 string 接入方唯一标识，在阅文开放平台获取的 appflag（参考阅文开放平台接入指南）
timestamp 是 int 服务器当前 unix 时间戳（秒），接口允许时间差为 ±300 秒
sign 是 string 签名，（参考数据回传签名算法）
logs 是 string 多条记录以英文逗号分隔。单次请求不超过 1000 条，
格式为：用户 openid:作品 cbid:章节 ccid:开始阅读时间戳(毫秒):阅读持续时间(毫秒):是否读完本章(1 读完、0 未读完)，
例如：user1:10000:10001:1700000000000:300000:0,user2:20000:20001:1700000000000:600000:1

返回字段：

参数 类型 说明
code int 业务状态码，0 为成功，其它参考错误码列表
msg string 业务状态码对应的信息

请求示例：

https://cpapi-i.yuewen.com/report/reading
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'appflag=test' \
--data-urlencode 'timestamp=1700000000' \
--data-urlencode 'sign=XXXXX' \
--data-urlencode 'logs=user1:10000:10001:1700000000000:300000:0,user2:20000:20001:1700000000000:600000:1'

返回示例：

{
   "code":0,
   "msg":"成功"
}

← 业务规则说明 →