uniformMessage.send

This interface should be called on the server side, as detailed in the Service Side API.

This interface supports cloud calls. Developer tool version required . . . 1.02.1904090 (latest stable download)
wx-server-sdk >= 0.4.0

Send a unified service message with a small program and a public number

How to call:

• HTTPS call
• Cloud calls

HTTPS call

The request address

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

Request parameters

weapp_template_msg structure of the system

mp_template_msg structure of the system

Returns a value

Object

The returned JSON packet

Error

An example of requesting data

{
    "touser":"OPENID",
    "weapp_template_msg":{
        "template_id":"TEMPLATE_ID",
        "page":"page/page/index",
        "form_id":"FORMID",
        "data":{
            "keyword1":{
                "value":"339208499"
            },
            "keyword2":{
                "value":"2015年01月05日 12:30"
            },
            "keyword3":{
                "value":"腾讯微信总部"
            },
            "keyword4":{
                "value":"广州市海珠区新港中路397号"
            }
        },
        "emphasis_keyword":"keyword1.DATA"
    },
    "mp_template_msg":{
        "appid":"APPID ",
        "template_id":"TEMPLATE_ID",
        "url":"http://weixin.qq.com/download",
        "miniprogram":{
            "appid":"xiaochengxuappid12345",
            "pagepath":"index?foo=bar"
        },
        "data":{
            "first":{
                "value":"恭喜你购买成功！",
                "color":"#173177"
            },
            "keyword1":{
                "value":"巧克力",
                "color":"#173177"
            },
            "keyword2":{
                "value":"39.8元",
                "color":"#173177"
            },
            "keyword3":{
                "value":"2014年9月22日",
                "color":"#173177"
            },
            "remark":{
                "value":"欢迎再次购买！",
                "color":"#173177"
            }
        }
    }
}

Return an example of the data

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

Cloud calls

Cloud call is the ability provided by the small program Cloud Development to call WeChat open interfaces in cloud functions and need to be used in cloud functions via wx-server-sdk.

The interface method

openapi.uniformMessage.send

Permissions for the uniformMessage.send API need to be configured in config.json, details

Request parameters

The structure of weappTemplate Msg

The structure of mpTemplate Msg

Returns a value

Object

The returned JSON packet

Abnormal

Object

The exception thrown

The legal value of errCode

Error

An example of requesting data

const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.uniformMessage.send({
        touser: 'OPENID',
        weappTemplateMsg: {
          page: 'page/page/index',
          data: {
            keyword1: {
              value: '339208499'
            },
            keyword2: {
              value: '2015年01月05日 12:30'
            },
            keyword3: {
              value: '腾讯微信总部'
            },
            keyword4: {
              value: '广州市海珠区新港中路397号'
            }
          },
          templateId: 'TEMPLATE_ID',
          formId: 'FORMID',
          emphasisKeyword: 'keyword1.DATA'
        },
        mpTemplateMsg: {
          appid: 'APPID ',
          url: 'http://weixin.qq.com/download',
          miniprogram: {
            appid: 'xiaochengxuappid12345',
            pagepath: 'index?foo=bar'
          },
          data: {
            first: {
              value: '恭喜你购买成功！',
              color: '#173177'
            },
            keyword1: {
              value: '巧克力',
              color: '#173177'
            },
            keyword2: {
              value: '39.8元',
              color: '#173177'
            },
            keyword3: {
              value: '2014年9月22日',
              color: '#173177'
            },
            remark: {
              value: '欢迎再次购买！',
              color: '#173177'
            }
          },
          templateId: 'TEMPLATE_ID'
        }
      })
    return result
  } catch (err) {
    return err
  }
}

Return an example of the data

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