淘宝开放平台

请求地址：

环境	HTTPS请求地址
正式环境	https://openapi.alipay.com/gateway.do

公共请求参数：

参数	类型	是否必填	最大长度	描述	示例值
app_id	String	是	32	支付宝分配给开发者的应用ID	2014072300007148
method	String	是	128	接口名称	alipay.marketing.campaign.cash.list.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	是	-	请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递，具体参照各产品快速接入文档

参数	类型	是否必填	最大长度	描述	示例值
camp_status	String	可选	10	要查询的活动状态,不填默认返回所有类型。可填: ALL:所有类型的活动 CREATED: 已创建未打款 PAID:已打款 READY:活动已开始 PAUSE:活动已暂停 CLOSED:活动已结束 SETTLE:活动已清算	PAID
page_size	String	必须	2	分页查询时每页返回的列表大小,最大为50	10
page_index	String	必须	4	分页查询时的页码，从1开始	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=

参数	类型	是否必填	最大长度	描述	示例值
page_size	String	必填	6	分页每页大小	10
camp_list	CashCampaignInfo []	必填	-	活动列表
└ crowd_no String 必填 128 现金红包活动号 EPOJZsBg3A-CZOJE4qlbAueA7By4oJLDwEeYZlAiAnbMnSZ96O-zxUfKlHp5cxmx └ origin_crowd_no String 必填 64 原始活动号,商户进行问题排查时提供 20160901109410190092922300444004 └ camp_status String 必填 10 活动状态 READY └ coupon_name String 必填 64 现金红包名称 XXX周年庆红包
page_index	String	必填	6	分页的页码,起始从1开始	1
total_size	String	必填	6	活动总个数	20

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

IAopClient client = new DefaultAopClient("https://openapi.alipay.com/gateway.do", "app_id", "merchant_private_key", "json", "1.0", "RSA2", "alipay_public_key", "GBK", false);
AlipayMarketingCampaignCashListQueryRequest  request= new AlipayMarketingCampaignCashListQueryRequest() ;
request.BizContent="{" +
"\"camp_status\":\"PAID\"," +
"\"page_size\":\"10\"," +
"\"page_index\":\"1\"" +
"  }";
AlipayMarketingCampaignCashListQueryResponse response=client.Execute(request);
Console.WriteLine(response.Body);

$aop = new AopClient ();
$aop->gatewayUrl = 'https://openapi.alipay.com/gateway.do';
$aop->appId = 'your app_id';
$aop->rsaPrivateKey = '请填写开发者私钥去头去尾去回车，一行字符串';
$aop->alipayrsaPublicKey='请填写支付宝公钥，一行字符串';
$aop->apiVersion = '1.0';
$aop->signType = 'RSA2';
$aop->postCharset='GBK';
$aop->format='json';
$request = new AlipayMarketingCampaignCashListQueryRequest ();
$request->setBizContent("{" .
"\"camp_status\":\"PAID\"," .
"\"page_size\":\"10\"," .
"\"page_index\":\"1\"" .
"  }");
$result = $aop->execute ( $request); 

$responseNode = str_replace(".", "_", $request->getApiMethodName()) . "_response";
$resultCode = $result->$responseNode->code;
if(!empty($resultCode)&&$resultCode == 10000){
echo "成功";
} else {
echo "失败";
}

https://openapi.alipay.com/gateway.do?timestamp=2013-01-01 08:08:08&method=alipay.marketing.campaign.cash.list.query&app_id=2611&sign_type=RSA2&sign=ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE&version=1.0&biz_content=
  {
"camp_status":"PAID",
"page_size":"10",
"page_index":"1"
  }

//为确保安全通信，需自行验证响应示例中的sign值是否为蚂蚁金服所提供。

JSON示例

{
	"alipay_marketing_campaign_cash_list_query_response":{
		"msg":"Success",
		"camp_list":[
			{
				"crowd_no":"EPOJZsBg3A-CZOJE4qlbAueA7By4oJLDwEeYZlAiAnbMnSZ96O-zxUfKlHp5cxmx",
				"origin_crowd_no":"20160901109410190092922300444004",
				"camp_status":"READY",
				"coupon_name":"XXX周年庆红包"
			}
		],
		"code":"10000",
		"page_index":"1",
		"total_size":"20",
		"page_size":"10"
	},
	"sign":"ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

JSON示例

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

错误码	错误描述	解决方案
BIZ_CONTENT_IS_EMPTY	入参不合法，biz_content字段为空	在请求体中填充biz_content字段
CASH_LIST_PAGE_CHECK_FAILED	现金红包参数校验失败,列表查询分页条件不对	页码page_index必须为大于0的整数,每页数据page_size最多50条
BIZ_CONTENT_FORMAT_ERROR	入参不合法，biz_content字段格式错误	修改biz_content字段格式，符合json的格式
CALL_TOO_FREQUENCY	调用过于频繁	请不要调用过于频繁
PRODUCT_IS_NOT_OPENED	产品未签约	请进行产品签约

公共错误码

营销API

alipay.marketing.campaign.cash.list.query (现金活动列表查询)

公共参数

请求参数

公共响应参数

响应参数

请求示例

响应示例

异常示例

业务错误码

公共错误码