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 344 商户请求参数的签名串,详见签名 详见示例
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 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
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

请求示例

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("调用失败");
}

响应示例

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

异常示例

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

业务错误码

公共错误码

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