templateMessage.getTemplateLibraryList

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

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

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

调用方式:

HTTPS 调用

请求地址

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

请求参数

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

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errcode number 错误码
errmsg string 错误信息
id string 模板标题id(获取模板标题下的关键词库时需要)
title string 模板标题内容
total_count number 模板库标题总数

请求数据示例

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

返回数据示例

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

云调用

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

接口方法

openapi.templateMessage.getTemplateLibraryList

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

请求参数

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

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errCode number 错误码
errMsg string 错误信息
id string 模板标题id(获取模板标题下的关键词库时需要)
title string 模板标题内容
totalCount number 模板库标题总数

异常

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.getTemplateLibraryList({
        offset: 0,
        count: 5
      })
    console.log(result)
    return result
  } catch (err) {
    console.log(err)
    return err
  }
}

返回数据示例

{
  "errCode": 0,
  "errMsg": "openapi.templateMessage.getTemplateLibraryList:ok",
  "list": [
    {
      "id": "AT0002",
      "title": "购买成功通知"
    },
    {
      "id": "AT0003",
      "title": "购买失败通知"
    },
    {
      "id": "AT0004",
      "title": "交易提醒"
    },
    {
      "id": "AT0005",
      "title": "付款成功通知"
    },
    {
      "id": "AT0006",
      "title": "付款失败通知"
    }
  ],
  "totalCount": 599
}