淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
send_request	BenefitSingleSendRequest	必须		单个权益发放请求
└ benefit_type String 可选 ALIPAY_COUPON 权益类型 └ detail_id Number 可选 123235235 活动详情id └ relation_id Number 可选 12345234 活动id └ send_count Number 必须 1 权益发放数量 └ unique_id String 可选 EA12BC3E5EC3B4 幂等ID，代表一次发放。如，超时重试，需要保证幂等ID不变。不同的幂等ID代表两次不同得发放，因业务方更换幂等ID导致的超发问题由业务方负责
receiver_id	Number	可选	12312312	非混淆的接收者id
nick	String	可选	tbtest1234	混淆的接收者nick
plat_nick	String	可选	tbtest1234	非混淆的接收者nick
mix_receiver_id	String	可选	12312312	混淆的接收者id
ouid	String	可选	12121212	ouid
uid	String	可选	12121221	openid

名称	类型	示例值	描述
result_list	BenefitSendResultExt []		返回活动详情级别的权益发放情况
└ error_code_list String [] error_1,error_1 异常码列表 └ failure_count Number 0 失败数 └ index_id Number 123235235 活动详情id └ success_count Number 10 成功数
unique_id	String	AE12412EAD	uniqueId
is_success	Boolean	true	接口调用是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
PromotionBenefitActivitySendRequest req = new PromotionBenefitActivitySendRequest();
PromotionBenefitActivitySendRequest.BenefitSingleSendRequest obj1 = new PromotionBenefitActivitySendRequest.BenefitSingleSendRequest();
obj1.setBenefitType("ALIPAY_COUPON");
obj1.setDetailId(123235235L);
obj1.setRelationId(12345234L);
obj1.setSendCount(1L);
obj1.setUniqueId("EA12BC3E5EC3B4");
req.setSendRequest(obj1);
req.setReceiverId(12312312L);
req.setNick("tbtest1234");
req.setPlatNick("tbtest1234");
req.setMixReceiverId("12312312");
req.setOuid("12121212");
req.setUid("12121221");
PromotionBenefitActivitySendResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

XML示例
JSON示例

<promotion_benefit_activity_send_response>
    <result_list>
        <benefit_send_result_ext>
            <error_code_list>
                <string>error_1</string>
                <string>error_1</string>
            </error_code_list>
            <failure_count>0</failure_count>
            <index_id>123235235</index_id>
            <success_count>10</success_count>
        </benefit_send_result_ext>
    </result_list>
    <unique_id>AE12412EAD</unique_id>
    <is_success>true</is_success>
</promotion_benefit_activity_send_response>

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>

错误码	错误描述	解决方案
isv.param-error:112	入参为空	检查入参
isv.param-error:203	发放者id为空	填写发放者id
isv.param-error:2010	活动id为空	填写活动id
isv.param-error:295	活动详情未创建	创建活动详情
isp.param-error:100	操作太频繁	请勿频繁操作
isp.param-error:102	系统繁忙	系统繁忙，请稍后再试
isp.param-error:301	请勿重复操作	请勿重复操作
isv.param-error:250	选择发放的权益不存在	请先去创建权益
isp.param-error:236	发放失败	发放失败，请检查传入参数是否正确并稍后再试
isv.param-error:225	接收者不存在	请填写正确的接收者id
isv.param-error:226	权益不存在，发放失败	权益不存在，请设置正确的权益
isp.param-error:101	流水记录写入失败	请查看发放列表信息是否正确，若异常，请联系相关人员
isp.param-error:214	红包发放失败	系统异常，发放失败，请稍后再试
isp.param-error:107	操作太频繁	请勿频繁操作
isv.param-error:2012	权益不存在或权益不可用	检查权益模板是否过期
isv.param-error:107	调用平率太高	降低调用频率
isv.param-error:2210	权益接收者异常	填写正确的接收者id
isv.param-error:236_0	发放已明确失败，无需重试	发放已明确失败，无需重试
isv.param-error:236_1	系统异常：权益实例写入DB异常	请稍候重试，保持幂等ID不变
isv.param-error:236_2	系统异常：下游接口异常	请稍候重试，保持幂等ID不变
isv.param-error:236_3	系统异常：更新权益实例DB写入异常	请稍候重试，保持幂等ID不变
isv.param-error:556	系统异常：未知错误	请稍候重试，保持幂等ID不变

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

开放平台

权益中心

taobao.promotion.benefit.activity.send (活动权益发放接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ