subscribeMessage.getPubTemplateKeyWordsById

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

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

获取模板标题下的关键词列表

调用方式：

HTTPS 调用

请求地址

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

请求参数

属性类型默认值必填说明
access_tokenstring是接口调用凭证
tidstring是模板标题 id，可通过接口获取

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息
countnumber模版标题列表总数
dataArray.<Object>关键词列表

data 的结构

属性类型说明
kidnumber关键词 id，选用模板时需要
namestring关键词内容
examplestring关键词内容对应的示例
rulestring参数类型

请求示例

  1. {
  2.   "tid": "99"
  3. }

响应示例

  1. {
  2.    "errcode": 0,
  3.    "errmsg": "ok",
  4.    "data": [
  5.        {
  6.            "kid": 1,
  7.            "name": "物品名称",
  8.            "example": "名称",
  9.            "rule": "thing"
  10.        }
  11.    ]
  12. }

云调用

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

接口方法

  1. openapi.subscribeMessage.getPubTemplateKeyWordsById

需在 config.json 中配置 subscribeMessage.getPubTemplateKeyWordsById API 的权限，详情

请求参数

属性类型默认值必填说明
tidstring是模板标题 id，可通过接口获取

返回值

Object

返回的 JSON 数据包

属性类型说明
errCodenumber错误码
errMsgstring错误信息
countnumber模版标题列表总数
dataArray.<Object>关键词列表

data 的结构

属性类型说明
kidnumber关键词 id，选用模板时需要
namestring关键词内容
examplestring关键词内容对应的示例
rulestring参数类型

异常

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.subscribeMessage.getPubTemplateKeyWordsById({
  6.         tid: ''
  7.       })
  8.     console.log(result)
  9.     return result
  10.   } catch (err) {
  11.     console.log(err)
  12.     return err
  13.   }
  14. }

请求示例

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

响应示例

  1. const cloud = require('wx-server-sdk')
  2. cloud.init()
  3. exports.main = async (event, context) => {
  4.   try {
  5.     const result = await cloud.openapi.subscribeMessage.getPubTemplateKeyWordsById({
  6.         errcode: 0,
  7.         errmsg: 'ok',
  8.         data: [
  9.           {
  10.             kid: 1,
  11.             name: '物品名称',
  12.             example: '名称',
  13.             rule: 'thing'
  14.           }
  15.         ]
  16.       })
  17.     console.log(result)
  18.     return result
  19.   } catch (err) {
  20.     console.log(err)
  21.     return err
  22.   }
  23. }