淘宝开放平台

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	描述
emp_id	String	必须	100001	员工ID
emp_name	String	必须	孙*	员工名字
email	String	可选	abc@alibaba-inc.com	员工邮箱
operate_type	String	必须	1	操作类型：1.查询，2.导出
book_ids	String	可选	1,2,3	书籍 ID 列表
book_name	String	可选	三国	书籍名称
shelf_status	Number	可选	1	上架状态，0：初始，1：已上架，2：已下架
foreword	String	可选	导语	书籍部分导语
serial_status	Number	可选	1	连载状态 1-连载，2-完结
library	String	可选	免费书	书库类型
xt_status	Number	可选	1	审核状态
start_word_count	Number	可选	1000000	字数起始区间
end_word_count	Number	可选	2000000	字数结束区间
start_shelf_time	Date	可选	2025-01-01 00:00:00	上架起始时间
end_shelf_time	Date	可选	2025-02-01 00:00:00	上架结束时间
start_last_update_time	Date	可选	2025-01-01 00:00:00	最后更新起始时间
end_last_update_time	Date	可选	2025-02-01 00:00:00	最后更新结束时间
channel	String	可选	1	男女频 1-男频，2-女频
page_num	Number	可选	1	起始页
page_size	Number	可选	10	每页数量
review_status	Number	可选	1	审核状态
first_category_id	Number	可选	1	一级分类ID
second_category_id	Number	可选	1	二级分类ID

名称	类型	示例值	描述
state	Number	200	状态码
message	String	message	状态描述
data	PageResponse		返回结果
└ total Number 100 总条数 list BookForewordSelectionItemResponse [] 批次数据 └ id Number 10001 id └ book_id Number 111111 书籍ID └ book_name String bookName 书籍名称 └ author_name String authorName 作者名称 └ word_count Number 2 wordCount └ channel_name String 频道频道 └ first_category_name String 都市一级分类名称 └ second_category_name String 都市言情二级分类名称 └ foreword String 这是一条导语导语 └ xt_status_name String 通过 XT审核描述 └ review_status_name String 通过人工审核描述 └ serial_status_name String 连载连载状态描述 └ shelf_time Date 1757491121808 上架时间 └ last_update_time Date 1757491121808 最后更新时间 └ book_store_name String 免费书书库 └ operator String system 操作人 └ operate_time Date 1757491121808 操作时间 └ cp_name String 白月 CP名称 └ xt_status Number 1 XT审核状态 └ review_status Number 1 人工审核状态 └ shelf_status_name String 上架上架状态描述

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaShuqiContentBackendBookForewordListRequest req = new AlibabaShuqiContentBackendBookForewordListRequest();
req.setEmpId("100001");
req.setEmpName("孙*");
req.setEmail("abc@alibaba-inc.com");
req.setOperateType("1");
req.setBookIds("1,2,3");
req.setBookName("三国");
req.setShelfStatus(1L);
req.setForeword("导语");
req.setSerialStatus(1L);
req.setLibrary("免费书");
req.setXtStatus(1L);
req.setStartWordCount(1000000L);
req.setEndWordCount(2000000L);
req.setStartShelfTime(StringUtils.parseDateTime("2025-01-01 00:00:00"));
req.setEndShelfTime(StringUtils.parseDateTime("2025-02-01 00:00:00"));
req.setStartLastUpdateTime(StringUtils.parseDateTime("2025-01-01 00:00:00"));
req.setEndLastUpdateTime(StringUtils.parseDateTime("2025-02-01 00:00:00"));
req.setChannel("1");
req.setPageNum(1L);
req.setPageSize(10L);
req.setReviewStatus(1L);
req.setFirstCategoryId(1L);
req.setSecondCategoryId(1L);
AlibabaShuqiContentBackendBookForewordListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaShuqiContentBackendBookForewordListRequest req = new AlibabaShuqiContentBackendBookForewordListRequest();
req.EmpId = "100001";
req.EmpName = "孙*";
req.Email = "abc@alibaba-inc.com";
req.OperateType = "1";
req.BookIds = "1,2,3";
req.BookName = "三国";
req.ShelfStatus = 1L;
req.Foreword = "导语";
req.SerialStatus = 1L;
req.Library = "免费书";
req.XtStatus = 1L;
req.StartWordCount = 1000000L;
req.EndWordCount = 2000000L;
req.StartShelfTime = DateTime.Parse("2025-01-01 00:00:00");
req.EndShelfTime = DateTime.Parse("2025-02-01 00:00:00");
req.StartLastUpdateTime = DateTime.Parse("2025-01-01 00:00:00");
req.EndLastUpdateTime = DateTime.Parse("2025-02-01 00:00:00");
req.Channel = "1";
req.PageNum = 1L;
req.PageSize = 10L;
req.ReviewStatus = 1L;
req.FirstCategoryId = 1L;
req.SecondCategoryId = 1L;
AlibabaShuqiContentBackendBookForewordListResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaShuqiContentBackendBookForewordListRequest;
$req->setEmpId("100001");
$req->setEmpName("孙*");
$req->setEmail("abc@alibaba-inc.com");
$req->setOperateType("1");
$req->setBookIds("1,2,3");
$req->setBookName("三国");
$req->setShelfStatus("1");
$req->setForeword("导语");
$req->setSerialStatus("1");
$req->setLibrary("免费书");
$req->setXtStatus("1");
$req->setStartWordCount("1000000");
$req->setEndWordCount("2000000");
$req->setStartShelfTime("2025-01-01 00:00:00");
$req->setEndShelfTime("2025-02-01 00:00:00");
$req->setStartLastUpdateTime("2025-01-01 00:00:00");
$req->setEndLastUpdateTime("2025-02-01 00:00:00");
$req->setChannel("1");
$req->setPageNum("1");
$req->setPageSize("10");
$req->setReviewStatus("1");
$req->setFirstCategoryId("1");
$req->setSecondCategoryId("1");
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.shuqi.content.backend.book.foreword.list' \
-d 'partner_id=apidoc' \
-d 'sign=BF3565E8B0687F6E3860C83EB4EB5A96' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-10-14+08%3A17%3A54' \
-d 'v=2.0' \
-d 'book_ids=1%2C2%2C3' \
-d 'book_name=%E4%B8%89%E5%9B%BD' \
-d 'channel=1' \
-d 'email=abc%40alibaba-inc.com' \
-d 'emp_id=100001' \
-d 'emp_name=%E5%AD%99*' \
-d 'end_last_update_time=2025-02-01+00%3A00%3A00' \
-d 'end_shelf_time=2025-02-01+00%3A00%3A00' \
-d 'end_word_count=2000000' \
-d 'first_category_id=1' \
-d 'foreword=%E5%AF%BC%E8%AF%AD' \
-d 'library=%E5%85%8D%E8%B4%B9%E4%B9%A6' \
-d 'operate_type=1' \
-d 'page_num=1' \
-d 'page_size=10' \
-d 'review_status=1' \
-d 'second_category_id=1' \
-d 'serial_status=1' \
-d 'shelf_status=1' \
-d 'start_last_update_time=2025-01-01+00%3A00%3A00' \
-d 'start_shelf_time=2025-01-01+00%3A00%3A00' \
-d 'start_word_count=1000000' \
-d 'xt_status=1'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaShuqiContentBackendBookForewordListRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.emp_id="100001"
req.emp_name="孙*"
req.email="abc@alibaba-inc.com"
req.operate_type="1"
req.book_ids="1,2,3"
req.book_name="三国"
req.shelf_status=1
req.foreword="导语"
req.serial_status=1
req.library="免费书"
req.xt_status=1
req.start_word_count=1000000
req.end_word_count=2000000
req.start_shelf_time="2025-01-01 00:00:00"
req.end_shelf_time="2025-02-01 00:00:00"
req.start_last_update_time="2025-01-01 00:00:00"
req.end_last_update_time="2025-02-01 00:00:00"
req.channel="1"
req.page_num=1
req.page_size=10
req.review_status=1
req.first_category_id=1
req.second_category_id=1
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.shuqi.content.backend.book.foreword.list");
add_param(pRequest,"emp_id","100001");
add_param(pRequest,"emp_name","孙*");
add_param(pRequest,"email","abc@alibaba-inc.com");
add_param(pRequest,"operate_type","1");
add_param(pRequest,"book_ids","1,2,3");
add_param(pRequest,"book_name","三国");
add_param(pRequest,"shelf_status","1");
add_param(pRequest,"foreword","导语");
add_param(pRequest,"serial_status","1");
add_param(pRequest,"library","免费书");
add_param(pRequest,"xt_status","1");
add_param(pRequest,"start_word_count","1000000");
add_param(pRequest,"end_word_count","2000000");
add_param(pRequest,"start_shelf_time","2025-01-01 00:00:00");
add_param(pRequest,"end_shelf_time","2025-02-01 00:00:00");
add_param(pRequest,"start_last_update_time","2025-01-01 00:00:00");
add_param(pRequest,"end_last_update_time","2025-02-01 00:00:00");
add_param(pRequest,"channel","1");
add_param(pRequest,"page_num","1");
add_param(pRequest,"page_size","10");
add_param(pRequest,"review_status","1");
add_param(pRequest,"first_category_id","1");
add_param(pRequest,"second_category_id","1");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.shuqi.content.backend.book.foreword.list', {
	'emp_id':'100001',
	'emp_name':'孙*',
	'email':'abc@alibaba-inc.com',
	'operate_type':'1',
	'book_ids':'1,2,3',
	'book_name':'三国',
	'shelf_status':'1',
	'foreword':'导语',
	'serial_status':'1',
	'library':'免费书',
	'xt_status':'1',
	'start_word_count':'1000000',
	'end_word_count':'2000000',
	'start_shelf_time':'2025-01-01 00:00:00',
	'end_shelf_time':'2025-02-01 00:00:00',
	'start_last_update_time':'2025-01-01 00:00:00',
	'end_last_update_time':'2025-02-01 00:00:00',
	'channel':'1',
	'page_num':'1',
	'page_size':'10',
	'review_status':'1',
	'first_category_id':'1',
	'second_category_id':'1'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_shuqi_content_backend_book_foreword_list_response>
    <state>200</state>
    <message>message</message>
    <data>
        <total>100</total>
        <list>
            <book_foreword_selection_item_response>
                <id>10001</id>
                <book_id>111111</book_id>
                <book_name>bookName</book_name>
                <author_name>authorName</author_name>
                <word_count>2</word_count>
                <channel_name>频道</channel_name>
                <first_category_name>都市</first_category_name>
                <second_category_name>都市言情</second_category_name>
                <foreword>这是一条导语</foreword>
                <xt_status_name>通过</xt_status_name>
                <review_status_name>通过</review_status_name>
                <serial_status_name>连载</serial_status_name>
                <shelf_time>1757491121808</shelf_time>
                <last_update_time>1757491121808</last_update_time>
                <book_store_name>免费书</book_store_name>
                <operator>system</operator>
                <operate_time>1757491121808</operate_time>
                <cp_name>白月</cp_name>
                <xt_status>1</xt_status>
                <review_status>1</review_status>
                <shelf_status_name>上架</shelf_status_name>
            </book_foreword_selection_item_response>
        </list>
    </data>
</alibaba_shuqi_content_backend_book_foreword_list_response>

{
    "alibaba_shuqi_content_backend_book_foreword_list_response":{
        "state":200,
        "message":"message",
        "data":{
            "total":100,
            "list":{
                "book_foreword_selection_item_response":[
                    {
                        "id":10001,
                        "book_id":111111,
                        "book_name":"bookName",
                        "author_name":"authorName",
                        "word_count":2,
                        "channel_name":"频道",
                        "first_category_name":"都市",
                        "second_category_name":"都市言情",
                        "foreword":"这是一条导语",
                        "xt_status_name":"通过",
                        "review_status_name":"通过",
                        "serial_status_name":"连载",
                        "shelf_time":"1757491121808",
                        "last_update_time":"1757491121808",
                        "book_store_name":"免费书",
                        "operator":"system",
                        "operate_time":"1757491121808",
                        "cp_name":"白月",
                        "xt_status":1,
                        "review_status":1,
                        "shelf_status_name":"上架"
                    }
                ]
            }
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

书旗内容文巢

alibaba.shuqi.content.backend.book.foreword.list (书籍导语管理后台列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ