alipay.open.public.template.message.add(组合消息模板领取接口) 在线调试(沙箱环境)

帮助服务窗开发者从服务窗平台(fuwu.alipay.com)公共模板库里领取一个行业的消息模板--消息模板是一种消息的样式,如消费提醒、账单提醒等,主要用于isv帮助商户领取消息模板

公共参数

请求地址

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

公共请求参数

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

请求参数

参数 类型 是否必填 最大长度 描述 示例值
lib_code String 必选 128 消息母板id,登陆生活号后台(fuwu.alipay.com),点击菜单“模板消息”,点击“模板库”,即可看到相应模板的消息母板id TMba10b7c396674479b116f955919f631c
keyword_list PublicMsgKeyword[] 必选 自行组合模板关键词列表,关键词顺序按数组顺序,关键字名称不能重复,最多支持5个,最少2个关键词组合
name String 必填 10 模板关键字名称 消息时间
opt_list PublicMsgKeyword[] 可选 可选字段的选择,开头语(name=first),结束语(name=remark)以及图片(name=image)。选择使用的话则在入参中name中标识,不选用任何可选字段可不传。
name String 必填 10 模板关键字名称 消息时间

响应参数

参数 类型 是否必填 最大长度 描述 示例值
template_id String 必填 128 模板id 7c866fab64464afaa956223c74ce6cbc
template String 选填 2048 模板消息的详细信息 {"title": "交易确认","actionUrl1": "${url}","actionName1": "${actionName}","firstValue": "${first}","key1": "交易笔数","value1": "${keyword1}","key2": "交易金额","value2": "${keyword2}"}

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayOpenPublicTemplateMessageAddRequest request = new AlipayOpenPublicTemplateMessageAddRequest();
request.setBizContent("{" +
"\"lib_code\":\"TMba10b7c396674479b116f955919f631c\"," +
"      \"keyword_list\":[{" +
"        \"name\":\"消息时间\"" +
"        }]," +
"      \"opt_list\":[{" +
"        \"name\":\"消息时间\"" +
"        }]" +
"  }");
AlipayOpenPublicTemplateMessageAddResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_open_public_template_message_add_response": {
        "code": "10000",
        "msg": "Success",
        "template_id": "7c866fab64464afaa956223c74ce6cbc",
        "template": "{\"title\": \"交易确认\",\"actionUrl1\": \"${url}\",\"actionName1\": \"${actionName}\",\"firstValue\": \"${first}\",\"key1\": \"交易笔数\",\"value1\": \"${keyword1}\",\"key2\": \"交易金额\",\"value2\": \"${keyword2}\"}"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
TEMPLATE_KEYWORDS_LIMIT_ERROR 模版的关键字段个数为2-5个 模版的关键字段个数为2-5个
TEMPLATE_OVER_LIMIT 已领取的模版不能超过50个 删除部分子版后再领取
ILLEGAL_ARGUMENT_PARAMS 无效的参数 请仔细阅读文档传参,确认入参结构是否正确,模板库code以及对应的关键字段是否存在等
TEMPLATE_LIB_NOT_EXIST 领取的模板内容不存在 确认lib_code是可用的
TEMPLATE_KEYWORD_NOT_EXIST 消息模版关键字段不存在 确认申领的关键字段是存在的
SYSTEM_ERROR 系统繁忙 请检查输入参数是否正确,或者稍后重试
onlineServer