淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
award_external_send_req	QuanyiIsvSendReq	必须			权益外放请求对象
└ activity_alias String 必须 abcdef 活动标识，联系运营小二或商家后台提供 └ award_alias String 必须 abcdef2131 奖品标识，联系运营小二或商家后台提供 └ buyer_nick String 可选 xh4 用户淘宝nick，即淘宝昵称 └ phone String 可选 12445167194 手机号码 └ biz_order_id Number 可选 279808654432 订单号 └ join_time String 可选 2016-08-19 09:08:00 参与时间,为空默认当前时间 └ out_id String 必须 123456234567 幂等字段，即请求流水 └ ext_paras String 可选 {"ttid":"2121","toabao":"sasa1"} 扩展字段json串 └ obs_buyer_id String 可选 sas1241167821 加密帐号

名称	类型	示例值	描述
result	CommonResult		result
└ data Boolean true data └ success Boolean true success └ err_code String SUCCESS err_code └ err_msg String SUCCESS err_msg └ success_code String SENDING success_code

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
PromotionActivityAwardSendRequest req = new PromotionActivityAwardSendRequest();
PromotionActivityAwardSendRequest.QuanyiIsvSendReq obj1 = new PromotionActivityAwardSendRequest.QuanyiIsvSendReq();
obj1.setActivityAlias("abcdef");
obj1.setAwardAlias("abcdef2131");
obj1.setBuyerNick("xh4");
obj1.setPhone("12445167194");
obj1.setBizOrderId(279808654432L);
obj1.setJoinTime("2016-08-19 09:08:00");
obj1.setOutId("123456234567");
obj1.setExtParas("{\"ttid\":\"2121\",\"toabao\":\"sasa1\"}");
obj1.setObsBuyerId("sas1241167821");
req.setAwardExternalSendReq(obj1);
PromotionActivityAwardSendResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
PromotionActivityAwardSendRequest req = new PromotionActivityAwardSendRequest();
PromotionActivityAwardSendRequest.QuanyiIsvSendReqDomain obj1 = new PromotionActivityAwardSendRequest.QuanyiIsvSendReqDomain();
obj1.ActivityAlias = "abcdef";
obj1.AwardAlias = "abcdef2131";
obj1.BuyerNick = "xh4";
obj1.Phone = "12445167194";
obj1.BizOrderId = 279808654432L;
obj1.JoinTime = "2016-08-19 09:08:00";
obj1.OutId = "123456234567";
obj1.ExtParas = "{\"ttid\":\"2121\",\"toabao\":\"sasa1\"}";
obj1.ObsBuyerId = "sas1241167821";
req.AwardExternalSendReq_ = obj1;
PromotionActivityAwardSendResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new PromotionActivityAwardSendRequest;
$award_external_send_req = new QuanyiIsvSendReq;
$award_external_send_req->activity_alias="abcdef";
$award_external_send_req->award_alias="abcdef2131";
$award_external_send_req->buyer_nick="xh4";
$award_external_send_req->phone="12445167194";
$award_external_send_req->biz_order_id="279808654432";
$award_external_send_req->join_time="2016-08-19 09:08:00";
$award_external_send_req->out_id="123456234567";
$award_external_send_req->ext_paras="{\"ttid\":\"2121\",\"toabao\":\"sasa1\"}";
$award_external_send_req->obs_buyer_id="sas1241167821";
$req->setAwardExternalSendReq(json_encode($award_external_send_req));
$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=taobao.promotion.activity.award.send' \
-d 'partner_id=apidoc' \
-d 'session=e8291630-ea4f-4baa-a41f-6d01fb0384f3' \
-d 'sign=6B453358F5737E4807298D8DA72A161D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-02+22%3A24%3A11' \
-d 'v=2.0' \
-d 'award_external_send_req=null'

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

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

req.award_external_send_req="数据结构示例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,"taobao.promotion.activity.award.send");
add_param(pRequest,"award_external_send_req","数据结构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('taobao.promotion.activity.award.send', {
	'award_external_send_req':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<promotion_activity_award_send_response>
    <result>
        <data>true</data>
        <success>true</success>
        <err_code>SUCCESS</err_code>
        <err_msg>SUCCESS</err_msg>
        <success_code>SENDING</success_code>
    </result>
</promotion_activity_award_send_response>

{
    "promotion_activity_award_send_response":{
        "result":{
            "data":true,
            "success":true,
            "err_code":"SUCCESS",
            "err_msg":"SUCCESS",
            "success_code":"SENDING"
        }
    }
}

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.promotion.activity.award.send (权益外放新接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ