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

alipay.open.public.user.data.batchquery (用户分析数据查询接口)

通过此接口,开发者可以根据时间查询30天内的关注用户人数、取消关注用户人数、净增关注人数、累计关注人数信息

公共参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
begin_date String 必须 8 开始日期 20171101
end_date String 必须 8 结束日期,开始日期/结束日期时间跨度最大30天 20171108

公共响应参数

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

响应参数

参数 类型 是否必填 最大长度 描述 示例值
data_list UserAnalysisData [] 选填 - 用户分析数据
  • └ date
  • String
  • 必填
  • 8
  • 日期
  • 20171101
  • └ new_user_cnt
  • String
  • 必填
  • 21
  • 新关注人数
  • 30
  • └ cancel_user_cnt
  • String
  • 必填
  • 21
  • 取消关注人数
  • 40
  • └ grow_user_cnt
  • String
  • 必填
  • 21
  • 净增关注人数
  • 20
  • └ cumulate_user_cnt
  • String
  • 必填
  • 21
  • 累积关注人数
  • 60

请求示例

  • 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");
AlipayOpenPublicUserDataBatchqueryRequest request = new AlipayOpenPublicUserDataBatchqueryRequest();
request.setBizContent("{" +
"\"begin_date\":\"20171101\"," +
"\"end_date\":\"20171108\"" +
"  }");
AlipayOpenPublicUserDataBatchqueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

  • JSON示例
{
	"alipay_open_public_user_data_batchquery_response":{
		"msg":"Success",
		"data_list":[
			{
				"date":"20171101",
				"grow_user_cnt":"20",
				"cumulate_user_cnt":"60",
				"cancel_user_cnt":"40",
				"new_user_cnt":"30"
			}
		],
		"code":"10000"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

错误码 错误描述 解决方案
ILLEGAL_BIZ_PARAMS 无效的业务参数 检查业务参数是否合法
SYSTEM_ERROR 系统繁忙 请检查输入参数是否正确,或者稍后重试
BUSINESS_ERROR 系统业务处理错误 请检查输入参数是否正确,或者稍后重试
QUERY_DATE_INVALID 查询时间参数不合法 请检查开始日期、结束日期是否合法,是否超过最大30天的跨度

公共错误码

返回
顶部