微信小程序API 模板消息

网络 JavaScript

本文整理自网络，侵删。

基于微信的通知渠道，我们为开发者提供了可以高效触达用户的模板消息能力，以便实现服务的闭环并提供更佳的体验。

模板推送位置：服务通知

模板下发条件：用户本人在微信体系内与页面有交互行为后触发，详见下发条件说明

模板跳转能力：点击查看详情仅能跳转下发模板的该帐号的各个页面

使用说明

步骤一：获取模板ID

有两个方法可以获取模版ID

  1. 通过模版消息管理接口获取模版ID（详见模版消息管理）
  2. 在微信公众平台手动配置获取模版ID

?登录https://mp.weixin.qq.com获取模板，如果没有合适的模板，可以申请添加新模板，审核通过后可使用，详见模板审核说明


步骤二：页面的<form/>组件，属性report-submit为true时，可以声明为需发模板消息，此时点击按钮提交表单可以获取formId，用于发送模板消息。或者当用户完成支付行为，可以获取prepay_id用于发送模板消息。

步骤三：调用接口下发模板消息（详见发送模板消息）


模版消息管理

1.获取小程序模板库标题列表

接口地址

https://api.weixin.qq.com/cgi-bin/wxopen/template/library/list?access_token=ACCESS_TOKEN

HTTP请求方式：

POST

POST参数说明：

参数必填说明
access_token是接口调用凭证
offset是offset和count用于分页，表示从offset开始，拉取count条记录，offset从0开始，count最大为20。
count是offset和count用于分页，表示从offset开始，拉取count条记录，offset从0开始，count最大为20。

示例：

{
"offset":0,
"count":5
}

返回码说明：

在调用模板消息接口后，会返回JSON数据包。

正常时的返回JSON数据包示例：

{
"errcode":0,
"errmsg":"ok",
"list":[
{"id":"AT0002","title":"购买成功通知"},
{"id":"AT0003","title":"购买失败通知"},
{"id":"AT0004","title":"交易提醒"},
{"id":"AT0005","title":"付款成功通知"},
{"id":"AT0006","title":"付款失败通知"}
],
"total_count":599
}

返回参数说明：

参数说明
id模板标题id（获取模板标题下的关键词库时需要）
title模板标题内容
total_count模板库标题总数

2.获取模板库某个模板标题下关键词库

接口地址

https://api.weixin.qq.com/cgi-bin/wxopen/template/library/get?access_token=ACCESS_TOKEN

HTTP请求方式：

POST

POST参数说明：

参数必填说明
access_token是接口调用凭证
id是模板标题id，可通过接口获取，也可登录小程序后台查看获取

示例：

{
"id":"AT0002"
}

返回码说明：

在调用模板消息接口后，会返回JSON数据包。

正常时的返回JSON数据包示例：

{
    "errcode": 0,
    "errmsg": "ok",
    "id": "AT0002",
    "title": "购买成功通知",
    "keyword_list": [
        {
            "keyword_id": 3,
            "name": "购买地点",
            "example": "TIT造舰厂"
        },
        {
            "keyword_id": 4,
            "name": "购买时间",
            "example": "2016年6月6日"
        },
        {
            "keyword_id": 5,
            "name": "物品名称",
            "example": "咖啡"
        }
    ]
}

返回参数说明：

参数说明
keyword_id关键词id，添加模板时需要
name关键词内容
example关键词内容对应的示例

3.组合模板并添加至帐号下的个人模板库

接口地址

https://api.weixin.qq.com/cgi-bin/wxopen/template/add?access_token=ACCESS_TOKEN

HTTP请求方式：

POST

POST参数说明：

参数必填说明
access_token是接口调用凭证
id是模板标题id，可通过接口获取，也可登录小程序后台查看获取
keyword_id_list是开发者自行组合好的模板关键词列表，关键词顺序可以自由搭配（例如[3,5,4]或[4,5,3]），最多支持10个关键词组合

示例：

{
"id":"AT0002", 
"keyword_id_list":[3,4,5] 
}

返回码说明：

在调用模板消息接口后，会返回JSON数据包。

正常时的返回JSON数据包示例：

{
"errcode": 0,
"errmsg": "ok",
"template_id": "wDYzYZVxobJivW9oMpSCpuvACOfJXQIoKUm0PY397Tc"
}

返回参数说明：

参数说明
template_id添加至帐号下的模板id，发送小程序模板消息时所需

4.获取帐号下已存在的模板列表

接口地址

https://api.weixin.qq.com/cgi-bin/wxopen/template/list?access_token=ACCESS_TOKEN

HTTP请求方式：

POST

POST参数说明：

参数必填说明
access_token是接口调用凭证
offset是offset和count用于分页，表示从offset开始，拉取count条记录，offset从0开始，count最大为20。最后一页的list长度可能小于请求的count
count是offset和count用于分页，表示从offset开始，拉取count条记录，offset从0开始，count最大为20。最后一页的list长度可能小于请求的count

示例：

{
"offset":0,
"count":1
}

返回码说明：

在调用模板消息接口后，会返回JSON数据包。

正常时的返回JSON数据包示例：

{
"errcode": 0,
"errmsg": "ok",
"list": [
        {
            "template_id": "wDYzYZVxobJivW9oMpSCpuvACOfJXQIoKUm0PY397Tc",
            "title": "购买成功通知",
            "content": "购买地点{{keyword1.DATA}}\n购买时间{{keyword2.DATA}}\n物品名称{{keyword3.DATA}}\n",
            "example": "购买地点：TIT造舰厂\n购买时间：2016年6月6日\n物品名称：咖啡\n"
        }
    ]
}

返回参数说明：

参数说明
list帐号下的模板列表
template_id添加至帐号下的模板id，发送小程序模板消息时所需
title模板标题
content模板内容
example模板内容示例

5.删除帐号下的某个模板

接口地址

https://api.weixin.qq.com/cgi-bin/wxopen/template/del?access_token=ACCESS_TOKEN

HTTP请求方式：

POST

POST参数说明：

参数必填说明
access_token是接口调用凭证
template_id是要删除的模板id

示例：

{
"template_id":"wDYzYZVxobJivW9oMpSCpuvACOfJXQIoKUm0PY397Tc"
}

返回码说明：

在调用模板消息接口后，会返回JSON数据包。

正常时的返回JSON数据包示例：

{
"errcode": 0,
"errmsg": "ok"
}


发送模板消息

1. 获取access_token

access_token是全局唯一接口调用凭据，开发者调用各接口时都需使用access_token，请妥善保存。access_token的存储至少要保留512个字符空间。access_token的有效期目前为2个小时，需定时刷新，重复获取将导致上次获取的access_token失效。

阅读剩余部分

相关阅读 >>

微信小程序api 音频-暂停播放

微信小程序api 用户数据的签名验证和加解密

微信小程序 delete

微信小程序api 创建插屏广告组件

微信小程序云开发api 在集合上新增记录

sdk数据库 database创建集合

微信小程序 工具库类小程序瘦身工具

微信小程序 即时配送接口(商家查看)-概述

微信小程序api 关闭当前页面

微信小程序内容组件 progress

更多相关阅读请进入《微信小程序》频道 >>




标签：

打赏

取消

感谢您的支持，我会继续努力的!

扫码支持
扫码打赏，您说多少就多少

打开支付宝扫一扫，即可进行扫码打赏哦

分享从这里开始，精彩与您同在

相关推荐

评论

管理员已关闭评论功能...