淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
gift_send_result_sync_dto	GiftSendResultSyncDTO	可选			入参
└ open_uid String 必须 213 用户id └ order_id String 必须 1233312 订单id └ award_amount String 必须 1 发放权益面额，单位分 └ award_name String 必须 1分钱猫超卡权益名称 └ status String 必须 0000 发放结果，0000发放成功 └ award_type String 必须猫超卡权益类型

名称	类型	示例值	描述
in_code	String	0000	错误码
in_success	Boolean	true	是否调用成功
model	GiftSendResultSyncOutputDTO		返回结果
└ order_id String 123 订单id
desc	String	成功	错误描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
VtplanContractGiftSendResultRequest req = new VtplanContractGiftSendResultRequest();
VtplanContractGiftSendResultRequest.GiftSendResultSyncDTO obj1 = new VtplanContractGiftSendResultRequest.GiftSendResultSyncDTO();
obj1.setOpenUid("213");
obj1.setOrderId("1233312");
obj1.setAwardAmount("1");
obj1.setAwardName("1分钱猫超卡");
obj1.setStatus("0000");
obj1.setAwardType("猫超卡");
req.setGiftSendResultSyncDto(obj1);
VtplanContractGiftSendResultResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
VtplanContractGiftSendResultRequest req = new VtplanContractGiftSendResultRequest();
VtplanContractGiftSendResultRequest.GiftSendResultSyncDTODomain obj1 = new VtplanContractGiftSendResultRequest.GiftSendResultSyncDTODomain();
obj1.OpenUid = "213";
obj1.OrderId = "1233312";
obj1.AwardAmount = "1";
obj1.AwardName = "1分钱猫超卡";
obj1.Status = "0000";
obj1.AwardType = "猫超卡";
req.GiftSendResultSyncDto_ = obj1;
VtplanContractGiftSendResultResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new VtplanContractGiftSendResultRequest;
$gift_send_result_sync_dto = new GiftSendResultSyncDTO;
$gift_send_result_sync_dto->open_uid="213";
$gift_send_result_sync_dto->order_id="1233312";
$gift_send_result_sync_dto->award_amount="1";
$gift_send_result_sync_dto->award_name="1分钱猫超卡";
$gift_send_result_sync_dto->status="0000";
$gift_send_result_sync_dto->award_type="猫超卡";
$req->setGiftSendResultSyncDto(json_encode($gift_send_result_sync_dto));
$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.vtplan.contract.gift.send.result' \
-d 'partner_id=apidoc' \
-d 'sign=7A5C7C09FF43FB2176708F605289B5A5' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-10-18+22%3A08%3A20' \
-d 'v=2.0' \
-d 'gift_send_result_sync_dto=null'

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

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

req.gift_send_result_sync_dto="数据结构示例JSON格式"
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.vtplan.contract.gift.send.result");
add_param(pRequest,"gift_send_result_sync_dto","数据结构JSON示例");
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.vtplan.contract.gift.send.result', {
	'gift_send_result_sync_dto':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<vtplan_contract_gift_send_result_response>
    <in_code>0000</in_code>
    <in_success>true</in_success>
    <model>
        <order_id>123</order_id>
    </model>
    <desc>成功</desc>
</vtplan_contract_gift_send_result_response>

{
    "vtplan_contract_gift_send_result_response":{
        "in_code":"0000",
        "in_success":true,
        "model":{
            "order_id":"123"
        },
        "desc":"成功"
    }
}

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.vtplan.contract.gift.send.result (买赠购后合约权益发放结果回传)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ