alipay.marketing.voucher.list.query(查询券列表) 在线调试(沙箱环境)

查询当前PID创建的某个模板给某用户发送的所有的券

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
template_id String 必选 32 券模板ID 20140601000730010040000000EB
user_id String 必选 20 支付宝用户ID 2088512417841101

响应参数

参数 类型 是否必填 最大长度 描述 示例值
vouchers VoucherLiteInfo 必填 券列表,一定不为null,但是size可以为0
template_id String 必填 32 券模板ID 20140601000730010040000000EB
voucher_id String 必填 32 券ID 20160906000730020020002U8CBS
status String 必填 16 券状态,可枚举,分别为“可用”(ENABLED)和“不可用”(DISABLED) ENABLED
send_time Date 必填 19 发券时间,格式为:yyyy-MM-dd HH:mm:ss 2017-01-01 00:00:01

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMarketingVoucherListQueryRequest request = new AlipayMarketingVoucherListQueryRequest();
request.setBizContent("{" +
"\"template_id\":\"20140601000730010040000000EB\"," +
"\"user_id\":\"2088512417841101\"" +
"}");
AlipayMarketingVoucherListQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_marketing_voucher_list_query_response": {
        "code": "10000",
        "msg": "Success",
        "vouchers": [
            {
                "template_id": "20140601000730010040000000EB",
                "voucher_id": "20160906000730020020002U8CBS",
                "status": "ENABLED",
                "send_time": "2017-01-01 00:00:01"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
TEMPLATE_STATUS_NOT_MATCH 模板尚未生效 先激活模板在发券
PERMISSION_DENIED 没有查询模板的券列表权限 只允许查询自己创建的模板券列表
INVALID_PARAMETER 参数有误 检查请求参数格式与接口文档是否匹配
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
onlineServer