淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
security_level	Number	可选	0	必须传入0
use_start_time	String	可选	2019-01-29	使用开始日期。相对时间，无需填写，以用户领取时间作为使用开始时间。绝对时间，格式 yyyy-MM-dd，例如，2019-01-29，表示从2019-01-29 00:00:00 开始
use_end_time_mode	Number	可选	1	结束日期的模式,1:相对时间，2:绝对时间
use_end_time	String	可选	5	使用结束日期。如果是结束时间模式为相对时间，时间格式为1-7直接的整数, 例如，1（相对领取时间1天）；如果是绝对时间，格式为yyyy-MM-dd，例如，2019-01-29，表示到2019-01-29 23:59:59结束
send_end_time	Date	可选	2018-09-01 00:00:00	发放截止时间
send_start_time	Date	必须	2018-09-01 00:00:00	发放开始时间
per_face	String	必须	10	单个淘礼金面额，支持两位小数，单位元
security_switch	Boolean	必须	true	必须设置为true，默认开启安全
user_total_win_num_limit	Number	必须	1	单用户累计中奖次数上限
name	String	必须	淘礼金来啦	淘礼金名称，最大10个字符
total_num	Number	必须	10	淘礼金总个数
item_id	String	必须	12323	宝贝ID或营销ID
campaign_type	String	可选	MKT	已下线，后续不需要填写
adzone_id	Number	必须	1234567	妈妈广告位Id

名称	类型	示例值	描述
result	Result		result
model RightsInstanceCreateResult 134523^4351232 model └ rights_id String asfasdfasd 淘礼金Id └ send_url String https://www.taobao.com 淘礼金领取Url └ vegas_code String asfasdfasd 投放code【百川商品详情页业务专用】 └ available_fee String 20.23 创建完成后资金账户可用资金，单位元，保留2位小数 └ item_today_num_left Number 10 媒体针对此商品今日剩余可领取淘礼金数量 └ msg_code String 1 msgCode └ msg_info String 1 msgInfo └ success Boolean false success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TbkDgVegasTljCreateRequest req = new TbkDgVegasTljCreateRequest();
req.setSecurityLevel(0L);
req.setUseStartTime("2019-01-29");
req.setUseEndTimeMode(1L);
req.setUseEndTime("5");
req.setSendEndTime(StringUtils.parseDateTime("2018-09-01 00:00:00"));
req.setSendStartTime(StringUtils.parseDateTime("2018-09-01 00:00:00"));
req.setPerFace("10");
req.setSecuritySwitch(true);
req.setUserTotalWinNumLimit(1L);
req.setName("淘礼金来啦");
req.setTotalNum(10L);
req.setItemId("12323");
req.setCampaignType("MKT");
req.setAdzoneId(1234567L);
TbkDgVegasTljCreateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TbkDgVegasTljCreateRequest req = new TbkDgVegasTljCreateRequest();
req.SecurityLevel = 0L;
req.UseStartTime = "2019-01-29";
req.UseEndTimeMode = 1L;
req.UseEndTime = "5";
req.SendEndTime = DateTime.Parse("2018-09-01 00:00:00");
req.SendStartTime = DateTime.Parse("2018-09-01 00:00:00");
req.PerFace = "10";
req.SecuritySwitch = true;
req.UserTotalWinNumLimit = 1L;
req.Name = "淘礼金来啦";
req.TotalNum = 10L;
req.ItemId = "12323";
req.CampaignType = "MKT";
req.AdzoneId = 1234567L;
TbkDgVegasTljCreateResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TbkDgVegasTljCreateRequest;
$req->setSecurityLevel("0");
$req->setUseStartTime("2019-01-29");
$req->setUseEndTimeMode("1");
$req->setUseEndTime("5");
$req->setSendEndTime("2018-09-01 00:00:00");
$req->setSendStartTime("2018-09-01 00:00:00");
$req->setPerFace("10");
$req->setSecuritySwitch("true");
$req->setUserTotalWinNumLimit("1");
$req->setName("淘礼金来啦");
$req->setTotalNum("10");
$req->setItemId("12323");
$req->setCampaignType("MKT");
$req->setAdzoneId("1234567");
$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.dg.vegas.tlj.create' \
-d 'partner_id=apidoc' \
-d 'sign=3D375FDFEA6CB6EC661BEF34C2649318' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-05-05+03%3A41%3A20' \
-d 'v=2.0' \
-d 'adzone_id=1234567' \
-d 'campaign_type=MKT' \
-d 'item_id=12323' \
-d 'name=%E6%B7%98%E7%A4%BC%E9%87%91%E6%9D%A5%E5%95%A6' \
-d 'per_face=10' \
-d 'security_level=0' \
-d 'security_switch=true' \
-d 'send_end_time=2018-09-01+00%3A00%3A00' \
-d 'send_start_time=2018-09-01+00%3A00%3A00' \
-d 'total_num=10' \
-d 'use_end_time=5' \
-d 'use_end_time_mode=1' \
-d 'use_start_time=2019-01-29' \
-d 'user_total_win_num_limit=1'

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

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

req.security_level=0
req.use_start_time="2019-01-29"
req.use_end_time_mode=1
req.use_end_time="5"
req.send_end_time="2018-09-01 00:00:00"
req.send_start_time="2018-09-01 00:00:00"
req.per_face="10"
req.security_switch=true
req.user_total_win_num_limit=1
req.name="淘礼金来啦"
req.total_num=10
req.item_id="12323"
req.campaign_type="MKT"
req.adzone_id=1234567
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.dg.vegas.tlj.create");
add_param(pRequest,"security_level","0");
add_param(pRequest,"use_start_time","2019-01-29");
add_param(pRequest,"use_end_time_mode","1");
add_param(pRequest,"use_end_time","5");
add_param(pRequest,"send_end_time","2018-09-01 00:00:00");
add_param(pRequest,"send_start_time","2018-09-01 00:00:00");
add_param(pRequest,"per_face","10");
add_param(pRequest,"security_switch","true");
add_param(pRequest,"user_total_win_num_limit","1");
add_param(pRequest,"name","淘礼金来啦");
add_param(pRequest,"total_num","10");
add_param(pRequest,"item_id","12323");
add_param(pRequest,"campaign_type","MKT");
add_param(pRequest,"adzone_id","1234567");
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.dg.vegas.tlj.create', {
	'security_level':'0',
	'use_start_time':'2019-01-29',
	'use_end_time_mode':'1',
	'use_end_time':'5',
	'send_end_time':'2018-09-01 00:00:00',
	'send_start_time':'2018-09-01 00:00:00',
	'per_face':'10',
	'security_switch':'true',
	'user_total_win_num_limit':'1',
	'name':'淘礼金来啦',
	'total_num':'10',
	'item_id':'12323',
	'campaign_type':'MKT',
	'adzone_id':'1234567'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tbk_dg_vegas_tlj_create_response>
    <result>
        <model>
            <rights_id>asfasdfasd</rights_id>
            <send_url>https://www.taobao.com</send_url>
            <vegas_code>asfasdfasd</vegas_code>
            <available_fee>20.23</available_fee>
            <item_today_num_left>10</item_today_num_left>
        </model>
        <msg_code>1</msg_code>
        <msg_info>1</msg_info>
        <success>false</success>
    </result>
</tbk_dg_vegas_tlj_create_response>

{
    "tbk_dg_vegas_tlj_create_response":{
        "result":{
            "model":{
                "rights_id":"asfasdfasd",
                "send_url":"https:\/\/www.taobao.com",
                "vegas_code":"asfasdfasd",
                "available_fee":"20.23",
                "item_today_num_left":10
            },
            "msg_code":"1",
            "msg_info":"1",
            "success":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"
	}
}

错误码	错误描述	解决方案
isp.vegas-server-unavailable	服务不可用	请重新调用接口创建
isp.call-limited	调用限流	请重新调用接口进行创建
isv.FAIL_BIZ_HAS_NO_PRIVILEGE	暂无淘礼金创建权限	暂无淘礼金创建权限，请先申请，详见：https://mo.re.taobao.com/page_201905042138222
isv.FAIL_BIZ_VIOLATION_POINT_EXCEED	您的账号因权限异常已被停用，请联系客服申诉	您的账号因权限异常已被停用，请联系客服申诉
isv.FAIL_BIZ_ITEM_FORBIDDEN	该商品不支持创建淘礼金红包，了解详细规则：https://mo.re.taobao.com/page_201905042138222	该商品不支持创建淘礼金红包，了解详细规则：https://mo.re.taobao.com/page_201905042138222
isv.FAIL_BIZ_NOT_TK_ITEM	该商品为非淘客宝贝，不支持创建淘礼金红包	该商品为非淘客宝贝，不支持创建淘礼金红包
isv.FAIL_CHECK_DAILY_SEND_AMOUNT_EXCEED	超过每日发放限额	超过每日发放限额，请去淘宝联盟APP玩法钱包自助调整
isv.FAIL_CHECK_MEMBER_DAILY_SEND_ITEM_ABOVE_LIMIT_ERROR	今日商品创建数已超上限，请您明日再试	今日商品创建数已超上限，请您明日再试
isv.FAIL_CHECK_MEMBER_ITEM_DAILY_SEND_TLJ_ABOVE_LIMIT_ERROR	今日淘礼金红包创建数已超上限，请您明日再试	今日淘礼金红包创建数已超上限，请您明日再试
isv.FAIL_CHECK_SELLER_CREATE_ITEM_NUM_RULE_ERROR	您对该商家商品的淘礼金创建数已超上限，请选择其他商品创建	您对该商家商品的淘礼金创建数已超上限，请选择其他商品创建
isv.FAIL_CHECK_MEMBER_CREATE_ITEM_NUM_CHECK_ERROR	该商品淘礼金创建数已超上限，请选择其他商品创建	该商品淘礼金创建数已超上限，请选择其他商品创建
isv.FAIL_CHECK_SELLER_DAILY_CREATE_NUM_ABOVE_LIMIT_ERROR	今日该商家商品淘礼金创建数已超上限，请您明日再试	今日该商家商品淘礼金创建数已超上限，请您明日再试
isv.FAIL_CHECK_TLJ_MIN_FACE_ERROR	单个红包面额必须大于等于1元	单个红包面额必须大于等于1元
isv.FAIL_BIZ_ASSET_ACCOUNT_NOT_EXISTS	您的淘礼金账户暂未创建，请前往资金管理页面充值	您的淘礼金账户暂未创建，请前往资金管理页面充值
isv.FAIL_BIZ_ACCOUNT_UN_PAID	您的淘礼金账户暂未创建，请前往资金管理页面充值	您的淘礼金账户暂未创建，请前往资金管理页面充值
isv.ASSET_ACCOUNT_BALANCE_NOT_ENOUGH	账户预算不足，请充值后重新创建	账户预算不足，请充值后重新创建
isv.FAIL_BIZ_PARAMS_ERROR	参数错误，请确认配置信息正确性	参数错误，请确认配置信息正确性
isv.FAIL_BIZ_CREATE_FORBIDDEN	暂未开放淘礼金创建接口	暂未开放淘礼金创建接口
isv.FAIL_BIZ_EXTERNAL_SERVICE_EXCEPTION	创建淘礼金红包失败，请重新调用接口进行创建	创建淘礼金红包失败，请重新调用接口进行创建
isv.FAIL_BIZ_SYSTEM_ERROR	创建淘礼金红包失败，请重新调用接口进行创建	创建淘礼金红包失败，请重新调用接口进行创建
isp.ACK_FREEZE_ASSET_ACCOUNT_ERROR	创建淘礼金红包失败，请重新调用接口进行创建	创建淘礼金红包失败，请重新调用接口进行创建
isv.FAIL_CHECK_ITEM_DAILY_SEND_NUM_CHECK_ERROR	今日该商品淘礼金创建数已超上限，请您明日再试	今日该商品淘礼金创建数已超上限，请您明日再试
isv.PARAM_IS_EMPTY	PARAM_IS_EMPTY	参数不能为空
isv.FAIL_BIZ_SERVICE_TIMEOUT	FAIL_BIZ_SERVICE_TIMEOUT	系统异常，请稍后重试
isv.MEMBER_DAILY_DRAW_ITEM_ABOVE_LIMIT	MEMBER_DAILY_DRAW_ITEM_ABOVE_LIMIT	该商品单账号领取已达上限，请明日进行创建
isv.SELLER_DAILY_DRAW_ITEM_ABOVE_LIMIT	SELLER_DAILY_DRAW_ITEM_ABOVE_LIMIT	该商品所属商家今日领取已达上限，请明日进行创建
isv.DAILY_DRAW_ITEM_ABOVE_LIMIT	DAILY_DRAW_ITEM_ABOVE_LIMIT	该商品今日已达上限，请更换商品创建
isv.CREATE_INSTANCE_ERROR	CREATE_INSTANCE_ERROR	创建错误, 请稍后重试
isv.ACK_FREEZE_FAIL	ACK_FREEZE_FAIL	确认冻结失败
isv.NAME_LENGTH_EXCEED	NAME_LENGTH_EXCEED	红包名称长度必须小于等于10个字符
isv.SEND_DATE_TIME_LIMIT	SEND_DATE_TIME_LIMIT	发放有效期大于30天，请重新设置
isv.TOTAL_NUM_BELOW_LIMIT	TOTAL_NUM_BELOW_LIMIT	红包总个数必须大于等于1
isv.USER_TOTAL_WIN_NUM_LIMIT	USER_TOTAL_WIN_NUM_LIMIT	单用户领取上限最低为1，请重新设置
isv.USER_TOTAL_WIN_NUM_LIMIT_BELOW_TOTAL_NUM	USER_TOTAL_WIN_NUM_LIMIT_BELOW_TOTAL_NUM	单用户领取上限大于淘礼金个数，请重新设置
isv.ACCOUNT_STATUS_INVALID	ACCOUNT_STATUS_INVALID	玩法钱包账户状态异常
isv.invalid-argument	invalid-argument	参数错误，请修改后重新创建
isv.SHIELD_ACCESS_RELATION_ERROR	您的关联账号存在严重违规行为，无法开通淘礼金权限	您的关联账号存在严重违规行为，无法开通淘礼金权限
isv.SHIELD_ACCESS_SELF_ERROR	您的账号累计扣分大于等于18分，无法开通淘礼金权限，请您核实账号处罚信息后再次申请	您的账号累计扣分大于等于18分，无法开通淘礼金权限，请您核实账号处罚信息后再次申请
-4003	您输入的商品ID不合法，请使用升级后的新商品ID，如有疑问请加入【淘宝联盟】线上合规升级咨询群（钉钉群：44965410）进行咨询	您输入的商品ID不合法，请使用升级后的新商品ID，如有疑问请加入【淘宝联盟】线上合规升级咨询群（钉钉群：44965410）进行咨询

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

淘宝客API

taobao.tbk.dg.vegas.tlj.create (淘宝客-推广者-淘礼金创建)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ