阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	描述
external_platform_request	ExternalPlatformRequest	可选		ISV身份入参
└ biz_type String 可选 ISVMerchant 业务类型
location	String	可选	bannerAdv	查询某个位置上需要展示的广告，线下约定入参
order_operation_person	OrderOperationPerson	可选		用户身份
└ mobile String 可选 13817778888 下单操作人的手机号，用作联系，可以不填写

名称	类型	示例值	描述
result	TdOpenServiceResult		返回结果
data MarketingSenseEntryInfoCarousel 返回对象 mobile_list MarketingSenseEntryInfo [] 移动端营销文案展示 └ resource_url String http://xxx 点击营销文案资源时的跳转链接，为空表示不附带链接 └ resource String https://pic1.zhimg.com/v2-4927a421ff56548962e93b4a1e1e7413_b.jpg 营销文案的资源展示(一般是图片链接) └ benefit_url String http://xxx 利益点详细信息链接，为空表示不附带链接 └ copy String 上门揽收，当日取件营销文案 └ title String 3月特惠寄该营销文案的标题 └ extent_info String 扩展信息示例预留为扩展信息 └ benefit String 限时特惠利益点展示 └ copy_url String https://www.google.com/search?q=mtop.cainiao.billing.price.query&oq=mtop.cainiao.billing.price.query&aqs=chrome..69i57j69i60.3542j0j4&sourceid=chrome&ie=UTF-8 营销文案附带链接，为空表示不附带链接 pc_list MarketingSenseEntryInfo [] PC端营销文案展示 └ resource_url String http://xxx 点击营销文案资源时的跳转链接，为空表示不附带链接 └ resource String https://pic1.zhimg.com/v2-4927a421ff56548962e93b4a1e1e7413_b.jpg 营销文案的资源展示(一般是图片链接) └ benefit_url String http://xxx 利益点详细信息链接，为空表示不附带链接 └ copy String 上门揽收，当日取件营销文案 └ title String 3月特惠寄该营销文案的标题 └ extent_info String 扩展信息示例预留为扩展信息 └ benefit String 限时特惠利益点展示 └ copy_url String https://www.google.com/search?q=mtop.cainiao.billing.price.query&oq=mtop.cainiao.billing.price.query&aqs=chrome..69i57j69i60.3542j0j4&sourceid=chrome&ie=UTF-8 营销文案附带链接，为空表示不附带链接 └ retry Boolean false 重试

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoPickupBusinessAdvCarouselGetRequest req = new CainiaoPickupBusinessAdvCarouselGetRequest();
CainiaoPickupBusinessAdvCarouselGetRequest.ExternalPlatformRequest obj1 = new CainiaoPickupBusinessAdvCarouselGetRequest.ExternalPlatformRequest();
obj1.setBizType("ISVMerchant");
req.setExternalPlatformRequest(obj1);
req.setLocation("bannerAdv");
CainiaoPickupBusinessAdvCarouselGetRequest.OrderOperationPerson obj2 = new CainiaoPickupBusinessAdvCarouselGetRequest.OrderOperationPerson();
obj2.setMobile("13817778888");
req.setOrderOperationPerson(obj2);
CainiaoPickupBusinessAdvCarouselGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoPickupBusinessAdvCarouselGetRequest req = new CainiaoPickupBusinessAdvCarouselGetRequest();
CainiaoPickupBusinessAdvCarouselGetRequest.ExternalPlatformRequestDomain obj1 = new CainiaoPickupBusinessAdvCarouselGetRequest.ExternalPlatformRequestDomain();
obj1.BizType = "ISVMerchant";
req.ExternalPlatformRequest_ = obj1;
req.Location = "bannerAdv";
CainiaoPickupBusinessAdvCarouselGetRequest.OrderOperationPersonDomain obj2 = new CainiaoPickupBusinessAdvCarouselGetRequest.OrderOperationPersonDomain();
obj2.Mobile = "13817778888";
req.OrderOperationPerson_ = obj2;
CainiaoPickupBusinessAdvCarouselGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoPickupBusinessAdvCarouselGetRequest;
$external_platform_request = new ExternalPlatformRequest;
$external_platform_request->biz_type="ISVMerchant";
$req->setExternalPlatformRequest(json_encode($external_platform_request));
$req->setLocation("bannerAdv");
$order_operation_person = new OrderOperationPerson;
$order_operation_person->mobile="13817778888";
$req->setOrderOperationPerson(json_encode($order_operation_person));
$resp = $c->execute($req, $sessionKey);

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=cainiao.pickup.business.adv.carousel.get' \
-d 'partner_id=apidoc' \
-d 'session=467aeebc-1b5b-4364-b971-2318443a4d4a' \
-d 'sign=CACB9E7A38EB0B1CCEF96F7FF65B78A8' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-28+15%3A58%3A33' \
-d 'v=2.0' \
-d 'external_platform_request=null' \
-d 'location=bannerAdv' \
-d 'order_operation_person=null'

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

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

req.external_platform_request="数据结构示例JSON格式"
req.location="bannerAdv"
req.order_operation_person="数据结构示例JSON格式"
try:
	resp= req.getResponse(sessionkey)
	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,"cainiao.pickup.business.adv.carousel.get");
add_param(pRequest,"external_platform_request","数据结构JSON示例");
add_param(pRequest,"location","bannerAdv");
add_param(pRequest,"order_operation_person","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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('cainiao.pickup.business.adv.carousel.get', {
	'external_platform_request':'数据结构JSON示例',
	'location':'bannerAdv',
	'order_operation_person':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_pickup_business_adv_carousel_get_response>
    <result>
        <data>
            <mobile_list>
                <marketing_sense_entry_info>
                    <resource_url>http://xxx</resource_url>
                    <resource>https://pic1.zhimg.com/v2-4927a421ff56548962e93b4a1e1e7413_b.jpg</resource>
                    <benefit_url>http://xxx</benefit_url>
                    <copy>上门揽收，当日取件</copy>
                    <title>3月特惠寄</title>
                    <extent_info>扩展信息示例</extent_info>
                    <benefit>限时特惠</benefit>
                    <copy_url>https://www.google.com/search?q=mtop.cainiao.billing.price.query&amp;oq=mtop.cainiao.billing.price.query&amp;aqs=chrome..69i57j69i60.3542j0j4&amp;sourceid=chrome&amp;ie=UTF-8</copy_url>
                </marketing_sense_entry_info>
            </mobile_list>
            <pc_list>
                <marketing_sense_entry_info>
                    <resource_url>http://xxx</resource_url>
                    <resource>https://pic1.zhimg.com/v2-4927a421ff56548962e93b4a1e1e7413_b.jpg</resource>
                    <benefit_url>http://xxx</benefit_url>
                    <copy>上门揽收，当日取件</copy>
                    <title>3月特惠寄</title>
                    <extent_info>扩展信息示例</extent_info>
                    <benefit>限时特惠</benefit>
                    <copy_url>https://www.google.com/search?q=mtop.cainiao.billing.price.query&amp;oq=mtop.cainiao.billing.price.query&amp;aqs=chrome..69i57j69i60.3542j0j4&amp;sourceid=chrome&amp;ie=UTF-8</copy_url>
                </marketing_sense_entry_info>
            </pc_list>
        </data>
        <retry>false</retry>
    </result>
</cainiao_pickup_business_adv_carousel_get_response>

{
    "cainiao_pickup_business_adv_carousel_get_response":{
        "result":{
            "data":{
                "mobile_list":{
                    "marketing_sense_entry_info":[
                        {
                            "resource_url":"http:\/\/xxx",
                            "resource":"https:\/\/pic1.zhimg.com\/v2-4927a421ff56548962e93b4a1e1e7413_b.jpg",
                            "benefit_url":"http:\/\/xxx",
                            "copy":"上门揽收，当日取件",
                            "title":"3月特惠寄",
                            "extent_info":"扩展信息示例",
                            "benefit":"限时特惠",
                            "copy_url":"https:\/\/www.google.com\/search?q=mtop.cainiao.billing.price.query&oq=mtop.cainiao.billing.price.query&aqs=chrome..69i57j69i60.3542j0j4&sourceid=chrome&ie=UTF-8"
                        }
                    ]
                },
                "pc_list":{
                    "marketing_sense_entry_info":[
                        {
                            "resource_url":"http:\/\/xxx",
                            "resource":"https:\/\/pic1.zhimg.com\/v2-4927a421ff56548962e93b4a1e1e7413_b.jpg",
                            "benefit_url":"http:\/\/xxx",
                            "copy":"上门揽收，当日取件",
                            "title":"3月特惠寄  \t",
                            "extent_info":"扩展信息示例",
                            "benefit":"限时特惠",
                            "copy_url":"https:\/\/www.google.com\/search?q=mtop.cainiao.billing.price.query&oq=mtop.cainiao.billing.price.query&aqs=chrome..69i57j69i60.3542j0j4&sourceid=chrome&ie=UTF-8"
                        }
                    ]
                }
            },
            "retry":false
        }
    }
}

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

cainiao.pickup.business.adv.carousel.get (菜鸟商家寄件获取营销文案轮播信息(支持PC，移动多端的信息获取)菜鸟商家寄件获取营销文案信息(支持PC，移动多端的信息获取))

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈