文档中心 > API类目 > 生活号（原服务窗）API

alipay.open.public.life.label.batchquery (标签批量查询接口)

开发者可调用该接口查询自己创建的标签

公共参数

请求地址：

环境	HTTPS请求地址
正式环境	https://openapi.alipay.com/gateway.do

公共请求参数：

参数	类型	是否必填	最大长度	描述	示例值
app_id	String	是	32	支付宝分配给开发者的应用ID	2014072300007148
method	String	是	128	接口名称	alipay.open.public.life.label.batchquery
format	String	否	40	仅支持JSON	JSON
charset	String	是	10	请求使用的编码格式，如utf-8,gbk,gb2312等	utf-8
sign_type	String	是	10	商户生成签名字符串所使用的签名算法类型，目前支持RSA2和RSA，推荐使用RSA2	RSA2
sign	String	是	256	商户请求参数的签名串，详见签名	详见示例
timestamp	String	是	19	发送请求的时间，格式"yyyy-MM-dd HH:mm:ss"	2014-07-24 03:07:50
version	String	是	3	调用的接口版本，固定为：1.0	1.0
app_auth_token	String	否	40	详见应用授权概述
biz_content	String	是	-	请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档

请求参数

参数	类型	是否必填	最大长度	描述	示例值

公共响应参数

参数	类型	是否必填	最大长度	描述	示例值
code	String	是	-	网关返回码,详见文档	40004
msg	String	是	-	网关返回码描述,详见文档	Business Failed
sub_code	String	否	-	业务返回码,详见文档	ACQ.TRADE_HAS_SUCCESS
sub_msg	String	否	-	业务返回码描述,详见文档	交易已被支付
sign	String	是	-	签名,详见文档	DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo=

响应参数

参数	类型	是否必填	最大长度	描述	示例值
labels	LifeLabel []	必填	-	标签列表
└ label_id String 必填 32 标签id，唯一标识一个标签 10000 └ label_code String 必填 30 标签英文代码 pps_user_gender └ label_name String 必填 30 标签名性别 └ data_type String 必填 10 标签值数据类型 string └ operator String 选填 10 该标签支持的运算符 EQ └ category String 必填 30 标签类目基础标签 └ type String 必填 10 标签类型，目前分为common（通用标签）、custom（生活号自定义标签）、cloud（云实验室标签） common options Option [] 选填 10 每个取值的业务含义 └ text String 必填 50 文本，通常用于理解对应的取值男 └ value String 必填 50 取值，通常使用简单的数字或字符串 0 └ biz String 必填 100 该标签支持的业务列表，menu表示个性化菜单，extension表示个性化扩展区，message表示消息触达 menu,extension,message

请求示例

JAVA
.NET
PHP
HTTP请求源码

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOpenPublicLifeLabelBatchqueryRequest request = new AlipayOpenPublicLifeLabelBatchqueryRequest();
AlipayOpenPublicLifeLabelBatchqueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

IAopClient client = new DefaultAopClient("https://openapi.alipay.com/gateway.do", "app_id", "merchant_private_key", "json", "1.0", "RSA2", "alipay_public_key", "GBK", false);
AlipayOpenPublicLifeLabelBatchqueryRequest  request= new AlipayOpenPublicLifeLabelBatchqueryRequest() ;
AlipayOpenPublicLifeLabelBatchqueryResponse response=client.Execute(request);
Console.WriteLine(response.Body);

$aop = new AopClient ();
$aop->gatewayUrl = 'https://openapi.alipay.com/gateway.do';
$aop->appId = 'your app_id';
$aop->rsaPrivateKey = '请填写开发者私钥去头去尾去回车，一行字符串';
$aop->alipayrsaPublicKey='请填写支付宝公钥，一行字符串';
$aop->apiVersion = '1.0';
$aop->signType = 'RSA2';
$aop->postCharset='GBK';
$aop->format='json';
$request = new AlipayOpenPublicLifeLabelBatchqueryRequest ();
$result = $aop->execute ( $request); 

$responseNode = str_replace(".", "_", $request->getApiMethodName()) . "_response";
$resultCode = $result->$responseNode->code;
if(!empty($resultCode)&&$resultCode == 10000){
echo "成功";
} else {
echo "失败";
}

https://openapi.alipay.com/gateway.do?timestamp=2013-01-01 08:08:08&method=alipay.open.public.life.label.batchquery&app_id=4047&sign_type=RSA2&sign=ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE&version=1.0
//为确保安全通信，需自行验证响应示例中的sign值是否为蚂蚁金服所提供。

响应示例

JSON示例

{
	"alipay_open_public_life_label_batchquery_response":{
		"msg":"Success",
		"code":"10000",
		"labels":[
			{
				"biz":"menu,extension,message",
				"data_type":"string",
				"options":[
					{
						"text":"男",
						"value":"0"
					}
				],
				"category":"基础标签",
				"type":"common",
				"label_name":"性别",
				"label_id":"10000",
				"operator":"EQ",
				"label_code":"pps_user_gender"
			}
		]
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

JSON示例

{
	"alipay_open_public_life_label_batchquery_response":{
		"msg":"Service Currently Unavailable",
		"code":"20000",
		"sub_msg":"系统繁忙",
		"sub_code":"isp.unknow-error"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

错误码	错误描述	解决方案
SYSTEM_ERROR	系统繁忙	重试

公共错误码

有用(2)

我要提问

返回
顶部

生活号（原服务窗）API

alipay.open.public.life.label.batchquery (标签批量查询接口)

公共参数

请求参数

公共响应参数

响应参数

请求示例

响应示例

异常示例

业务错误码

公共错误码

用户导航

用户反馈

用户反馈

用户反馈