# templateMessage.getTemplateLibraryList

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 title list from the template library of a Mini Program.

Calling methods:

• HTTPS call
• Cloud call

# HTTPS Call

# Request Address

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

# Request Parameters

# Return Value

# Object

JSON data package that is returned

# Request Data Example

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

# Return Data Example

{
 "errcode":0,
 "errmsg":"ok",
 "list":[
 {"id":"AT0002","title":"Purchase success notification"},
 {"id":"AT0003","title":"Purchase failure notification"},
 {"id":"AT0004","title":"Transaction reminder"},
 {"id":"AT0005","title":"Payment success notification"},
 {"id":"AT0006","title":"Payment failure notification"}
 ],
 "total_count":599
}

# 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.getTemplateLibraryList

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

# Request Parameters

# Return Value

# Object

JSON data package that is returned

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

# Return Data Example

{
  "errCode": 0,
  "errMsg": "openapi.templateMessage.getTemplateLibraryList:ok",
  "list": [
    {
      "id": "AT0002",
      "title": "Purchase success notification"
    },
    {
      "id": "AT0003",
      "title": "Purchase failure notification"
    },
    {
      "id": "AT0004",
      "title": "Transaction reminder"
    },
    {
      "id": "AT0005",
      "title": "Payment success notification"
    },
    {
      "id": "AT0006",
      "title": "Payment failure notification"
    }
  ],
  "totalCount": 599
}