后浪云小程序教程:微信小程序 订阅消息·getTemplateList

subscribeMessage.getTemplateList

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

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

wx-server-sdk >= 0.4.0

获取当前帐号下的个人模板列表

调用方式:

  • HTTPS 调用
  • 云调用

HTTPS 调用

请求地址

GET https://api.weixin.qq.com/wxaapi/newtmpl/gettemplate?access_token=ACCESS_TOKEN

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息
dataArray.<Object>个人模板列表

data 的结构

属性类型说明
priTmplIdstring添加至帐号下的模板 id,发送小程序订阅消息时所需
titlestring模版标题
contentstring模版内容
examplestring模板内容示例
typenumber模版类型,2 为一次性订阅,3 为长期订阅

响应示例

{
   "errcode": 0,
   "errmsg": "ok",
   "data": [
       {
          "priTmplId": "9Aw5ZV1j9xdWTFEkqCpZ7mIBbSC34khK55OtzUPl0rU",
          "title": "报名结果通知",
          "content": "会议时间:{{date2.DATA}}\n会议地点:{{thing1.DATA}}\n",
          "example": "会议时间:2016年8月8日\n会议地点:TIT会议室\n",
          "type": 2
       }
   ]
}

云调用

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

接口方法

openapi.subscribeMessage.getTemplateList

需在 config.json 中配置 subscribeMessage.getTemplateList API 的权限, 详情

返回值

Object

返回的 JSON 数据包

属性类型说明
errCodenumber错误码
errMsgstring错误信息
dataArray.<Object>个人模板列表

data 的结构

属性类型说明
priTmplIdstring添加至帐号下的模板 id,发送小程序订阅消息时所需
titlestring模版标题
contentstring模版内容
examplestring模板内容示例
typenumber模版类型,2 为一次性订阅,3 为长期订阅

异常

Object

抛出的异常

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

errCode 的合法值

说明最低版本

请求示例

const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.subscribeMessage.getTemplateList({})
    return result
  } catch (err) {
    return err
  }
}

响应示例

const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.subscribeMessage.getTemplateList({
        errcode: 0,
        errmsg: 'ok',
        data: [
          {
            priTmplId: '9Aw5ZV1j9xdWTFEkqCpZ7mIBbSC34khK55OtzUPl0rU',
            title: '报名结果通知',
            content: '会议时间:{{date2.DATA}}\n会议地点:{{thing1.DATA}}\n',
            example: '会议时间:2016年8月8日\n会议地点:TIT会议室\n',
            type: 2
          }
        ]
      })
    return result
  } catch (err) {
    return err
  }
}

THE END