# templateMessage.send

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.

Sends a template message.

Calling methods:

• HTTPS call
• Cloud call

# HTTPS Call

# Request Address

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

# Request Parameters

# Return Value

# Object

JSON data package that is returned

Valid values of errcode

# Request Example

{
  "touser": "OPENID",
  "template_id": "TEMPLATE_ID",
  "page": "index",
  "form_id": "FORMID",
  "data": {
      "keyword1": {
          "value": "339208499"
      },
      "keyword2": {
          "value": "2015-01-05,  12:30"
      },
      "keyword3": {
          "value": "Tencent WeChat Headquarters"
      } ,
      "keyword4": {
          "value": "No. 397, Xingang Zhonglu, Haizhu District, Guangzhou"
      }
  },
  "emphasis_keyword": "keyword1.DATA"
}

# Response Example

{
 "errcode": 0,
 "errmsg": "ok"
}

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

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

# Request Parameters

# Return Value

# Object

JSON data package that is returned

Valid values of errCode

# Exceptions

# Object

Thrown Exceptions

Valid values of errCode

# Request Example

const cloud = require('wx-server-sdk')
  cloud.init()
  exports.main = async (event, context) => {
    try {
      const result = await cloud.openapi.templateMessage.send({
        touser: 'OPENID',
        page: 'index',
        data: {
          keyword1: {
            value: '339208499'
          },
          keyword2: {
            value: '2015-01-05,  12:30'
          },
          keyword3: {
            value: 'Tencent WeChat Headquarters'
          },
          keyword4: {
            value: 'No. 397, Xingang Zhonglu, Haizhu District, Guangzhou'
          }
        },
        templateId: 'TEMPLATE_ID',
        formId: 'FORMID',
        emphasisKeyword: 'keyword1.DATA'
      })
      console.log(result)
      return result
    } catch (err) {
      console.log(err)
      return err
    }
  }

# Response Example

{
  "errCode": 0,
  "errMsg": "openapi.templateMessage.send:ok"
}