淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
publicity_list_query_dto	PublicityListQueryDTO	可选			查询请求
└ publish_start_time_str String 可选 2025-01-21 00:00:00 创建公告的起始时间，格式：yyyy-MM-dd HH:mm:ss └ publish_end_time_str String 可选 2025-01-21 16:00:00 创建公告的结束时间，格式：yyyy-MM-dd HH:mm:ss └ page_size Number 可选 10 当页条数 └ page Number 可选 1 页码 └ proxy_nick String 必须拍卖测试帐号机构淘宝账号昵称 └ types String [] 必须 [24] 公告类型列表 └ query_child Boolean 可选 false 是否同时查询子机构数据

名称	类型	示例值	描述
result_code	String	SYSTEM_ERROR	错误code
result_msg	String	系统异常	错误描述
value	PublicityTopVO []		公告信息列表
└ type Number 24 公告类型 └ type_desc String 处置公告公告类型描述 └ publicity_id Number 15407 公告ID └ title String 测试公告公告标题 └ publish_time Number 1737446921000 发布时间戳，毫秒 └ status Number 1 -1:已删除 1:已发布 2:已撤回 └ cancel_time Number 1737446921000 撤回时间戳，毫秒

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AuctionZcPulicityListRequest req = new AuctionZcPulicityListRequest();
AuctionZcPulicityListRequest.PublicityListQueryDTO obj1 = new AuctionZcPulicityListRequest.PublicityListQueryDTO();
obj1.setPublishStartTimeStr("2025-01-21 00:00:00");
obj1.setPublishEndTimeStr("2025-01-21 16:00:00");
obj1.setPageSize(10L);
obj1.setPage(1L);
obj1.setProxyNick("拍卖测试帐号");
obj1.setTypes("24");
obj1.setQueryChild(false);
req.setPublicityListQueryDto(obj1);
AuctionZcPulicityListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AuctionZcPulicityListRequest req = new AuctionZcPulicityListRequest();
AuctionZcPulicityListRequest.PublicityListQueryDTODomain obj1 = new AuctionZcPulicityListRequest.PublicityListQueryDTODomain();
obj1.PublishStartTimeStr = "2025-01-21 00:00:00";
obj1.PublishEndTimeStr = "2025-01-21 16:00:00";
obj1.PageSize = 10L;
obj1.Page = 1L;
obj1.ProxyNick = "拍卖测试帐号";
obj1.Types = "24";
obj1.QueryChild = false;
req.PublicityListQueryDto_ = obj1;
AuctionZcPulicityListResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AuctionZcPulicityListRequest;
$publicity_list_query_dto = new PublicityListQueryDTO;
$publicity_list_query_dto->publish_start_time_str="2025-01-21 00:00:00";
$publicity_list_query_dto->publish_end_time_str="2025-01-21 16:00:00";
$publicity_list_query_dto->page_size="10";
$publicity_list_query_dto->page="1";
$publicity_list_query_dto->proxy_nick="拍卖测试帐号";
$publicity_list_query_dto->types="[24]";
$publicity_list_query_dto->query_child="false";
$req->setPublicityListQueryDto(json_encode($publicity_list_query_dto));
$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=taobao.auction.zc.pulicity.list' \
-d 'partner_id=apidoc' \
-d 'sign=B6452E4FDF59F4E99E2E4EBDC2F4E143' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-04+00%3A55%3A11' \
-d 'v=2.0' \
-d 'publicity_list_query_dto=null'

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

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

req.publicity_list_query_dto="数据结构示例JSON格式"
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,"taobao.auction.zc.pulicity.list");
add_param(pRequest,"publicity_list_query_dto","数据结构JSON示例");
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('taobao.auction.zc.pulicity.list', {
	'publicity_list_query_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<auction_zc_pulicity_list_response>
    <result_code>SYSTEM_ERROR</result_code>
    <result_msg>系统异常</result_msg>
    <value>
        <publicity_top_v_o>
            <type>24</type>
            <type_desc>处置公告</type_desc>
            <publicity_id>15407</publicity_id>
            <title>测试公告</title>
            <publish_time>1737446921000</publish_time>
            <status>1</status>
            <cancel_time>1737446921000</cancel_time>
        </publicity_top_v_o>
    </value>
</auction_zc_pulicity_list_response>

{
    "auction_zc_pulicity_list_response":{
        "result_code":"SYSTEM_ERROR",
        "result_msg":"系统异常",
        "value":{
            "publicity_top_v_o":[
                {
                    "type":24,
                    "type_desc":"处置公告",
                    "publicity_id":15407,
                    "title":"测试公告",
                    "publish_time":1737446921000,
                    "status":1,
                    "cancel_time":1737446921000
                }
            ]
        }
    }
}

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下载

开放平台

拍卖API

taobao.auction.zc.pulicity.list (查询处置公告或工作公示列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ