templateMessage.getTemplateList

本接口应在服务器端调用,详细说明参见服务端API

本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载),wx-server-sdk >= 0.4.0

组合模板并添加至帐号下的个人模板库(请注意,小程序模板消息接口将于2020年1月10日下线,开发者可使用订阅消息功能

调用方式:

HTTPS 调用

请求地址

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

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证
offsetnumber用于分页,表示从offset开始。从 0 开始计数。
countnumber用于分页,表示拉取count条记录。最大为 20。最后一页的list长度可能小于请求的count。

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息
listArray.<Object>

list 的结构

属性类型说明
template_idstring添加至帐号下的模板id,发送小程序模板消息时所需
titlestring模板标题
contentstring模板内容
examplestring模板内容示例

请求数据示例

  1. {
  2. "offset": 0,
  3. "count": 1
  4. }

返回数据示例

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

云调用

云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

接口方法

  1. openapi.templateMessage.getTemplateList

需在 config.json 中配置 templateMessage.getTemplateList API 的权限,详情

请求参数

属性类型默认值必填说明
offsetnumber用于分页,表示从offset开始。从 0 开始计数。
countnumber用于分页,表示拉取count条记录。最大为 20。最后一页的list长度可能小于请求的count。

返回值

Object

返回的 JSON 数据包

属性类型说明
errCodenumber错误码
errMsgstring错误信息
listArray.<Object>

list 的结构

属性类型说明
templateIdstring添加至帐号下的模板id,发送小程序模板消息时所需
titlestring模板标题
contentstring模板内容
examplestring模板内容示例

异常

Object

抛出的异常

属性类型说明
errCodenumber错误码
errMsgstring错误信息

errCode 的合法值

说明最低版本

请求数据示例

  1. const cloud = require('wx-server-sdk')
  2. cloud.init()
  3. exports.main = async (event, context) => {
  4. try {
  5. const result = await cloud.openapi.templateMessage.getTemplateList({
  6. offset: 0,
  7. count: 1
  8. })
  9. console.log(result)
  10. return result
  11. } catch (err) {
  12. console.log(err)
  13. return err
  14. }
  15. }

返回数据示例

  1. {
  2. "errCode": 0,
  3. "errMsg": "openapi.templateMessage.getTemplateList:ok",
  4. "list": [
  5. {
  6. "title": "购买成功通知",
  7. "content": "购买地点{{keyword1.DATA}}\n购买时间{{keyword2.DATA}}\n物品名称{{keyword3.DATA}}\n",
  8. "example": "购买地点:TIT造舰厂\n购买时间:2016年6月6日\n物品名称:咖啡\n",
  9. "templateId": "wDYzYZVxobJivW9oMpSCpuvACOfJXQIoKUm0PY397Tc"
  10. }
  11. ]
  12. }