templateMessage.send

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

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

组合模板并添加至帐号下的个人模板库(请注意,小程序模板消息接口【已废弃】,开发者可使用订阅消息功能

调用方式:

HTTPS 调用

请求地址

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

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证
touserstring接收者(用户)的 openid
template_idstring所需下发的模板消息的id
pagestring点击模板卡片后的跳转页面,仅限本小程序内的页面。支持带参数,(示例index?foo=bar)。该字段不填则模板无跳转。
form_idstring表单提交场景下,为 submit 事件带上的 formId;支付场景下,为本次支付的 prepay_id
dataObject模板内容,不填则下发空模板。具体格式请参考示例。
emphasis_keywordstring模板需要放大的关键词,不填则默认无放大

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息

errcode 的合法值

说明最低版本
40037template_id不正确
41028form_id不正确,或者过期
41029form_id已被使用
41030page不正确
45009接口调用超过限额(目前默认每个帐号日调用限额为100万)

请求示例

  1. {
  2. "touser": "OPENID",
  3. "template_id": "TEMPLATE_ID",
  4. "page": "index",
  5. "form_id": "FORMID",
  6. "data": {
  7. "keyword1": {
  8. "value": "339208499"
  9. },
  10. "keyword2": {
  11. "value": "2015年01月05日 12:30"
  12. },
  13. "keyword3": {
  14. "value": "腾讯微信总部"
  15. } ,
  16. "keyword4": {
  17. "value": "广州市海珠区新港中路397号"
  18. }
  19. },
  20. "emphasis_keyword": "keyword1.DATA"
  21. }

返回示例

  1. {
  2. "errcode": 0,
  3. "errmsg": "ok"
  4. }

云调用

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

接口方法

  1. openapi.templateMessage.send

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

请求参数

属性类型默认值必填说明
touserstring接收者(用户)的 openid
templateIdstring所需下发的模板消息的id
pagestring点击模板卡片后的跳转页面,仅限本小程序内的页面。支持带参数,(示例index?foo=bar)。该字段不填则模板无跳转。
formIdstring表单提交场景下,为 submit 事件带上的 formId;支付场景下,为本次支付的 prepay_id
dataObject模板内容,不填则下发空模板。具体格式请参考示例。
emphasisKeywordstring模板需要放大的关键词,不填则默认无放大

返回值

Object

返回的 JSON 数据包

属性类型说明
errCodenumber错误码
errMsgstring错误信息

errCode 的合法值

说明最低版本
0成功

异常

Object

抛出的异常

属性类型说明
errCodenumber错误码
errMsgstring错误信息

errCode 的合法值

说明最低版本
40037template_id不正确
41028form_id不正确,或者过期
41029form_id已被使用
41030page不正确
45009接口调用超过限额(目前默认每个帐号日调用限额为100万)

请求示例

  1. const cloud = require('wx-server-sdk')
  2. cloud.init({
  3. env: cloud.DYNAMIC_CURRENT_ENV,
  4. })
  5. exports.main = async (event, context) => {
  6. try {
  7. const result = await cloud.openapi.templateMessage.send({
  8. touser: 'OPENID',
  9. page: 'index',
  10. data: {
  11. keyword1: {
  12. value: '339208499'
  13. },
  14. keyword2: {
  15. value: '2015年01月05日 12:30'
  16. },
  17. keyword3: {
  18. value: '腾讯微信总部'
  19. },
  20. keyword4: {
  21. value: '广州市海珠区新港中路397号'
  22. }
  23. },
  24. templateId: 'TEMPLATE_ID',
  25. formId: 'FORMID',
  26. emphasisKeyword: 'keyword1.DATA'
  27. })
  28. return result
  29. } catch (err) {
  30. return err
  31. }
  32. }

返回示例

  1. {
  2. "errCode": 0,
  3. "errMsg": "openapi.templateMessage.send:ok"
  4. }