templateMessage.getTemplateLibraryList

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

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

组合模板并添加至帐号下的个人模板库（请注意，小程序模板消息接口【已废弃】，开发者可使用订阅消息功能）

调用方式：

HTTPS 调用

请求地址

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

请求参数

属性类型默认值必填说明
access_tokenstring是接口调用凭证
offsetnumber是用于分页，表示从offset开始。从 0 开始计数。
countnumber是用于分页，表示拉取count条记录。最大为 20。

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息
idstring模板标题id（获取模板标题下的关键词库时需要）
titlestring模板标题内容
total_countnumber模板库标题总数

请求数据示例

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

返回数据示例

  1. {
  2.  "errcode":0,
  3.  "errmsg":"ok",
  4.  "list":[
  5.  {"id":"AT0002","title":"购买成功通知"},
  6.  {"id":"AT0003","title":"购买失败通知"},
  7.  {"id":"AT0004","title":"交易提醒"},
  8.  {"id":"AT0005","title":"付款成功通知"},
  9.  {"id":"AT0006","title":"付款失败通知"}
  10.  ],
  11.  "total_count":599
  12. }

云调用

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

接口方法

  1. openapi.templateMessage.getTemplateLibraryList

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

请求参数

属性类型默认值必填说明
offsetnumber是用于分页，表示从offset开始。从 0 开始计数。
countnumber是用于分页，表示拉取count条记录。最大为 20。

返回值

Object

返回的 JSON 数据包

属性类型说明
errCodenumber错误码
errMsgstring错误信息
idstring模板标题id（获取模板标题下的关键词库时需要）
titlestring模板标题内容
totalCountnumber模板库标题总数

异常

Object

抛出的异常

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

errCode 的合法值

值说明最低版本

请求数据示例

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

返回数据示例

  1. {
  2.   "errCode": 0,
  3.   "errMsg": "openapi.templateMessage.getTemplateLibraryList:ok",
  4.   "list": [
  5.     {
  6.       "id": "AT0002",
  7.       "title": "购买成功通知"
  8.     },
  9.     {
  10.       "id": "AT0003",
  11.       "title": "购买失败通知"
  12.     },
  13.     {
  14.       "id": "AT0004",
  15.       "title": "交易提醒"
  16.     },
  17.     {
  18.       "id": "AT0005",
  19.       "title": "付款成功通知"
  20.     },
  21.     {
  22.       "id": "AT0006",
  23.       "title": "付款失败通知"
  24.     }
  25.   ],
  26.   "totalCount": 599
  27. }