alipay.marketing.campaign.cash.list.query(现金活动列表查询) 在线调试(沙箱环境)

商户通过开放平台查询自己创建的现金活动列表

公共参数

请求地址

环境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 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 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

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

响应参数

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

请求示例

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("调用失败");
}

响应示例

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

异常示例

{
    "alipay_marketing_campaign_cash_list_query_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "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 产品未签约 请进行产品签约
onlineServer