templateMessage.getTemplateList
- HTTPS 调用
- 云调用

templateMessage.getTemplateList

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

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

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

调用方式：

HTTPS 调用

请求地址

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

请求参数

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

返回值

Object

返回的 JSON 数据包

属性	类型	说明
errcode	number	错误码
errmsg	string	错误信息
list	Array.<Object>

list 的结构

属性	类型	说明
template_id	string	添加至帐号下的模板id，发送小程序模板消息时所需
title	string	模板标题
content	string	模板内容
example	string	模板内容示例

请求数据示例

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

返回数据示例

{
  "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"
    }
  ]
}

云调用

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

接口方法

openapi.templateMessage.getTemplateList

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

请求参数

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

返回值

Object

返回的 JSON 数据包

属性	类型	说明
errCode	number	错误码
errMsg	string	错误信息
list	Array.<Object>

list 的结构

属性	类型	说明
templateId	string	添加至帐号下的模板id，发送小程序模板消息时所需
title	string	模板标题
content	string	模板内容
example	string	模板内容示例

异常

Object

抛出的异常

属性	类型	说明
errCode	number	错误码
errMsg	string	错误信息

errCode 的合法值

值	说明	最低版本

请求数据示例

const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.templateMessage.getTemplateList({
        offset: 0,
        count: 1
      })
    console.log(result)
    return result
  } catch (err) {
    console.log(err)
    return err
  }
}

返回数据示例

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