alipay.marketing.cashvoucher.template.modify(修改券模板) 在线调试(沙箱环境)

在以下情况可修改模板 1. 草稿状态:所有入参都可以修改 2. 生效状态:仅可修改发布结束时间 3. 过期状态:不可修改 4. 删除状态:不可修改

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.marketing.cashvoucher.template.modify
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
slogan String 特殊可选 6 券标语,用于拼接券名称,最多6个字符,券名称=券标语+券面额+’元代金券’。仅草稿状态可修改 四川移动
publish_start_time Date 特殊可选 19 发放开始时间,早于该时间不能发券。发放开始时间不能大于当前时间15天。格式为:yyyy-MM-dd HH:mm:ss。仅草稿状态可修改。仅草稿状态可修改 2017-01-01 00:00:01
publish_end_time Date 必选 19 发放结束时间,晚于该时间不能发券。券的发放结束时间和发放开始时间跨度不能大于90天。发放结束时间必须晚于发放开始时间。格式为:yyyy-MM-dd HH:mm:ss。草稿状态和生效状态可修改 2017-01-29 23:59:59
voucher_valid_period String 特殊可选 128 券有效期。有两种类型:绝对时间和相对时间。使用JSON字符串表示。绝对时间有3个key:type、start、end,type取值固定为"ABSOLUTE",start和end分别表示券生效时间和失效时间,格式为yyyy-MM-dd HH:mm:ss。绝对时间示例:{"type": "ABSOLUTE", "start": "2017-01-10 00:00:00", "end": "2017-01-13 23:59:59"}。相对时间有3个key:type、duration、unit,type取值固定为"RELATIVE",duration表示从发券时间开始到往后推duration个单位时间为止作为券的使用有效期,unit表示有效时间单位,有效时间单位可枚举:MINUTE, HOUR, DAY。示例:{"type": "RELATIVE", "duration": 1 , "unit": "DAY" },如果此刻发券,那么该券从现在开始生效1(duration)天(unit)后失效。 {"type": "ABSOLUTE", "start": "2017-01-10 00:00:00","end": "2017-01-13 23:59:59"}
out_biz_no String 必选 32 外部业务单号,用作幂等控制,相同template_id下相同out_biz_no视为同一次修改 2017000xxx_modify

响应参数

参数 类型 是否必填 最大长度 描述 示例值
status String 必填 1 模板修改时的状态,I表示草稿状态所有入参都修改了,S表示生效状态仅修改了publish_end_time I

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMarketingCashvoucherTemplateModifyRequest request = new AlipayMarketingCashvoucherTemplateModifyRequest();
request.setBizContent("{" +
"\"template_id\":\"20140601000730010040000000EB\"," +
"\"slogan\":\"四川移动\"," +
"\"publish_start_time\":\"2017-01-01 00:00:01\"," +
"\"publish_end_time\":\"2017-01-29 23:59:59\"," +
"\"voucher_valid_period\":\"{\\\"type\\\": \\\"ABSOLUTE\\\", \\\"start\\\": \\\"2017-01-10 00:00:00\\\",\\\"end\\\": \\\"2017-01-13 23:59:59\\\"}\"," +
"\"out_biz_no\":\"2017000xxx_modify\"" +
"  }");
AlipayMarketingCashvoucherTemplateModifyResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_marketing_cashvoucher_template_modify_response": {
        "code": "10000",
        "msg": "Success",
        "status": "I"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
TEMPLATE_STATUS_NOT_MATCH 模板状态不匹配 确认为草稿或生效状态
TEMPLATE_NOT_EXIST 模板不存在 传入存在的模板ID
PERMISSION_DENIED 没有修改模板权限 只能修改自己创建模板
KEY_WORD_ILLEGAL 包含非法关键字 检查slogan是否包含非法关键字
INVALID_PARAMETER 参数有误 请检查入参是否符合接口要求
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
SYSTEM_ERROR 系统繁忙 1.发起业务重试 2.联系技术支持
onlineServer