alipay.marketing.tool.fengdie.template.query (查询当前用户可用的模板列表)

查询可用的模板列表,展示给用户,让用户来选择模板。

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
page_number Number 可选 10 当前页数,默认为1 1
page_size Number 可选 2 每页记录数,不能超过50,默认为10 10

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
template FengdieTemplate [] 必填 - 开发者开发上传的H5模板列表
  • └ id
  • Number
  • 必填
  • 11
  • 模板包唯一id,上传模板时自动生成
  • 10010
  • └ name
  • String
  • 必填
  • 100
  • 模板包名称,开发模板时由开发者在package.json里指定
  • text
  • └ title
  • String
  • 必填
  • 100
  • 模板包中文标题,开发者在fengdie.config.js里指定
  • 纯文字模板
  • └ summary
  • String
  • 选填
  • 500
  • 模板包描述,开发者在package.json里指定
  • 适合展示大段的文字,可以修改字号、颜色、链接等
  • └ snapshot
  • String
  • 必填
  • 500
  • 模板包预览图,开发者在模板根目录放置的一张命名为snapshot.png的图片
  • https://zos.alipayobjects.com/rmsportal/oTXVNqguQzKpNWqqUCcX.png
  • └ maintainer
  • String []
  • 必填
  • 20
  • 模板包开发者,由开发者在package.json中指定
  • 疯狂的小蚂蚁

请求示例

  • 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");
AlipayMarketingToolFengdieTemplateQueryRequest request = new AlipayMarketingToolFengdieTemplateQueryRequest();
request.setBizContent("{" +
"\"page_number\":1," +
"\"page_size\":10" +
"  }");
AlipayMarketingToolFengdieTemplateQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_marketing_tool_fengdie_template_query_response":{
		"msg":"Success",
		"template":[
			{
				"summary":"适合展示大段的文字,可以修改字号、颜色、链接等",
				"name":"text",
				"id":10010,
				"title":"纯文字模板",
				"snapshot":"https://zos.alipayobjects.com/rmsportal/oTXVNqguQzKpNWqqUCcX.png",
				"maintainer":[
					"疯狂的小蚂蚁"
				]
			}
		],
		"code":"10000"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

公共错误码

返回
顶部