阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param	QueryUserBenefitByUserRequest	可选			入参
└ benefit_types String [] 可选 [1] 权益类型 └ exclusive Number 可选 1 专享标识 └ order_type Number 可选 1 订单类型 └ query_status String [] 可选 [1] 查询状态 └ scene_id Number 可选 2 场景 └ user_id Number 可选 12121 用户id

名称	类型	示例值	描述
result	QueryUserBenefitForUserResponse		返回结果
└ fh_code String 请求返回code └ fh_msg String 请求返回信息 └ fh_success Boolean 请求成功标识 user_expired_benefits UserBenefitForUserHsfVo [] 过期权益 └ activity_id Number 活动id └ activity_name String 活动名称 └ activity_tag String 活动标签 └ apply_range Number 适用范围 └ benefit_create_channel Number 出资方 └ benefit_desc String 权益描述 benefit_ext UserBenefitExtHsfVo 扩展信息 └ condition_fen_amount Number 直减条件 └ condition_yuan_amount Number 直减条件 └ reduced_fen_amount Number 直减金额 └ reduced_yuan_amount String 直减金额 └ benefit_id Number 权益id └ benefit_name String 权益名称 └ benefit_sub_title String 权益子标题 └ benefit_type Number 权益类型 └ benefit_url String 异业券领取地址 benefit_use_record_remark_hsf_vo BenefitUseRecordRemarkHsfVo 个人信息和快递信息 └ operator String 操作人 └ operator_time String 操作时间 remark BenefitRecordsRemarkHsfVo 备注 └ courier_firm String 快递公司 └ detail_address String 地址 └ gender Number 性别 └ phone_num String 电话蛤蟆 └ province_city_district_address String 省市区 └ receiver_name String 联系人 └ tracking_number String 快递单号 └ can_use_member_order Boolean 是否可用于会员卡订单 └ company_business_id Number 公司id └ enabled Boolean 是否可用 └ end_time String 结束时间 └ exclusive Number 是否计入专享优惠 └ gmt_create String 创建时间 └ grant_date_time String 权益发放时间 └ icon String 小图标 └ info_icon String 大图片 └ marketing_tag String 权益标签 └ out_benefit_face_type Number 异业券领取方式 └ out_channel_id String 外部渠道 └ sale_num String 优惠数值 └ sale_type Number 优惠类型 └ start_time String 开始时间 └ user_benefit_id Number 用户权益id └ user_benefit_status Number 用户权益状态 └ user_id Number 用户id user_un_used_benefits UserBenefitForUserHsfVo [] 未使用权益 └ activity_id Number 活动id └ activity_name String 活动名称 └ activity_tag String 活动标签 └ apply_range Number 适用范围 └ benefit_create_channel Number 出资方 └ benefit_desc String 权益描述 benefit_ext UserBenefitExtHsfVo 扩展信息 └ condition_fen_amount Number 直减条件 └ condition_yuan_amount Number 直减条件 └ reduced_fen_amount Number 直减金额 └ reduced_yuan_amount String 直减金额 └ benefit_id Number 权益id └ benefit_name String 权益名称 └ benefit_sub_title String 权益子标题 └ benefit_type Number 权益类型 └ benefit_url String 领取地址 benefit_use_record_remark_hsf_vo BenefitUseRecordRemarkHsfVo 个人信息和快递信息 └ operator String 操作人 └ operator_time String 操作时间 remark BenefitRecordsRemarkHsfVo 备注 └ courier_firm String 快递公司 └ detail_address String 地址 └ gender Number 性别 └ phone_num String 电话号 └ province_city_district_address String 省市区 └ receiver_name String 联系人 └ tracking_number String 快递单好 └ can_use_member_order Boolean 是否用于会员卡订单 └ company_business_id Number 公司id └ enabled Boolean 是否可用 └ end_time String 结束时间 └ exclusive Number 是否计入专享优惠 └ gmt_create String 创建时间 └ grant_date_time String 权益领取时间 └ icon String 小图标 └ info_icon String 大图标 └ marketing_tag String 营销标签值 └ out_benefit_face_type Number 异业券领取方式 └ out_channel_id String 外部渠道id └ sale_num String 优惠金额 └ sale_type Number 优惠类型 └ start_time String 开始时间 └ user_benefit_id Number 用户权益id └ user_benefit_status Number 用户权益状态 └ user_id Number 用户id user_used_benefits UserBenefitForUserHsfVo [] 已使用权益 └ activity_id Number 活动id └ activity_name String 活动名称 └ activity_tag String 活动标签 └ apply_range Number 适用范围 └ benefit_create_channel Number 出资方 └ benefit_desc String 权益描述 benefit_ext UserBenefitExtHsfVo 扩展 └ condition_fen_amount Number 直减条件 └ condition_yuan_amount Number 直减条件 └ reduced_fen_amount Number 直减金额 └ reduced_yuan_amount String 直减金额 └ benefit_id Number 权益iid └ benefit_name String 权益名称 └ benefit_sub_title String 权益副标题 └ benefit_type Number 权益类型 └ benefit_url String 领取地址 benefit_use_record_remark_hsf_vo BenefitUseRecordRemarkHsfVo 个人信息和快递信息 └ operator String 操作人 └ operator_time String 操作时间 remark BenefitRecordsRemarkHsfVo 备注 └ courier_firm String 快递公司 └ detail_address String 地址 └ gender Number 性别 └ phone_num String 电话 └ province_city_district_address String 省市区 └ receiver_name String 联系人 └ tracking_number String 快递单号 └ can_use_member_order Boolean 是否可以用于会员卡订单 └ company_business_id Number 公司id └ enabled Boolean 是否可用 └ end_time String 结束时间 └ exclusive Number 是否计入专享优惠 └ gmt_create String 创建时间 └ grant_date_time String 权益领取时间 └ icon String 小图标 └ info_icon String 大图标 └ marketing_tag String 权益标识 └ out_benefit_face_type Number 异业券类型 └ out_channel_id String 外部渠道 └ sale_num String 优惠数值 └ sale_type Number 优惠类型 └ start_time String 开始时间 └ user_benefit_id Number 用户权益id └ user_benefit_status Number 用户权益状态 └ user_id Number 用户id

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlitripFuturehotelHamarketUserbenefitQueryByuserRequest req = new AlitripFuturehotelHamarketUserbenefitQueryByuserRequest();
AlitripFuturehotelHamarketUserbenefitQueryByuserRequest.QueryUserBenefitByUserRequest obj1 = new AlitripFuturehotelHamarketUserbenefitQueryByuserRequest.QueryUserBenefitByUserRequest();
obj1.setBenefitTypes("1");
obj1.setExclusive(1L);
obj1.setOrderType(1L);
obj1.setQueryStatus("1");
obj1.setSceneId(2L);
obj1.setUserId(12121L);
req.setParam(obj1);
AlitripFuturehotelHamarketUserbenefitQueryByuserResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlitripFuturehotelHamarketUserbenefitQueryByuserRequest req = new AlitripFuturehotelHamarketUserbenefitQueryByuserRequest();
AlitripFuturehotelHamarketUserbenefitQueryByuserRequest.QueryUserBenefitByUserRequestDomain obj1 = new AlitripFuturehotelHamarketUserbenefitQueryByuserRequest.QueryUserBenefitByUserRequestDomain();
obj1.BenefitTypes = "1";
obj1.Exclusive = 1L;
obj1.OrderType = 1L;
obj1.QueryStatus = "1";
obj1.SceneId = 2L;
obj1.UserId = 12121L;
req.Param_ = obj1;
AlitripFuturehotelHamarketUserbenefitQueryByuserResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlitripFuturehotelHamarketUserbenefitQueryByuserRequest;
$param = new QueryUserBenefitByUserRequest;
$param->benefit_types="[1]";
$param->exclusive="1";
$param->order_type="1";
$param->query_status="[1]";
$param->scene_id="2";
$param->user_id="12121";
$req->setParam(json_encode($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=alitrip.futurehotel.hamarket.userbenefit.query.byuser' \
-d 'partner_id=apidoc' \
-d 'sign=6D12BA882097BFBBA174960B935AE34F' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-12-14+11%3A24%3A55' \
-d 'v=2.0' \
-d 'param=null'

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

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

req.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,"alitrip.futurehotel.hamarket.userbenefit.query.byuser");
add_param(pRequest,"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('alitrip.futurehotel.hamarket.userbenefit.query.byuser', {
	'param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alitrip_futurehotel_hamarket_userbenefit_query_byuser_response>
    <result>
        <fh_code></fh_code>
        <fh_msg></fh_msg>
        <fh_success></fh_success>
        <user_expired_benefits>
            <user_benefit_for_user_hsf_vo>
                <activity_id></activity_id>
                <activity_name></activity_name>
                <activity_tag></activity_tag>
                <apply_range></apply_range>
                <benefit_create_channel></benefit_create_channel>
                <benefit_desc></benefit_desc>
                <benefit_ext>
                    <condition_fen_amount></condition_fen_amount>
                    <condition_yuan_amount></condition_yuan_amount>
                    <reduced_fen_amount></reduced_fen_amount>
                    <reduced_yuan_amount></reduced_yuan_amount>
                </benefit_ext>
                <benefit_id></benefit_id>
                <benefit_name></benefit_name>
                <benefit_sub_title></benefit_sub_title>
                <benefit_type></benefit_type>
                <benefit_url></benefit_url>
                <benefit_use_record_remark_hsf_vo>
                    <operator></operator>
                    <operator_time></operator_time>
                    <remark>
                        <courier_firm></courier_firm>
                        <detail_address></detail_address>
                        <gender></gender>
                        <phone_num></phone_num>
                        <province_city_district_address></province_city_district_address>
                        <receiver_name></receiver_name>
                        <tracking_number></tracking_number>
                    </remark>
                </benefit_use_record_remark_hsf_vo>
                <can_use_member_order></can_use_member_order>
                <company_business_id></company_business_id>
                <enabled></enabled>
                <end_time></end_time>
                <exclusive></exclusive>
                <gmt_create></gmt_create>
                <grant_date_time></grant_date_time>
                <icon></icon>
                <info_icon></info_icon>
                <marketing_tag></marketing_tag>
                <out_benefit_face_type></out_benefit_face_type>
                <out_channel_id></out_channel_id>
                <sale_num></sale_num>
                <sale_type></sale_type>
                <start_time></start_time>
                <user_benefit_id></user_benefit_id>
                <user_benefit_status></user_benefit_status>
                <user_id></user_id>
            </user_benefit_for_user_hsf_vo>
        </user_expired_benefits>
        <user_un_used_benefits>
            <user_benefit_for_user_hsf_vo>
                <activity_id></activity_id>
                <activity_name></activity_name>
                <activity_tag></activity_tag>
                <apply_range></apply_range>
                <benefit_create_channel></benefit_create_channel>
                <benefit_desc></benefit_desc>
                <benefit_ext>
                    <condition_fen_amount></condition_fen_amount>
                    <condition_yuan_amount></condition_yuan_amount>
                    <reduced_fen_amount></reduced_fen_amount>
                    <reduced_yuan_amount></reduced_yuan_amount>
                </benefit_ext>
                <benefit_id></benefit_id>
                <benefit_name></benefit_name>
                <benefit_sub_title></benefit_sub_title>
                <benefit_type></benefit_type>
                <benefit_url></benefit_url>
                <benefit_use_record_remark_hsf_vo>
                    <operator></operator>
                    <operator_time></operator_time>
                    <remark>
                        <courier_firm></courier_firm>
                        <detail_address></detail_address>
                        <gender></gender>
                        <phone_num></phone_num>
                        <province_city_district_address></province_city_district_address>
                        <receiver_name></receiver_name>
                        <tracking_number></tracking_number>
                    </remark>
                </benefit_use_record_remark_hsf_vo>
                <can_use_member_order></can_use_member_order>
                <company_business_id></company_business_id>
                <enabled></enabled>
                <end_time></end_time>
                <exclusive></exclusive>
                <gmt_create></gmt_create>
                <grant_date_time></grant_date_time>
                <icon></icon>
                <info_icon></info_icon>
                <marketing_tag></marketing_tag>
                <out_benefit_face_type></out_benefit_face_type>
                <out_channel_id></out_channel_id>
                <sale_num></sale_num>
                <sale_type></sale_type>
                <start_time></start_time>
                <user_benefit_id></user_benefit_id>
                <user_benefit_status></user_benefit_status>
                <user_id></user_id>
            </user_benefit_for_user_hsf_vo>
        </user_un_used_benefits>
        <user_used_benefits>
            <user_benefit_for_user_hsf_vo>
                <activity_id></activity_id>
                <activity_name></activity_name>
                <activity_tag></activity_tag>
                <apply_range></apply_range>
                <benefit_create_channel></benefit_create_channel>
                <benefit_desc></benefit_desc>
                <benefit_ext>
                    <condition_fen_amount></condition_fen_amount>
                    <condition_yuan_amount></condition_yuan_amount>
                    <reduced_fen_amount></reduced_fen_amount>
                    <reduced_yuan_amount></reduced_yuan_amount>
                </benefit_ext>
                <benefit_id></benefit_id>
                <benefit_name></benefit_name>
                <benefit_sub_title></benefit_sub_title>
                <benefit_type></benefit_type>
                <benefit_url></benefit_url>
                <benefit_use_record_remark_hsf_vo>
                    <operator></operator>
                    <operator_time></operator_time>
                    <remark>
                        <courier_firm></courier_firm>
                        <detail_address></detail_address>
                        <gender></gender>
                        <phone_num></phone_num>
                        <province_city_district_address></province_city_district_address>
                        <receiver_name></receiver_name>
                        <tracking_number></tracking_number>
                    </remark>
                </benefit_use_record_remark_hsf_vo>
                <can_use_member_order></can_use_member_order>
                <company_business_id></company_business_id>
                <enabled></enabled>
                <end_time></end_time>
                <exclusive></exclusive>
                <gmt_create></gmt_create>
                <grant_date_time></grant_date_time>
                <icon></icon>
                <info_icon></info_icon>
                <marketing_tag></marketing_tag>
                <out_benefit_face_type></out_benefit_face_type>
                <out_channel_id></out_channel_id>
                <sale_num></sale_num>
                <sale_type></sale_type>
                <start_time></start_time>
                <user_benefit_id></user_benefit_id>
                <user_benefit_status></user_benefit_status>
                <user_id></user_id>
            </user_benefit_for_user_hsf_vo>
        </user_used_benefits>
    </result>
</alitrip_futurehotel_hamarket_userbenefit_query_byuser_response>

{
    "alitrip_futurehotel_hamarket_userbenefit_query_byuser_response":{
        "result":{
            "fh_code":"",
            "fh_msg":"",
            "fh_success":,
            "user_expired_benefits":{
                "user_benefit_for_user_hsf_vo":[
                    {
                        "activity_id":,
                        "activity_name":"",
                        "activity_tag":"",
                        "apply_range":,
                        "benefit_create_channel":,
                        "benefit_desc":"",
                        "benefit_ext":{
                            "condition_fen_amount":,
                            "condition_yuan_amount":,
                            "reduced_fen_amount":,
                            "reduced_yuan_amount":""
                        },
                        "benefit_id":,
                        "benefit_name":"",
                        "benefit_sub_title":"",
                        "benefit_type":,
                        "benefit_url":"",
                        "benefit_use_record_remark_hsf_vo":{
                            "operator":"",
                            "operator_time":"",
                            "remark":{
                                "courier_firm":"",
                                "detail_address":"",
                                "gender":,
                                "phone_num":"",
                                "province_city_district_address":"",
                                "receiver_name":"",
                                "tracking_number":""
                            }
                        },
                        "can_use_member_order":,
                        "company_business_id":,
                        "enabled":,
                        "end_time":"",
                        "exclusive":,
                        "gmt_create":"",
                        "grant_date_time":"",
                        "icon":"",
                        "info_icon":"",
                        "marketing_tag":"",
                        "out_benefit_face_type":,
                        "out_channel_id":"",
                        "sale_num":"",
                        "sale_type":,
                        "start_time":"",
                        "user_benefit_id":,
                        "user_benefit_status":,
                        "user_id":
                    }
                ]
            },
            "user_un_used_benefits":{
                "user_benefit_for_user_hsf_vo":[
                    {
                        "activity_id":,
                        "activity_name":"",
                        "activity_tag":"",
                        "apply_range":,
                        "benefit_create_channel":,
                        "benefit_desc":"",
                        "benefit_ext":{
                            "condition_fen_amount":,
                            "condition_yuan_amount":,
                            "reduced_fen_amount":,
                            "reduced_yuan_amount":""
                        },
                        "benefit_id":,
                        "benefit_name":"",
                        "benefit_sub_title":"",
                        "benefit_type":,
                        "benefit_url":"",
                        "benefit_use_record_remark_hsf_vo":{
                            "operator":"",
                            "operator_time":"",
                            "remark":{
                                "courier_firm":"",
                                "detail_address":"",
                                "gender":,
                                "phone_num":"",
                                "province_city_district_address":"",
                                "receiver_name":"",
                                "tracking_number":""
                            }
                        },
                        "can_use_member_order":,
                        "company_business_id":,
                        "enabled":,
                        "end_time":"",
                        "exclusive":,
                        "gmt_create":"",
                        "grant_date_time":"",
                        "icon":"",
                        "info_icon":"",
                        "marketing_tag":"",
                        "out_benefit_face_type":,
                        "out_channel_id":"",
                        "sale_num":"",
                        "sale_type":,
                        "start_time":"",
                        "user_benefit_id":,
                        "user_benefit_status":,
                        "user_id":
                    }
                ]
            },
            "user_used_benefits":{
                "user_benefit_for_user_hsf_vo":[
                    {
                        "activity_id":,
                        "activity_name":"",
                        "activity_tag":"",
                        "apply_range":,
                        "benefit_create_channel":,
                        "benefit_desc":"",
                        "benefit_ext":{
                            "condition_fen_amount":,
                            "condition_yuan_amount":,
                            "reduced_fen_amount":,
                            "reduced_yuan_amount":""
                        },
                        "benefit_id":,
                        "benefit_name":"",
                        "benefit_sub_title":"",
                        "benefit_type":,
                        "benefit_url":"",
                        "benefit_use_record_remark_hsf_vo":{
                            "operator":"",
                            "operator_time":"",
                            "remark":{
                                "courier_firm":"",
                                "detail_address":"",
                                "gender":,
                                "phone_num":"",
                                "province_city_district_address":"",
                                "receiver_name":"",
                                "tracking_number":""
                            }
                        },
                        "can_use_member_order":,
                        "company_business_id":,
                        "enabled":,
                        "end_time":"",
                        "exclusive":,
                        "gmt_create":"",
                        "grant_date_time":"",
                        "icon":"",
                        "info_icon":"",
                        "marketing_tag":"",
                        "out_benefit_face_type":,
                        "out_channel_id":"",
                        "sale_num":"",
                        "sale_type":,
                        "start_time":"",
                        "user_benefit_id":,
                        "user_benefit_status":,
                        "user_id":
                    }
                ]
            }
        }
    }
}

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下载

飞猪-菲住联盟

alitrip.futurehotel.hamarket.userbenefit.query.byuser (用户我的卡券场景，查询可用优惠券)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈