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

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

公共参数

请求地址

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

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.open.public.template.message.get
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 必选 20 消息母板id,登陆生活号后台(fuwu.alipay.com),点击菜单“模板消息”,点击“模板库”,即可看到相应模板的消息母板id TM000000223

响应参数

参数 类型 是否必填 最大长度 描述 示例值
msg_template_id String 必填 60 消息模板id--商户领取母版后生成的唯一模板id 14330d60f0ab4516853a0900827cee35
template String 必填 1024 模板内容 {"appId":"${ALIPAY.appId}","createTime":${ALIPAY.createTime},"toUserId":"${ALIPAY.toUserId}","msgType":"text","push":"true"}

请求示例

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

响应示例

{
    "alipay_open_public_template_message_get_response": {
        "code": "10000",
        "msg": "Success",
        "msg_template_id": "14330d60f0ab4516853a0900827cee35",
        "template": "{\"appId\":\"${ALIPAY.appId}\",\"createTime\":${ALIPAY.createTime},\"toUserId\":\"${ALIPAY.toUserId}\",\"msgType\":\"text\",\"push\":\"true\"}"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

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

业务错误码

公共错误码

错误码错误描述解决方案
TEMPLATE_MESSAGE_ID_INVAILD 模板消息id不合法 模板消息id不合法或者该模板所属行业不是服务窗选择的行业
BUSINESS_ERROR 系统业务处理错误 系统业务处理错误,请重试
ILLEGAL_BIZ_PARAMS 无效的业务参数 校验业务参数,修改后再请求
APPINFO_NOT_EXIST 公众账号信息不存在 公众账号信息不存在
PUBLIC_NOT_ONLINE 该服务窗已下线无法提供服务 该服务窗已下线无法提供服务
NEED_SELECT_INDUSTRY 服务窗需要先选择消息模板行业 服务窗需要先选择消息模板行业
EXCEED_MAX_TEMPLATE_NUM 服务窗已达到最大模板领取个数,无法继续领取 消息模板领取个数最多为50个,请先删除再添加
onlineServer