alipay.open.public.menu.batchquery(菜单列表查询接口) 在线调试(沙箱环境)

开发者可调用该接口查询自己创建的菜单列表

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.open.public.menu.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 String 必填 10 菜单数量,包括默认菜单和个性化菜单 5
menus QueryMenu 必填 菜单列表
button ButtonObject[] 必填 10 一级菜单列表
name String 必填 12 菜单名称,icon菜单名称不超过5个汉字,文本菜单名称不超过9个汉字,编码格式为GBK 最新优惠
action_type String 特殊可选 12 菜单类型:
out——事件型菜单;
link——链接型菜单;
tel——点击拨打电话;
map——点击查看地图;
consumption——点击查看用户与生活号管理员账号之间的消费记录
link
action_param String 特殊可选 256 当actionType为link时,该参数为url链接;
当actionType为out时,该参数为用户自定义参数;
当actionType为tel时,该参数为电话号码。
当action_type为map时,该参数为查看地图的关键字。
当action_type为consumption时,该参数可不传。
该参数最长255个字符,不允许冒号等特殊字符。
http://m.alipay.com
icon String 特殊可选 64 icon图片url,必须是http协议的url,尺寸为60X60,最大不超过5M,请先调用 图片上传接口获得图片url http://xxxx/test.jpg
sub_button SubButton[] 特殊可选 4096 二级菜单数组,若sub_button为空,则一级菜单必须指定action_type和action_param的值,二级菜单个数可以为1~5个。
name String 必填 12 菜单名称,icon菜单名称不超过5个汉字,文本菜单名称不超过9个汉字,编码格式为GBK 流量查询
action_type String 必填 12 菜单类型:
out——事件型菜单;
link——链接型菜单;
tel——点击拨打电话;
map——点击查看地图;
consumption——点击查看用户与生活号管理员账号之间的消费记录
link
action_param String 必填 256 当actionType为link时,该参数为url链接;
当actionType为out时,该参数为用户自定义参数;
当actionType为tel时,该参数为电话号码。
当action_type为map时,该参数为查看地图的关键字。
当action_type为consumption时,该参数可不传。
该参数最长255个字符,不允许冒号等特殊字符。
http://m.alipay.com
icon String 可选 64 icon图片url,必须是http协议的url,尺寸为60X60,最大不超过5M,请先调用 图片上传接口获得图片url http://example.com/test.jpg
menu_key String 必填 30 菜单唯一id default
label_rule QueryLabelRule[] 必填 10 标签规则项列表
label_id String 必填 32 标签id 10000
label_name String 必填 30 标签名 职业
operator String 必填 10 运算符 EQ
label_value String 必填 120 标签值,多值会用英文逗号分隔 程序员
type String 必填 10 菜单类型,icon:icon型菜单,text:文本型菜单 icon

请求示例

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

响应示例

{
    "alipay_open_public_menu_batchquery_response": {
        "code": "10000",
        "msg": "Success",
        "count": "5",
        "menus": [
            {
                "button": [
                    {
                        "name": "最新优惠",
                        "action_type": "link",
                        "action_param": "http://m.alipay.com",
                        "icon": "http://xxxx/test.jpg",
                        "sub_button": [
                            {
                                "name": "流量查询",
                                "action_type": "link",
                                "action_param": "http://m.alipay.com",
                                "icon": "http://example.com/test.jpg"
                            }
                        ]
                    }
                ],
                "menu_key": "default",
                "label_rule": [
                    {
                        "label_id": "10000",
                        "label_name": "职业",
                        "operator": "EQ",
                        "label_value": "程序员"
                    }
                ],
                "type": "icon"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

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