文档中心 > API类目 > 小程序API

alipay.open.mini.template.usage.query (查询使用模板的小程序列表)

查询使用模板的小程序列表

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
template_id String 必须 32 模板id 1
page_num Number 可选 16 查询的页数,默认第一页 1
page_size Number 可选 16 每页的数量,最多查询50个,默认查询10个 10
template_version String 可选 64 模板小程序的版本号 0.0.1

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
app_ids String [] 必填 1024 小程序appId列表 208812345678

请求示例

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

响应示例

  • JSON示例
{
	"alipay_open_mini_template_usage_query_response":{
		"msg":"Success",
		"code":"10000",
		"app_ids":[
			"208812345678"
		]
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
SYSTEM_ERROR 系统繁忙 请稍后重试,或者联系技术人员解决
INVALID_PAGE_NUM 非法的页码 请输入合法的页码,是个正数
INVALID_PAGE_SIZE 非法的页面大小 请输入合法的页面大小,是个正数
PAGE_SIZE_EXCEED_MAX_QUERY_SIZE 页面大小超出最大的查询数量 一次性最多查询50个
APPLICATION_TYPE_NOT_ISVAPP 该应用不是三方类型的应用 请使用三方类型的应用
TEMPLATE_ID_IS_BLANK 模板id为空 请输入模板id
ISV_APP_ID_IS_BLANK 三方应用id不存在 该接口需要带应用授权token来调用

公共错误码

返回
顶部