淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
query_param	CouponQueryEffectiveParam	可选			入参
└ cinema_link_id String 可选 112321 影院编码 └ mobile String 必须 1891001023 手机号 └ schedule_ticket String 可选 111 排期信息 └ lease_code String 必须 ykse 租户编码 └ goods String 可选 111 卖品信息 └ channel_code String 可选 YKSE_H5 渠道编码

名称	类型	示例值	描述
result	ListResult		查询结果
data_list Datalist [] 返回数据 └ base_price Number 100 基础售价 └ compensate_type Number 1 0.自定义补差 1.按影票原价补差 2.按最低票价补差 └ coupon_code String D94KGT9N7 券码 └ coupon_name String 10元代金券券名称 defect_compensate_amounts DefectCompensateAmountRule [] 自定义补差范围 └ amount Number 100 补差金额 └ defect_count Number 1 缺失数量 └ end_time String 2022-02-02 失效时间 └ exchange_policy Number 1 兑换策略((1.一对一 3.兑换券-自定义兑换规则)) └ goods_value Number 500 适用卖品的面值/限额 └ product_type Number 1 商品类型 └ product_type_name String 电影票商品类型名称 └ support_compensate Boolean true 是否支持补差 └ template_type Number 1 模版类型 └ template_type_name String 兑换券模版名称 └ ticket_value Number 500 适用影票的面值/限额 └ value Number 100 基础售价/最大限额 └ issuer_name String 测试影院券发行影院名称 └ account_id String ahldksdkhalsd7391231 会员id └ require_pin_code Boolean true pin码校验 └ inner_code String innerCode 内部编码 └ result_code String SUCCESS 结果编码 └ result_msg String 成功结果信息 └ success String true 成功与否

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LarkPosCouponMobileQueryRequest req = new LarkPosCouponMobileQueryRequest();
LarkPosCouponMobileQueryRequest.CouponQueryEffectiveParam obj1 = new LarkPosCouponMobileQueryRequest.CouponQueryEffectiveParam();
obj1.setCinemaLinkId("112321");
obj1.setMobile("1891001023");
obj1.setScheduleTicket("111");
obj1.setLeaseCode("ykse");
obj1.setGoods("111");
obj1.setChannelCode("YKSE_H5");
req.setQueryParam(obj1);
LarkPosCouponMobileQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
LarkPosCouponMobileQueryRequest req = new LarkPosCouponMobileQueryRequest();
LarkPosCouponMobileQueryRequest.CouponQueryEffectiveParamDomain obj1 = new LarkPosCouponMobileQueryRequest.CouponQueryEffectiveParamDomain();
obj1.CinemaLinkId = "112321";
obj1.Mobile = "1891001023";
obj1.ScheduleTicket = "111";
obj1.LeaseCode = "ykse";
obj1.Goods = "111";
obj1.ChannelCode = "YKSE_H5";
req.QueryParam_ = obj1;
LarkPosCouponMobileQueryResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new LarkPosCouponMobileQueryRequest;
$query_param = new CouponQueryEffectiveParam;
$query_param->cinema_link_id="112321";
$query_param->mobile="1891001023";
$query_param->schedule_ticket="111";
$query_param->lease_code="ykse";
$query_param->goods="111";
$query_param->channel_code="YKSE_H5";
$req->setQueryParam(json_encode($query_param));
$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.coupon.mobile.query' \
-d 'partner_id=apidoc' \
-d 'sign=CE9413BFE59822CE94BE5F824671C9E9' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-23+19%3A19%3A15' \
-d 'v=2.0' \
-d 'query_param=null'

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

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

req.query_param=""
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.coupon.mobile.query");
add_param(pRequest,"query_param","数据结构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.lark.pos.coupon.mobile.query', {
	'query_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<lark_pos_coupon_mobile_query_response>
    <result>
        <data_list>
            <datalist>
                <base_price>100</base_price>
                <compensate_type>1</compensate_type>
                <coupon_code>D94KGT9N7</coupon_code>
                <coupon_name>10元代金券</coupon_name>
                <defect_compensate_amounts>
                    <defect_compensate_amount_rule>
                        <amount>100</amount>
                        <defect_count>1</defect_count>
                    </defect_compensate_amount_rule>
                </defect_compensate_amounts>
                <end_time>2022-02-02</end_time>
                <exchange_policy>1</exchange_policy>
                <goods_value>500</goods_value>
                <product_type>1</product_type>
                <product_type_name>电影票</product_type_name>
                <support_compensate>true</support_compensate>
                <template_type>1</template_type>
                <template_type_name>兑换券</template_type_name>
                <ticket_value>500</ticket_value>
                <value>100</value>
                <issuer_name>测试影院</issuer_name>
                <account_id>ahldksdkhalsd7391231</account_id>
                <require_pin_code>true</require_pin_code>
            </datalist>
        </data_list>
        <inner_code>innerCode</inner_code>
        <result_code>SUCCESS</result_code>
        <result_msg>成功</result_msg>
        <success>true</success>
    </result>
</lark_pos_coupon_mobile_query_response>

{
    "lark_pos_coupon_mobile_query_response":{
        "result":{
            "data_list":{
                "datalist":[
                    {
                        "base_price":100,
                        "compensate_type":1,
                        "coupon_code":"D94KGT9N7",
                        "coupon_name":"10元代金券",
                        "defect_compensate_amounts":{
                            "defect_compensate_amount_rule":[
                                {
                                    "amount":100,
                                    "defect_count":1
                                }
                            ]
                        },
                        "end_time":"2022-02-02",
                        "exchange_policy":1,
                        "goods_value":500,
                        "product_type":1,
                        "product_type_name":"电影票",
                        "support_compensate":true,
                        "template_type":1,
                        "template_type_name":"兑换券",
                        "ticket_value":500,
                        "value":100,
                        "issuer_name":"测试影院",
                        "account_id":"ahldksdkhalsd7391231",
                        "require_pin_code":true
                    }
                ]
            },
            "inner_code":"innerCode",
            "result_code":"SUCCESS",
            "result_msg":"成功",
            "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.coupon.mobile.query (云智手机号查券接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ