淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
cinema_link_id	String	必须	"555"	影院内码
channel_type	String	必须	"POS"	渠道类型："POS"(影城柜台)，"OWN"(自有渠道)
prom_type	String	必须	"ONLINE_FREE_COUPON"	优惠类型："ONLINE_FREE_COUPON"(线上免费领券)"POS_GIFT_COUPON"(柜台赠券)

名称	类型	示例值	描述
data	Json	{"dataList":[{"activityCode":"uvjpbkhvuo8j","activityIntro":"测试活动001","activityName":"测试活动001","activityType":"RAFFLE_FREE_COUPON","auditUser":"lark-admin","bizType":"FREE_COUPON","channelType":"OWN","couponList":[{"activityId":9085,"count":11,"countStr":"11","showName":"迪士尼-50","templateCode":"11410"},{"activityId":9085,"count":11,"countStr":"11","showName":"11","templateCode":"11408"}],"endTime":1525103999000,"promoType":"ONLINE_FREE_COUPON","startTime":1523116800000,"status":"RUNNING"}],"resultCode":"SUCCESS","success":true}	可用的免费赠券活动列表

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LarkPosMarketingGetfreecouponactivitylistRequest req = new LarkPosMarketingGetfreecouponactivitylistRequest();
req.setCinemaLinkId("\"555\"");
req.setChannelType("\"POS\"");
req.setPromType("\"ONLINE_FREE_COUPON\"");
LarkPosMarketingGetfreecouponactivitylistResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
LarkPosMarketingGetfreecouponactivitylistRequest req = new LarkPosMarketingGetfreecouponactivitylistRequest();
req.CinemaLinkId = "\"555\"";
req.ChannelType = "\"POS\"";
req.PromType = "\"ONLINE_FREE_COUPON\"";
LarkPosMarketingGetfreecouponactivitylistResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new LarkPosMarketingGetfreecouponactivitylistRequest;
$req->setCinemaLinkId("\"555\"");
$req->setChannelType("\"POS\"");
$req->setPromType("\"ONLINE_FREE_COUPON\"");
$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.lark.pos.marketing.getfreecouponactivitylist' \
-d 'partner_id=apidoc' \
-d 'sign=DF4AA0D397E06AF55DA60AA987232670' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-03+22%3A59%3A42' \
-d 'v=2.0' \
-d 'channel_type=%5C%22POS%5C%22' \
-d 'cinema_link_id=%5C%22555%5C%22' \
-d 'prom_type=%5C%22ONLINE_FREE_COUPON%5C%22'

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

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

req.cinema_link_id="\"555\""
req.channel_type="\"POS\""
req.prom_type="\"ONLINE_FREE_COUPON\""
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.lark.pos.marketing.getfreecouponactivitylist");
add_param(pRequest,"cinema_link_id","\"555\"");
add_param(pRequest,"channel_type","\"POS\"");
add_param(pRequest,"prom_type","\"ONLINE_FREE_COUPON\"");
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.lark.pos.marketing.getfreecouponactivitylist', {
	'cinema_link_id':'\"555\"',
	'channel_type':'\"POS\"',
	'prom_type':'\"ONLINE_FREE_COUPON\"'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<lark_pos_marketing_getfreecouponactivitylist_response>
    <data>{&quot;dataList&quot;:[{&quot;activityCode&quot;:&quot;uvjpbkhvuo8j&quot;,&quot;activityIntro&quot;:&quot;测试活动001&quot;,&quot;activityName&quot;:&quot;测试活动001&quot;,&quot;activityType&quot;:&quot;RAFFLE_FREE_COUPON&quot;,&quot;auditUser&quot;:&quot;lark-admin&quot;,&quot;bizType&quot;:&quot;FREE_COUPON&quot;,&quot;channelType&quot;:&quot;OWN&quot;,&quot;couponList&quot;:[{&quot;activityId&quot;:9085,&quot;count&quot;:11,&quot;countStr&quot;:&quot;11&quot;,&quot;showName&quot;:&quot;迪士尼-50&quot;,&quot;templateCode&quot;:&quot;11410&quot;},{&quot;activityId&quot;:9085,&quot;count&quot;:11,&quot;countStr&quot;:&quot;11&quot;,&quot;showName&quot;:&quot;11&quot;,&quot;templateCode&quot;:&quot;11408&quot;}],&quot;endTime&quot;:1525103999000,&quot;promoType&quot;:&quot;ONLINE_FREE_COUPON&quot;,&quot;startTime&quot;:1523116800000,&quot;status&quot;:&quot;RUNNING&quot;}],&quot;resultCode&quot;:&quot;SUCCESS&quot;,&quot;success&quot;:true}</data>
</lark_pos_marketing_getfreecouponactivitylist_response>

{
    "lark_pos_marketing_getfreecouponactivitylist_response":{
        "data":"{\"dataList\":[{\"activityCode\":\"uvjpbkhvuo8j\",\"activityIntro\":\"测试活动001\",\"activityName\":\"测试活动001\",\"activityType\":\"RAFFLE_FREE_COUPON\",\"auditUser\":\"lark-admin\",\"bizType\":\"FREE_COUPON\",\"channelType\":\"OWN\",\"couponList\":[{\"activityId\":9085,\"count\":11,\"countStr\":\"11\",\"showName\":\"迪士尼-50\",\"templateCode\":\"11410\"},{\"activityId\":9085,\"count\":11,\"countStr\":\"11\",\"showName\":\"11\",\"templateCode\":\"11408\"}],\"endTime\":1525103999000,\"promoType\":\"ONLINE_FREE_COUPON\",\"startTime\":1523116800000,\"status\":\"RUNNING\"}],\"resultCode\":\"SUCCESS\",\"success\":true}"
    }
}

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.lark.pos.marketing.getfreecouponactivitylist (查询影院可用的免费赠券活动)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ