淘宝开放平台 - 文档中心

请求地址：

环境	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	是	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=

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

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");
AlipayOpenPublicMenuBatchqueryRequest request = new AlipayOpenPublicMenuBatchqueryRequest();
AlipayOpenPublicMenuBatchqueryResponse 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);
AlipayOpenPublicMenuBatchqueryRequest  request= new AlipayOpenPublicMenuBatchqueryRequest() ;
AlipayOpenPublicMenuBatchqueryResponse 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 AlipayOpenPublicMenuBatchqueryRequest ();
$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.menu.batchquery&app_id=3762&sign_type=RSA2&sign=ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE&version=1.0
//为确保安全通信，需自行验证响应示例中的sign值是否为蚂蚁金服所提供。

JSON示例

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

JSON示例

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

公共错误码

开放平台

生活号（原服务窗）API

alipay.open.public.menu.batchquery (菜单列表查询接口)

公共参数

请求参数

公共响应参数

响应参数

请求示例

响应示例

异常示例

公共错误码