alipay.open.public.personalized.extension.batchquery(扩展区批量查询接口) 在线调试(沙箱环境)

开发者可使用此接口批量查询个性化扩展区

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.open.public.personalized.extension.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 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
count Number 必填 10 扩展区套数 10
extensions QueryExtension 选填 扩展区信息
areas ExtensionArea[] 必填 1024 扩展区列表
name String 必填 12 扩展区名字 扩展区1号
type String 必填 10 扩展区类型,支持两个值,h5:h5类型,image:图片类型。 h5
url String 必填 1200 扩展区url,传入图片url或者h5页面url,必须是https开头的链接,如果要传入图片链接,请先调用 图片上传接口获得图片url https://www.example.com
goto_url String 可选 1200 跳转链接,当content_type为"image"时必传,必须是https或alipays开头的url链接 https://www.alipay.com
height Number 可选 12 扩展区高度,当content_type值为"h5"时必填,取值范围为200-500的整数 200
label_rules QueryLabelRule[] 必填 1024 标签规则列表
label_id String 必填 32 标签id 10000
label_name String 必填 30 标签名 职业
operator String 必填 10 运算符 EQ
label_value String 必填 120 标签值,多值会用英文逗号分隔 程序员
extension_key String 必填 64 扩展区套id 2013121100055552_7c3cb211-e239-42c0-abb0-fe80d02cfe51
status String 必填 10 扩展区状态,"ON"代表上线,"OFF"代表下线,只有上线的扩展区才能被用户看到 ON

请求示例

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

响应示例

{
    "alipay_open_public_personalized_extension_batchquery_response": {
        "code": "10000",
        "msg": "Success",
        "count": 10,
        "extensions": [
            {
                "areas": [
                    {
                        "name": "扩展区1号",
                        "type": "h5",
                        "url": "https://www.example.com",
                        "goto_url": "https://www.alipay.com",
                        "height": 200
                    }
                ],
                "label_rules": [
                    {
                        "label_id": "10000",
                        "label_name": "职业",
                        "operator": "EQ",
                        "label_value": "程序员"
                    }
                ],
                "extension_key": "2013121100055552_7c3cb211-e239-42c0-abb0-fe80d02cfe51",
                "status": "ON"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
onlineServer