templateMessage.getTemplateLibraryById

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

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

组合模板并添加至帐号下的个人模板库(请注意,小程序模板消息接口将于2020年1月10日下线,开发者可使用订阅消息功能

调用方式:

HTTPS 调用

请求地址

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

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证
idstring模板标题id,可通过接口获取,也可登录小程序后台查看获取

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息
idstring模板标题 id
titlestring模板标题
keyword_listArray.<Object>关键词列表

keyword_list 的结构

属性类型说明
keyword_idstring关键词 id,添加模板时需要
namestring关键词内容
examplestring关键词内容对应的示例

请求数据示例

  1. {
  2. "id": "AT0002"
  3. }

返回数据示例

  1. {
  2. "errcode": 0,
  3. "errmsg": "ok",
  4. "id": "AT0002",
  5. "title": "购买成功通知",
  6. "keyword_list": [
  7. {
  8. "keyword_id": 3,
  9. "name": "购买地点",
  10. "example": "TIT造舰厂"
  11. },
  12. {
  13. "keyword_id": 4,
  14. "name": "购买时间",
  15. "example": "2016年6月6日"
  16. },
  17. {
  18. "keyword_id": 5,
  19. "name": "物品名称",
  20. "example": "咖啡"
  21. }
  22. ]
  23. }

云调用

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

接口方法

  1. openapi.templateMessage.getTemplateLibraryById

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

请求参数

属性类型默认值必填说明
idstring模板标题id,可通过接口获取,也可登录小程序后台查看获取

返回值

Object

返回的 JSON 数据包

属性类型说明
errCodenumber错误码
errMsgstring错误信息
idstring模板标题 id
titlestring模板标题
keywordListArray.<Object>关键词列表

keywordList 的结构

属性类型说明
keywordIdstring关键词 id,添加模板时需要
namestring关键词内容
examplestring关键词内容对应的示例

异常

Object

抛出的异常

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

errCode 的合法值

说明最低版本

请求数据示例

  1. const cloud = require('wx-server-sdk')
  2. cloud.init()
  3. exports.main = async (event, context) => {
  4. try {
  5. const result = await cloud.openapi.templateMessage.getTemplateLibraryById({
  6. id: 'AT0002'
  7. })
  8. console.log(result)
  9. return result
  10. } catch (err) {
  11. console.log(err)
  12. return err
  13. }
  14. }

返回数据示例

  1. {
  2. "errCode": 0,
  3. "errMsg": "openapi.templateMessage.getTemplateLibraryById:ok",
  4. "id": "AT0002",
  5. "title": "购买成功通知",
  6. "keywordList": [
  7. {
  8. "name": "购买地点",
  9. "example": "TIT造舰厂",
  10. "keywordId": 3
  11. },
  12. {
  13. "name": "购买时间",
  14. "example": "2016年6月6日",
  15. "keywordId": 4
  16. },
  17. {
  18. "name": "物品名称",
  19. "example": "咖啡",
  20. "keywordId": 5
  21. }
  22. ]
  23. }