文档中心 > API类目 > 生活号(原服务窗)API

alipay.open.public.menu.create (默认菜单创建接口)

创建菜单

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
button ButtonObject [] 特殊可选 - 一级菜单列表。最多有4个一级菜单,若开发者在后台打开了"咨询反馈"的开关,则只能有3个一级菜单.
  • └ 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
type String 可选 10 菜单类型,支持值为icon:icon型菜单,text:文本型菜单,不传时默认为"text",当传值为"icon"时,菜单节点的icon字段必传。 icon

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
menu_key String 必填 32 默认菜单菜单key,文本菜单为“default”,icon菜单为“iconDefault” default

请求示例

  • 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");
AlipayOpenPublicMenuCreateRequest request = new AlipayOpenPublicMenuCreateRequest();
request.setBizContent("{" +
"      \"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\"" +
"            }]" +
"        }]," +
"\"type\":\"icon\"" +
"  }");
AlipayOpenPublicMenuCreateResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_open_public_menu_create_response":{
		"msg":"Success",
		"code":"10000",
		"menu_key":"default"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
ILLEGAL_BIZ_PARAMS 无效的业务参数 请输入正确的业务参数
BUTTON_IS_EMPTY 菜单为空 菜单不能为空
ICON_IS_EMPTY icon字段为空 当type为“icon”时,icon字段不能为空
ICON_IS_INVALID icon图片不合法 icon图片url不合法,必须是http协议的url,尺寸为60X60,最大不超过5M
ILLEGAL_ARGUMENT_PARAMS 无效的参数 请输入正确的参数
BUSINESS_ERROR 系统业务处理错误 请检查业务参数是否正确
SYSTEM_ERROR 系统繁忙 请检查输入参数是否正确,或者稍后重试
MENU_FORMAT_ERROR 菜单解析格式错误 请检查输入参数是否正确
ICON_SIZE_ERROR icon图片尺寸不合法 icon图片必须为60x60
MENU_CHAT_NUMBER_LIMIT 使用聊天功能时,一级菜单最多不能超过3个 请保证使用聊天功能时,一级菜单不能超过3个
BUTTON_COUNT_LIMIT 一级菜单超出个数 最多只能有4个一级菜单,若咨询反馈开关打开了,最多只能有3个一级菜单
MENU_TITLE_EMPTY 菜单标题为空 菜单标题不能为空
ICON_TOO_LARGE icon图片过大 icon图片过大,最大不能超过5M
MENU_TITLE_OUT_OF_LENGTH 菜单标题长度超限 菜单标题长度超限,ICON菜单标题不能超过5个汉字,文本菜单标题不能超过9个汉字,编码格式为GBK
ICON_TYPE_INVALID icon图片类型不合法 icon图片格式只支持jpg和png
MENU_TYPE_NOTFOUND 菜单type不在支持范围内 请选择支持的菜单类型
ACTION_PARAM_IS_EMPTY 菜单参数值为空 除CONSUMPTION类型外的其他菜单,action_param不能为空
MENU_AUTH_NOT_ILLEGAL 菜单authType非法 请设置合法的authType, loginAuth, link
MENU_SECURITY_FORBID 菜单中含有非法字符或链接 菜单中含有非法字符或链接,请检查
MENU_SUB_OUT_OF_NUM 二级菜单超出个数 二级菜单不能超过5个

公共错误码

返回
顶部