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

请求地址：

环境	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_customer_get_open_req	CustomerGetOpenReq	可选			入参
└ brand_id String 必须 829429342 saas品牌id └ mobile String 可选 18651822226 手机号 └ outer_id String 可选 2088982439203023 外部id └ outer_type String 可选 alipay 外部id类型，wechat：微信openId alipay：支付宝 └ physical_card_id String 可选 232920301232 物理卡id └ shop_id String 必须 3434353 saas门店id └ customer_id String 可选 13243 顾客id

名称	类型	示例值	描述
result	CommonResult		接口结果
└ biz_success Boolean true 是否成功 result CustomerGetOpenInfo 结果 card_open_info_list CardOpenInfo [] 卡实例信息 accounts AccountOpenInfo [] 账户信息 └ balance Number 1 余额 └ gift Number 1 赠储 └ pre Number 1 预储 └ real Number 1 实储 └ total_gift Number 1 总赠储 └ total_pre Number 1 总预储 └ total_real Number 1 总实储 └ card_id String 1234567 卡id └ card_template_id String 21323445524 卡模板id └ card_type String MEMBER 卡类型，MEMBER：会员卡，GIFT：礼品卡 └ status String SOLD 电子卡状态，SOLD：已出售，ACTIVED：已激活，STOP：已停用，INVALID：已作废，EXPIRED：已过期，REFUND：已退卡 customer_open_info CustomerOpenInfo 会员信息 └ birthday Date 1992-09-29 生日 └ channel Number 4 渠道 └ customer_id String 124243 顾客id └ customer_type Number 1 顾客类型，顾客：0，会员：1 └ email String 123@qq.com email └ gender Number 1 性别 0女 1男 └ level_desc String 2 等级详情 └ level_id String 123421332344 等级id └ level_no Number 2 等级号 └ mobile String 18723342332 手机号 └ name String 测试姓名 └ remark String 测试备注 └ member_time Date 2019-01-01 入会时间 └ member_store_id String 1234422 入会门店 point_account_open_info PointAccountOpenInfo 积分信息 └ available_point Number 1 剩余可用积分 └ freeze_point Number 1 已冻结积分 └ total_point Number 1 累计获取积分 └ total_used_point Number 1 累计被使用积分 └ remain_point Number 1 剩余总积分 voucher_open_info_list VoucherOpenInfo [] 券信息 └ amount Number 1 面额 └ end_time String 2022-12-12 失效时间 └ start_fee Number 1 满足金额阀值，单位：分 └ start_time String 2022-10-01 券开始时间 └ status String INIT 状态 └ title String 测试券名称 └ voucher_id String 1232435 券实例id └ voucher_template_id String 13433322 券模板id └ voucher_type String CASH 优惠券类型，CASH：代金券，DISCOUNT：折扣券，GIFT：礼品券 └ discount_rate String 0 折扣率 └ item_id_list String [] 商品id列表 └ shop_id_list String [] 门店id列表 └ user_limit Number 3 每人限领，-1代表不限 └ item_coverage String ALL 适用商品范围值：ALL，PART_AVAILABLE，PART_UNAVAILABLE * 说明：全部商品可用，部分商品可用，部分商品不可用 └ shop_coverage String ALL 适用商品范围值：ALL，PART_AVAILABLE * 说明：全部门店可用，部分门店可用 └ available_time String {\"type\":0,\"settings\":[{\"dayStartTime\":\"00:00\",\"dayEndTime\":\"23:59\",\"week\":[]}]} {\"type\":0,\"settings\":[{\"dayStartTime\":\"00:00\",\"dayEndTime\":\"23:59\",\"week\":[]}]} type:0不限制，1限制 dayStartTime:开始时间 dayEndTime:结束时间 week:1,2,3,4,5,6,7 item_info_list VoucherItemInfo [] 商品信息 └ sku_id String 2424443 sku规格id └ dish_id String 123445 菜品id └ sku_out_no String 2345 外部sku规格id └ dish_out_no String 2345 外部菜品id shop_info_list VoucherShopInfo [] 门店信息 └ out_shop_id String 234545 外部门店id └ shop_id String 2345 门店id └ ext_info String {"giftName":"贝乐果棒棒糖","giftGoodsSkuId":"12345","skuOutNo":"123","dishOutNo":"345"} 扩展字段,包含了礼品券的信息 └ use_condition String DINE_IN DINE_IN堂食，TAKE_OUT外卖 └ result_code String 0 结果码 └ result_desc String SUCCESS 结果详情 └ result_view String 处理成功结果显示

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlscCrmOpenCustomerGetRequest req = new AlibabaAlscCrmOpenCustomerGetRequest();
AlibabaAlscCrmOpenCustomerGetRequest.CustomerGetOpenReq obj1 = new AlibabaAlscCrmOpenCustomerGetRequest.CustomerGetOpenReq();
obj1.setBrandId("829429342");
obj1.setMobile("18651822226");
obj1.setOuterId("2088982439203023");
obj1.setOuterType("alipay");
obj1.setPhysicalCardId("232920301232");
obj1.setShopId("3434353");
obj1.setCustomerId("13243");
req.setParamCustomerGetOpenReq(obj1);
AlibabaAlscCrmOpenCustomerGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAlscCrmOpenCustomerGetRequest req = new AlibabaAlscCrmOpenCustomerGetRequest();
AlibabaAlscCrmOpenCustomerGetRequest.CustomerGetOpenReqDomain obj1 = new AlibabaAlscCrmOpenCustomerGetRequest.CustomerGetOpenReqDomain();
obj1.BrandId = "829429342";
obj1.Mobile = "18651822226";
obj1.OuterId = "2088982439203023";
obj1.OuterType = "alipay";
obj1.PhysicalCardId = "232920301232";
obj1.ShopId = "3434353";
obj1.CustomerId = "13243";
req.ParamCustomerGetOpenReq_ = obj1;
AlibabaAlscCrmOpenCustomerGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaAlscCrmOpenCustomerGetRequest;
$param_customer_get_open_req = new CustomerGetOpenReq;
$param_customer_get_open_req->brand_id="829429342";
$param_customer_get_open_req->mobile="18651822226";
$param_customer_get_open_req->outer_id="2088982439203023";
$param_customer_get_open_req->outer_type="alipay";
$param_customer_get_open_req->physical_card_id="232920301232";
$param_customer_get_open_req->shop_id="3434353";
$param_customer_get_open_req->customer_id="13243";
$req->setParamCustomerGetOpenReq(json_encode($param_customer_get_open_req));
$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=alibaba.alsc.crm.open.customer.get' \
-d 'partner_id=apidoc' \
-d 'sign=4BB6DBD44044B1976BAAD62BA9BAE1E6' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-19+15%3A33%3A51' \
-d 'v=2.0' \
-d 'param_customer_get_open_req=null'

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

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

req.param_customer_get_open_req=""
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,"alibaba.alsc.crm.open.customer.get");
add_param(pRequest,"param_customer_get_open_req","数据结构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('alibaba.alsc.crm.open.customer.get', {
	'param_customer_get_open_req':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_alsc_crm_open_customer_get_response>
    <result>
        <biz_success>true</biz_success>
        <result>
            <card_open_info_list>
                <card_open_info>
                    <accounts>
                        <account_open_info>
                            <balance>1</balance>
                            <gift>1</gift>
                            <pre>1</pre>
                            <real>1</real>
                            <total_gift>1</total_gift>
                            <total_pre>1</total_pre>
                            <total_real>1</total_real>
                        </account_open_info>
                    </accounts>
                    <card_id>1234567</card_id>
                    <card_template_id>21323445524</card_template_id>
                    <card_type>MEMBER</card_type>
                    <status>SOLD</status>
                </card_open_info>
            </card_open_info_list>
            <customer_open_info>
                <birthday>1992-09-29</birthday>
                <channel>4</channel>
                <customer_id>124243</customer_id>
                <customer_type>1</customer_type>
                <email>123@qq.com</email>
                <gender>1</gender>
                <level_desc>2</level_desc>
                <level_id>123421332344</level_id>
                <level_no>2</level_no>
                <mobile>18723342332</mobile>
                <name>测试</name>
                <remark>测试</remark>
                <member_time>2019-01-01</member_time>
                <member_store_id>1234422</member_store_id>
            </customer_open_info>
            <point_account_open_info>
                <available_point>1</available_point>
                <freeze_point>1</freeze_point>
                <total_point>1</total_point>
                <total_used_point>1</total_used_point>
                <remain_point>1</remain_point>
            </point_account_open_info>
            <voucher_open_info_list>
                <voucher_open_info>
                    <amount>1</amount>
                    <end_time>2022-12-12</end_time>
                    <start_fee>1</start_fee>
                    <start_time>2022-10-01</start_time>
                    <status>INIT</status>
                    <title>测试</title>
                    <voucher_id>1232435</voucher_id>
                    <voucher_template_id>13433322</voucher_template_id>
                    <voucher_type>CASH</voucher_type>
                    <discount_rate>0</discount_rate>
                    <item_id_list>
                        <string></string>
                    </item_id_list>
                    <shop_id_list>
                        <string></string>
                    </shop_id_list>
                    <user_limit>3</user_limit>
                    <item_coverage>ALL</item_coverage>
                    <shop_coverage>ALL</shop_coverage>
                    <available_time>{\&quot;type\&quot;:0,\&quot;settings\&quot;:[{\&quot;dayStartTime\&quot;:\&quot;00:00\&quot;,\&quot;dayEndTime\&quot;:\&quot;23:59\&quot;,\&quot;week\&quot;:[]}]}</available_time>
                    <item_info_list>
                        <voucher_item_info>
                            <sku_id>2424443</sku_id>
                            <dish_id>123445</dish_id>
                            <sku_out_no>2345</sku_out_no>
                            <dish_out_no>2345</dish_out_no>
                        </voucher_item_info>
                    </item_info_list>
                    <shop_info_list>
                        <voucher_shop_info>
                            <out_shop_id>234545</out_shop_id>
                            <shop_id>2345</shop_id>
                        </voucher_shop_info>
                    </shop_info_list>
                    <ext_info>{&quot;giftName&quot;:&quot;贝乐果棒棒糖&quot;,&quot;giftGoodsSkuId&quot;:&quot;12345&quot;,&quot;skuOutNo&quot;:&quot;123&quot;,&quot;dishOutNo&quot;:&quot;345&quot;}</ext_info>
                    <use_condition>DINE_IN</use_condition>
                </voucher_open_info>
            </voucher_open_info_list>
        </result>
        <result_code>0</result_code>
        <result_desc>SUCCESS</result_desc>
        <result_view>处理成功</result_view>
    </result>
</alibaba_alsc_crm_open_customer_get_response>

{
    "alibaba_alsc_crm_open_customer_get_response":{
        "result":{
            "biz_success":true,
            "result":{
                "card_open_info_list":{
                    "card_open_info":[
                        {
                            "accounts":{
                                "account_open_info":[
                                    {
                                        "balance":1,
                                        "gift":1,
                                        "pre":1,
                                        "real":1,
                                        "total_gift":1,
                                        "total_pre":1,
                                        "total_real":1
                                    }
                                ]
                            },
                            "card_id":"1234567",
                            "card_template_id":"21323445524",
                            "card_type":"MEMBER",
                            "status":"SOLD"
                        }
                    ]
                },
                "customer_open_info":{
                    "birthday":"1992-09-29",
                    "channel":4,
                    "customer_id":"124243",
                    "customer_type":1,
                    "email":"123@qq.com",
                    "gender":1,
                    "level_desc":"2",
                    "level_id":"123421332344",
                    "level_no":2,
                    "mobile":"18723342332",
                    "name":"测试",
                    "remark":"测试",
                    "member_time":"2019-01-01",
                    "member_store_id":"1234422"
                },
                "point_account_open_info":{
                    "available_point":1,
                    "freeze_point":1,
                    "total_point":1,
                    "total_used_point":1,
                    "remain_point":1
                },
                "voucher_open_info_list":{
                    "voucher_open_info":[
                        {
                            "amount":1,
                            "end_time":"2022-12-12",
                            "start_fee":1,
                            "start_time":"2022-10-01",
                            "status":"INIT",
                            "title":"测试",
                            "voucher_id":"1232435",
                            "voucher_template_id":"13433322",
                            "voucher_type":"CASH",
                            "discount_rate":"0",
                            "item_id_list":{
                                "string":[
                                    ""
                                ]
                            },
                            "shop_id_list":{
                                "string":[
                                    ""
                                ]
                            },
                            "user_limit":3,
                            "item_coverage":"ALL",
                            "shop_coverage":"ALL",
                            "available_time":"{\\\"type\\\":0,\\\"settings\\\":[{\\\"dayStartTime\\\":\\\"00:00\\\",\\\"dayEndTime\\\":\\\"23:59\\\",\\\"week\\\":[]}]}",
                            "item_info_list":{
                                "voucher_item_info":[
                                    {
                                        "sku_id":"2424443",
                                        "dish_id":"123445",
                                        "sku_out_no":"2345",
                                        "dish_out_no":"2345"
                                    }
                                ]
                            },
                            "shop_info_list":{
                                "voucher_shop_info":[
                                    {
                                        "out_shop_id":"234545",
                                        "shop_id":"2345"
                                    }
                                ]
                            },
                            "ext_info":"{\"giftName\":\"贝乐果棒棒糖\",\"giftGoodsSkuId\":\"12345\",\"skuOutNo\":\"123\",\"dishOutNo\":\"345\"}",
                            "use_condition":"DINE_IN"
                        }
                    ]
                }
            },
            "result_code":"0",
            "result_desc":"SUCCESS",
            "result_view":"处理成功"
        }
    }
}

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

alibaba.alsc.crm.open.customer.get (查询会员资产)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈