alipay.marketing.voucher.templatelist.query (查询券模板列表)

分页查询当前PID下的所有模板

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
create_start_time Date 必须 19 模板创建开始时间,格式为:yyyy-MM-dd HH:mm:ss 2017-01-01 00:00:01
create_end_time Date 必须 19 模板创建结束时间,格式为:yyyy-MM-dd HH:mm:ss 2017-01-29 23:59:59
page_num Number 必须 10 页码,必须为大于0的整数, 1表示第一页,2表示第2页,依次类推。 1
page_size Number 必须 2 每页记录条数,必须为大于0的整数,最大值为30 20

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
total_pages Number 必填 10 总页数 20
current_page Number 必填 10 当前页码,页码从1开始 3
items_per_page Number 必填 10 每页条数 15
total_items Number 必填 10 总条数 298
voucher_templates VoucherTemplateLiteInfo [] 选填 - 券模板列表
  • └ template_id
  • String
  • 必填
  • 32
  • 券模板ID
  • 20140601000730010040000000EB
  • └ voucher_name
  • String
  • 必填
  • 32
  • 券名称
  • 四川移动5元代金券
  • └ publish_start_time
  • Date
  • 必填
  • 19
  • 券模板发放开始时间。格式为:yyyy-MM-dd HH:mm:ss
  • 2017-01-01 00:00:01
  • └ publish_end_time
  • Date
  • 必填
  • 19
  • 发放结束时间。格式为:yyyy-MM-dd HH:mm:ss
  • 2017-01-29 23:59:59
  • └ status
  • String
  • 必填
  • 1
  • 模板状态,可枚举。分别为‘草稿’(I)、‘生效’(S)和‘过期’(E)
  • S
  • └ create_time
  • Date
  • 必填
  • 19
  • 模板创建时间。格式为:yyyy-MM-dd HH:mm:ss
  • 2017-01-29 23:59:59
  • └ activate_time
  • Date
  • 选填
  • 19
  • 模板激活时间。草稿状态的模板该项为空
  • 2017-01-01-12:00:00

请求示例

  • 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");
AlipayMarketingVoucherTemplatelistQueryRequest request = new AlipayMarketingVoucherTemplatelistQueryRequest();
request.setBizContent("{" +
"\"create_start_time\":\"2017-01-0100:00:01\"," +
"\"create_end_time\":\"2017-01-2923:59:59\"," +
"\"page_num\":1," +
"\"page_size\":20" +
"}");
AlipayMarketingVoucherTemplatelistQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_marketing_voucher_templatelist_query_response":{
		"msg":"Success",
		"items_per_page":15,
		"code":"10000",
		"voucher_templates":[
			{
				"create_time":"2017-01-29 23:59:59",
				"voucher_name":"四川移动5元代金券",
				"publish_end_time":"2017-01-29 23:59:59",
				"template_id":"20140601000730010040000000EB",
				"activate_time":"2017-01-01-12:00:00",
				"publish_start_time":"2017-01-01 00:00:01",
				"status":"S"
			}
		],
		"total_pages":20,
		"total_items":298,
		"current_page":3
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
INVALID_PARAMETER 参数有误 检查请求参数格式与接口文档是否匹配
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持

公共错误码

返回
顶部