淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
func_type	Number	必须	1	默认值：0	功能类型，0-测试 1-推送
msg_id	String	可选	h7a9dht4l		单次消息推送唯一标识
material_type	Number	可选	1	默认值：1	物料类型，1-单品，2-活动会场，默认为1
template_id	Number	可选	7989		小二提供或素材库下载的模板ID
material_id	String	可选	mda76h9fa7-7dbaliu4q		推送物料ID，与物料类型一一对应，如类型为单品时，请传入新商品ID
uvid	String	可选	jo3iha09fn7ed		用户标识
adzone_id	String	必须	123		pid三段式的第三段
start_time	String	可选	2023-11-11 00:00:00		计划发送时间，格式为：yyyy-mm-dd hh:mm:ss
test_oaid	String	可选	OAID		测试OAID，验证展示使用
target_item	TargetItemDTO	可选			活动会场定坑商品，此字段仅可在入参物料类型为2时使用，可在会场内指定位置展示指定商品
└ item_id_list String [] 可选 ["top:mda76h9fa7-7dbaliu4q"] 页面内定坑商品ID，用于素材-坑位还原
manufacturer	String	必须	huawei		推送厂商，huawei-华为, oppo-oppo, rongyao-荣耀
huawei_sp	HwMap	可选			华为设备推送自定义参数集
└ back_pic_id String 可选 123 背景图ID └ title_color Number 可选 1 标题字体颜色(仅配置背景图时生效，默认蓝色)：1-蓝色、2-红色、3-白色 └ advanced_style Number 可选 1 展示方式(默认息屏展示)：1-通知栏 2-亮屏 3-立即展示 └ icon_id String 可选 123 icon图片id └ small_pic_url String 可选 pic.aliyun.com 小图url └ notify_id String 可选 20231111 使用同一通知id的消息，后一条会覆盖前一条 └ unfold Number 可选 1 是否折叠(默认不折叠)：0-折叠 1-不折叠 └ light_back_pic_id String 可选 123 鸿蒙4背景图ID
oppo_sp	OpMap	可选			Oppo设备推送自定义参数集
└ show_time Number 可选 2 Opush展示时长，单位为小时(支持6-48) └ notify_style Number 可选 1 通知栏样式，1-标准 2-长文本 3-大图 └ mid_pic_url String 可选 gw.alicdn.com 中图url └ big_pic_url String 可选 gw.alicdn.com 大图url └ material_id String 可选 123 素材ID └ fold_group String 可选 group1 免折叠分组标识 └ msg_label Number 可选 1 消息标签 1-热 2-惠 3-红包 4-直播 5-活动 6-荐 └ unfold Number 可选 1 0-折叠 1-不折叠默认为0 └ is_top Number 可选 1 0-不置顶 1-置顶
rongyao_sp	RyMap	可选			荣耀设备推送自定义参数集
└ title_color Number 可选 1 标题颜色 1-红色 2-蓝色 3-紫色 4-橙色 5-绿色 └ advanced_style Number 可选 1 展示特性 1-亮屏 2-通知栏 3-亮屏+通知栏 └ back_pic_url String 可选 gw.alicdn.com 背景图url └ top_start_time String 可选 2024-07-01 03:59 置顶开始时间开始结束时间必须连续，且最长不能超过4小时 └ top_end_time String 可选 2024-07-02 03:59 置顶结束时间 └ big_pic_url String 可选 gw.alicdn.com 大图url └ big_pic_expire_time String 可选 2024-07-01 23:59 大图过期时间，yyyy-MM-dd HH:mm └ big_pic_expire_action Number 可选 1 大图过期后操作 0-自动清除 1-转普通消息 └ lock_ring Number 可选 1 锁屏铃声震动 0-关闭 1-开启
for_inner_test	Boolean	可选	false		是否发送测试消息

名称	类型	示例值	描述
status	Number	1	状态：0-创建失败 1-待推送 2-推送中 3-已推送 4-已终止 5-已过期
uvid	String	jo3iha09fn7ed	用户标识uvid
input_item_id	String	mda76h9fa7-7dbaliu4q	入参商品ID
create_time	String	2024-01-24 16:04:38	创建时间
msg_id	String	h7a9dht4l	推送唯一标识
output_item_id	String	mda76h9fa7-7dbaliu4q	出参商品ID
receipt	String	请求成功	回执

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkMarketingMsgSendRequest req = new TbkMarketingMsgSendRequest();
req.setFuncType(1L);
req.setMsgId("h7a9dht4l");
req.setMaterialType(1L);
req.setTemplateId(7989L);
req.setMaterialId("mda76h9fa7-7dbaliu4q");
req.setUvid("jo3iha09fn7ed");
req.setAdzoneId("123");
req.setStartTime("2023-11-11 00:00:00");
req.setTestOaid("OAID");
TbkMarketingMsgSendRequest.TargetItemDTO obj1 = new TbkMarketingMsgSendRequest.TargetItemDTO();
obj1.setItemIdList(""top:mda76h9fa7-7dbaliu4q"");
req.setTargetItem(obj1);
req.setManufacturer("huawei");
TbkMarketingMsgSendRequest.HwMap obj2 = new TbkMarketingMsgSendRequest.HwMap();
obj2.setBackPicId("123");
obj2.setTitleColor(1L);
obj2.setAdvancedStyle(1L);
obj2.setIconId("123");
obj2.setSmallPicUrl("pic.aliyun.com");
obj2.setNotifyId("20231111");
obj2.setUnfold(1L);
obj2.setLightBackPicId("123");
req.setHuaweiSp(obj2);
TbkMarketingMsgSendRequest.OpMap obj3 = new TbkMarketingMsgSendRequest.OpMap();
obj3.setShowTime(2L);
obj3.setNotifyStyle(1L);
obj3.setMidPicUrl("gw.alicdn.com");
obj3.setBigPicUrl("gw.alicdn.com");
obj3.setMaterialId("123");
obj3.setFoldGroup("group1");
obj3.setMsgLabel(1L);
obj3.setUnfold(1L);
obj3.setIsTop(1L);
req.setOppoSp(obj3);
TbkMarketingMsgSendRequest.RyMap obj4 = new TbkMarketingMsgSendRequest.RyMap();
obj4.setTitleColor(1L);
obj4.setAdvancedStyle(1L);
obj4.setBackPicUrl("gw.alicdn.com");
obj4.setTopStartTime("2024-07-01 03:59");
obj4.setTopEndTime("2024-07-02 03:59");
obj4.setBigPicUrl("gw.alicdn.com");
obj4.setBigPicExpireTime("2024-07-01 23:59");
obj4.setBigPicExpireAction(1L);
obj4.setLockRing(1L);
req.setRongyaoSp(obj4);
req.setForInnerTest(false);
TbkMarketingMsgSendResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkMarketingMsgSendRequest req = new TbkMarketingMsgSendRequest();
req.FuncType = 1L;
req.MsgId = "h7a9dht4l";
req.MaterialType = 1L;
req.TemplateId = 7989L;
req.MaterialId = "mda76h9fa7-7dbaliu4q";
req.Uvid = "jo3iha09fn7ed";
req.AdzoneId = "123";
req.StartTime = "2023-11-11 00:00:00";
req.TestOaid = "OAID";
TbkMarketingMsgSendRequest.TargetItemDTODomain obj1 = new TbkMarketingMsgSendRequest.TargetItemDTODomain();
obj1.ItemIdList = ""top:mda76h9fa7-7dbaliu4q"";
req.TargetItem_ = obj1;
req.Manufacturer = "huawei";
TbkMarketingMsgSendRequest.HwMapDomain obj2 = new TbkMarketingMsgSendRequest.HwMapDomain();
obj2.BackPicId = "123";
obj2.TitleColor = 1L;
obj2.AdvancedStyle = 1L;
obj2.IconId = "123";
obj2.SmallPicUrl = "pic.aliyun.com";
obj2.NotifyId = "20231111";
obj2.Unfold = 1L;
obj2.LightBackPicId = "123";
req.HuaweiSp_ = obj2;
TbkMarketingMsgSendRequest.OpMapDomain obj3 = new TbkMarketingMsgSendRequest.OpMapDomain();
obj3.ShowTime = 2L;
obj3.NotifyStyle = 1L;
obj3.MidPicUrl = "gw.alicdn.com";
obj3.BigPicUrl = "gw.alicdn.com";
obj3.MaterialId = "123";
obj3.FoldGroup = "group1";
obj3.MsgLabel = 1L;
obj3.Unfold = 1L;
obj3.IsTop = 1L;
req.OppoSp_ = obj3;
TbkMarketingMsgSendRequest.RyMapDomain obj4 = new TbkMarketingMsgSendRequest.RyMapDomain();
obj4.TitleColor = 1L;
obj4.AdvancedStyle = 1L;
obj4.BackPicUrl = "gw.alicdn.com";
obj4.TopStartTime = "2024-07-01 03:59";
obj4.TopEndTime = "2024-07-02 03:59";
obj4.BigPicUrl = "gw.alicdn.com";
obj4.BigPicExpireTime = "2024-07-01 23:59";
obj4.BigPicExpireAction = 1L;
obj4.LockRing = 1L;
req.RongyaoSp_ = obj4;
req.ForInnerTest = false;
TbkMarketingMsgSendResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkMarketingMsgSendRequest;
$req->setFuncType("1");
$req->setMsgId("h7a9dht4l");
$req->setMaterialType("1");
$req->setTemplateId("7989");
$req->setMaterialId("mda76h9fa7-7dbaliu4q");
$req->setUvid("jo3iha09fn7ed");
$req->setAdzoneId("123");
$req->setStartTime("2023-11-11 00:00:00");
$req->setTestOaid("OAID");
$target_item = new TargetItemDTO;
$target_item->item_id_list="[\"top:mda76h9fa7-7dbaliu4q\"]";
$req->setTargetItem(json_encode($target_item));
$req->setManufacturer("huawei");
$huawei_sp = new HwMap;
$huawei_sp->back_pic_id="123";
$huawei_sp->title_color="1";
$huawei_sp->advanced_style="1";
$huawei_sp->icon_id="123";
$huawei_sp->small_pic_url="pic.aliyun.com";
$huawei_sp->notify_id="20231111";
$huawei_sp->unfold="1";
$huawei_sp->light_back_pic_id="123";
$req->setHuaweiSp(json_encode($huawei_sp));
$oppo_sp = new OpMap;
$oppo_sp->show_time="2";
$oppo_sp->notify_style="1";
$oppo_sp->mid_pic_url="gw.alicdn.com";
$oppo_sp->big_pic_url="gw.alicdn.com";
$oppo_sp->material_id="123";
$oppo_sp->fold_group="group1";
$oppo_sp->msg_label="1";
$oppo_sp->unfold="1";
$oppo_sp->is_top="1";
$req->setOppoSp(json_encode($oppo_sp));
$rongyao_sp = new RyMap;
$rongyao_sp->title_color="1";
$rongyao_sp->advanced_style="1";
$rongyao_sp->back_pic_url="gw.alicdn.com";
$rongyao_sp->top_start_time="2024-07-01 03:59";
$rongyao_sp->top_end_time="2024-07-02 03:59";
$rongyao_sp->big_pic_url="gw.alicdn.com";
$rongyao_sp->big_pic_expire_time="2024-07-01 23:59";
$rongyao_sp->big_pic_expire_action="1";
$rongyao_sp->lock_ring="1";
$req->setRongyaoSp(json_encode($rongyao_sp));
$req->setForInnerTest("false");
$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.tbk.marketing.msg.send' \
-d 'partner_id=apidoc' \
-d 'sign=100314C2D8FDB5E55E47B30CF9808D53' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-01-16+00%3A51%3A05' \
-d 'v=2.0' \
-d 'adzone_id=123' \
-d 'for_inner_test=false' \
-d 'func_type=1' \
-d 'huawei_sp=HuaWeiSpMap' \
-d 'manufacturer=huawei' \
-d 'material_id=mda76h9fa7-7dbaliu4q' \
-d 'material_type=1' \
-d 'msg_id=h7a9dht4l' \
-d 'oppo_sp=OppoSpMap' \
-d 'rongyao_sp=RongyaoSpMap' \
-d 'start_time=2023-11-11+00%3A00%3A00' \
-d 'target_item=null' \
-d 'template_id=7989' \
-d 'test_oaid=OAID' \
-d 'uvid=jo3iha09fn7ed'

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

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

req.func_type=1
req.msg_id="h7a9dht4l"
req.material_type=1
req.template_id=7989
req.material_id="mda76h9fa7-7dbaliu4q"
req.uvid="jo3iha09fn7ed"
req.adzone_id="123"
req.start_time="2023-11-11 00:00:00"
req.test_oaid="OAID"
req.target_item="数据结构示例JSON格式"
req.manufacturer="huawei"
req.huawei_sp="HuaWeiSpMap"
req.oppo_sp="OppoSpMap"
req.rongyao_sp="RongyaoSpMap"
req.for_inner_test=false
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.tbk.marketing.msg.send");
add_param(pRequest,"func_type","1");
add_param(pRequest,"msg_id","h7a9dht4l");
add_param(pRequest,"material_type","1");
add_param(pRequest,"template_id","7989");
add_param(pRequest,"material_id","mda76h9fa7-7dbaliu4q");
add_param(pRequest,"uvid","jo3iha09fn7ed");
add_param(pRequest,"adzone_id","123");
add_param(pRequest,"start_time","2023-11-11 00:00:00");
add_param(pRequest,"test_oaid","OAID");
add_param(pRequest,"target_item","数据结构JSON示例");
add_param(pRequest,"manufacturer","huawei");
add_param(pRequest,"huawei_sp","数据结构JSON示例");
add_param(pRequest,"oppo_sp","数据结构JSON示例");
add_param(pRequest,"rongyao_sp","数据结构JSON示例");
add_param(pRequest,"for_inner_test","false");
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.tbk.marketing.msg.send', {
	'func_type':'1',
	'msg_id':'h7a9dht4l',
	'material_type':'1',
	'template_id':'7989',
	'material_id':'mda76h9fa7-7dbaliu4q',
	'uvid':'jo3iha09fn7ed',
	'adzone_id':'123',
	'start_time':'2023-11-11 00:00:00',
	'test_oaid':'OAID',
	'target_item':'数据结构JSON示例',
	'manufacturer':'huawei',
	'huawei_sp':'数据结构JSON示例',
	'oppo_sp':'数据结构JSON示例',
	'rongyao_sp':'数据结构JSON示例',
	'for_inner_test':'false'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_marketing_msg_send_response>
    <status>1</status>
    <uvid>jo3iha09fn7ed</uvid>
    <input_item_id>mda76h9fa7-7dbaliu4q</input_item_id>
    <create_time>2024-01-24 16:04:38</create_time>
    <msg_id>h7a9dht4l</msg_id>
    <output_item_id>mda76h9fa7-7dbaliu4q</output_item_id>
    <receipt>请求成功</receipt>
</tbk_marketing_msg_send_response>

{
    "tbk_marketing_msg_send_response":{
        "status":1,
        "uvid":" jo3iha09fn7ed",
        "input_item_id":"mda76h9fa7-7dbaliu4q",
        "create_time":"2024-01-24 16:04:38",
        "msg_id":"h7a9dht4l",
        "output_item_id":"mda76h9fa7-7dbaliu4q",
        "receipt":"请求成功"
    }
}

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.tbk.marketing.msg.send (商业化消息推送)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ