alipay.pass.template.update(支付宝pass更新模版接口) 在线调试(沙箱环境)

对于已经创建的模板,如果需要修改模板内容,可通过该接口修改,适用于修改模板内容;对于已经发布的模板,如果需要修改内容并同步到用户端,则应使用更新卡券接口。

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
tpl_id String 可选 999 更新的模板ID f038871a4b1151e8038bb9277c3d52e3
tpl_content String 可选 99999 模板内容信息,遵循JSON规范,详情参见tpl_content参数说明:https://doc.open.alipay.com/doc2/detail.htm?treeId=193&articleId=105249&docType=1#tpl_content {"logo": "","strip": null,"icon": null,"content": {}}

响应参数

参数 类型 是否必填 最大长度 描述 示例值
success String 必填 操作成功标识【true:成功;false:失败】 true
result String 必填 5000 接口调用返回结果信息(json字串):
errorCode:处理结果码(错误码);
errorMsg:处理结果说明(错误说明);
tpl_id:模板编号,预期在调发券接口时必须传入;
tpl_params:动态参数(变量)列表,预期在调发券接口时传入;
{"errorCode":"KP.AE_SUCCESS","errorMsg":"处理成功","tpl_id":"2017032xxxxxxxx","tpl_params":["title","channelID","serialNumer"]}

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayPassTemplateUpdateRequest request = new AlipayPassTemplateUpdateRequest();
request.setBizContent("{" +
"\"tpl_id\":\"f038871a4b1151e8038bb9277c3d52e3\"," +
"\"tpl_content\":\"{\\\"logo\\\": \\\"\\\",\\\"strip\\\": null,\\\"icon\\\": null,\\\"content\\\": {}}\"" +
"  }");
AlipayPassTemplateUpdateResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_pass_template_update_response": {
        "code": "10000",
        "msg": "Success",
        "success": "true",
        "result": "{\"errorCode\":\"KP.AE_SUCCESS\",\"errorMsg\":\"处理成功\",\"tpl_id\":\"2017032xxxxxxxx\",\"tpl_params\":[\"title\",\"channelID\",\"serialNumer\"]}"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
KP.AE_SYSTEM_ERROR 系统繁忙或系统异常 尝试重试
..._TEMPLATE_PARAMTER_IS_NULL 全错误码为KP.AE_ALIPASS_TEMPLATE_PARAMTER_IS_NULL,模板参数为空 确认请求中的模板参数是否为空
...TEMPLATE_UNIQUE_ID_IS_BLANK 全错误码为KP.AE_ALIPASS_TEMPLATE_APP_ID_IS_NULL,入参app_id为空 确认参数app_id是否填入
..._TEMPLATE_CONTENT_IS_BLANK 全错误码为KP.AE_ALIPASS_TEMPLATE_CONTENT_IS_BLANK,入参tpl_content为空 确认参数tpl_content是否填入
..._TEMPLATE_UNIQUE_ID_IS_BLANK 全错误码为KP.AE_ALIPASS_TEMPLATE_UNIQUE_ID_IS_BLANK,入参unique_id为空 确认参数unique_id是否填入
..._RECOGNITION_TYPE_NOSUPPORT 全错误码为KP.AE_ALIPASS_RECOGNITION_TYPE_NOSUPPORT,发券方式不支持 确认appId已填入的前提下,尝试重试
...TEMPLATE_CONTENT_FORMAT_ERR 全错误码为KP.AE_ALIPASS_TEMPLATE_CONTENT_FORMAT_ERR,入参tpl_content格式错误 确认参数tpl_content格式是否正确
KP.AE_ALIPASS_TEMPLATE_NOT_EXIST 目标模板信息不存在 确认tpl_id传入值为预期的模板编号
KP.AE_ILLEGAL_PARAMETERS 保存模板信息时存在参数错误 确认参数是否符合文档预期,尝试重试
..._DATA_CONTAIN_FORBIDDEN_WORD 全错误码为KP.AE_ALIPASS_DATA_CONTAIN_FORBIDDEN_WORD,模板内容中存在敏感词、违禁词 去除模板内容中的敏感词、违禁词
...TEMPLATE_UNRECOGNIZE_PROPERTY 全错误码为KP.AE_ALIPASS_TEMPLATE_UNRECOGNIZE_PROPERTY,模板内容tpl_content中存在不识别的属性 核查确认入参tpl_content中的字段属性符合文档预期
onlineServer