淘宝开放平台

登录
文档中心 > API类目 > 生活号（原服务窗）API

生活号（原服务窗）API

alipay.open.public.topic.batchquery (营销位查询接口)

通过此接口,开发者可以查询已经在生活号主页配置的营销位具体信息，包括标题、描述、链接等信息。

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
topic_list Topic [] 必填 - 营销位列表
  • └ topic_id
  • String
  • 必填
  • 20
  • 营销位id
  • 123
  • └ title
  • String
  • 必填
  • 10
  • 营销位名称
  • 营销位名称
  • └ sub_title
  • String
  • 选填
  • 15
  • 营销位描述
  • 营销位描述
  • └ img_url
  • String
  • 选填
  • 255
  • 营销位图片url
  • https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx
  • └ link_url
  • String
  • 选填
  • 255
  • 营销位跳转地址，点击营销位头图跳到的链接url。
  • https://www.alipay.com
  • └ link_type
  • String
  • 选填
  • 20
  • 跳转类型，网页:HTTP、小程序:APP
  • HTTP
  • topic_items
  • TopicItem []
  • 必填
  • 10000
  • 营销位内容列表
  • └ title
  • String
  • 必填
  • 15
  • 内容标题
  • 内容标题
  • └ sub_title
  • String
  • 必填
  • 8
  • 内容说明
  • 内容说明
  • └ img_url
  • String
  • 必填
  • 255
  • 内容图片url, 尺寸为300*300，最大不超过3M，支持格式:.jpg、.png ，请先调用 图片上传接口获得图片url
  • https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx
  • └ link_url
  • String
  • 必填
  • 255
  • 跳转链接，点击营销位内容图片跳到的链接url
  • https://www.alipay.com
  • └ link_type
  • String
  • 选填
  • 20
  • 跳转类型，网页:HTTP、小程序:APP，不传默认HTTP
  • HTTP

请求示例

  • 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");
AlipayOpenPublicTopicBatchqueryRequest request = new AlipayOpenPublicTopicBatchqueryRequest();
AlipayOpenPublicTopicBatchqueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE",
	"alipay_open_public_topic_batchquery_response":{
		"msg":"Success",
		"code":"10000",
		"topic_list":[
			{
				"link_type":"HTTP",
				"sub_title":"营销位描述",
				"img_url":"https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx",
				"topic_items":[
					{
						"link_type":"HTTP",
						"sub_title":"内容说明",
						"img_url":"https://oalipay-dl-django.alicdn.com/rest/1.0/image?fileIds=xxx&zoom=xxx",
						"link_url":"https://www.alipay.com",
						"title":"内容标题"
					}
				],
				"link_url":"https://www.alipay.com",
				"topic_id":"123",
				"title":"营销位名称"
			}
		]
	}
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
SYSTEM_ERROR 系统繁忙 请检查输入参数是否正确，或者稍后重试
BUSINESS_ERROR 系统业务处理错误 请检查输入参数是否正确，或者稍后重试

公共错误码

公共错误码
有用(0)
我要提问
返回
顶部