# templateMessage.getTemplateList

Call this API at the server side. For more information, see Server API.

This API supports Cloud Calls. The WeChat DevTools version must be 1.02.1904090 or later (download the latest stable version here), and the wx-server-sdk version must be 0.4.0 or later.

Obtains the existing template list under the account.

Calling methods:

• HTTPS call
• Cloud call

# HTTPS Call

# Request Address

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

# Request Parameters

# Return Value

# Object

JSON data package that is returned

list is composed as follows

# Request Data Example

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

# Return Data Example

{
  "errcode": 0,
  "errmsg": "ok",
  "list": [
    {
      "template_id": "wDYzYZVxobJivW9oMpSCpuvACOfJXQIoKUm0PY397Tc",
      "title": "Purchase success notification",
      "content": "Purchase location{{keyword1.DATA}}\nPurchase time{{keyword2.DATA}}\nItem name{{keyword3.DATA}}\n",
      "example": "Purchase location: TITShipbuilding factory\nPurchase time: 2016-6-6\nItem name: Coffee\n"
    }
  ]
}

# Cloud Call

Cloud call is a capability provided by Mini Program·Cloud Base that allows you to call WeChat APIs in a cloud function. It must be used via wx-server-sdk in the cloud function.

# API Calling Method

openapi.templateMessage.getTemplateList

You need to configure the permissions for the templateMessage.getTemplateList API via config.json. Details

# Request Parameters

# Return Value

# Object

JSON data package that is returned

list is composed as follows

# Exceptions

# Object

Thrown Exceptions

Valid values of errCode

# Request Data Example

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
    }
  }

# Return Data Example

{
  "errCode": 0,
  "errMsg": "openapi.templateMessage.getTemplateList:ok",
  "list": [
    {
      "title": "Purchase success notification",
      "content": "Purchase location{{keyword1.DATA}}\nPurchase time{{keyword2.DATA}}\nItem name{{keyword3.DATA}}\n",
      "example": "Purchase location: TITShipbuilding factory\nPurchase time: 2016-6-6\nItem name: Coffee\n",
      "templateId": "wDYzYZVxobJivW9oMpSCpuvACOfJXQIoKUm0PY397Tc"
    }
  ]
}