templateMessage.addTemplate

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

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

组合模板并添加至帐号下的个人模板库

调用方式:

HTTPS 调用

请求地址

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

请求参数

属性 类型 默认值 必填 说明
access_token string 接口调用凭证
id string 模板标题id,可通过接口获取,也可登录小程序后台查看获取
keyword_id_list Array.<number> 开发者自行组合好的模板关键词列表,关键词顺序可以自由搭配(例如[3,5,4]或[4,5,3]),最多支持10个关键词组合

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errcode number 错误码
errmsg string 错误信息
template_id string 添加至帐号下的模板id,发送小程序模板消息时所需

请求数据示例

{
 "id":"AT0002",
 "keyword_id_list":[3,4,5]
}

返回数据示例

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

云调用

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

接口方法

openapi.templateMessage.addTemplate

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

请求参数

属性 类型 默认值 必填 说明
id string 模板标题id,可通过接口获取,也可登录小程序后台查看获取
keywordIdList Array.<number> 开发者自行组合好的模板关键词列表,关键词顺序可以自由搭配(例如[3,5,4]或[4,5,3]),最多支持10个关键词组合

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errCode number 错误码
errMsg string 错误信息
templateId string 添加至帐号下的模板id,发送小程序模板消息时所需

异常

Object

抛出的异常

属性 类型 说明
errCode number 错误码
errMsg string 错误信息

errCode 的合法值

说明 最低版本

请求数据示例

const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.templateMessage.addTemplate({
        id: 'AT0002',
        keywordIdList: [
          3,
          4,
          5
        ]
      })
    console.log(result)
    return result
  } catch (err) {
    console.log(err)
    return err
  }
}

返回数据示例

{
  "errCode": 0,
  "errMsg": "openapi.templateMessage.addTemplate:ok",
  "templateId": "wDYzYZVxobJivW9oMpSCpuvACOfJXQIoKUm0PY397Tc"
}