微信小程序开发文档微信小程序订阅消息·addTemplate

2024-02-25 开发教程微信小程序开发文档匿名 1℃

subscribeMessage.addTemplate

本接口应在服务器端调用，详细说明参见服务端API。本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载）
wx-server-sdk >= 0.4.0

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

调用方式：

HTTPS 调用
云调用

HTTPS 调用

请求地址

POST https://api.weixin.qq.com/wxaapi/newtmpl/addtemplate?access_token=ACCESS_TOKEN

请求参数

属性	类型	必填	说明
access_token	string	是	接口调用凭证
tid	string	是	模板标题 id，可通过接口获取，也可登录小程序后台查看获取
kidList	Array.<number>	是	开发者自行组合好的模板关键词列表，关键词顺序可以自由搭配（例如 [3,5,4] 或 [4,5,3]），最多支持5个，最少2个关键词组合
sceneDesc	string	否	服务场景描述，15个字以内

返回值

Object

返回的 JSON 数据包

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

errcode 的合法值

值	说明	最低版本
200014	模版 tid 参数错误
200020	关键词列表 kidList 参数错误
200021	场景描述 sceneDesc 参数错误
200011	此账号已被封禁，无法操作
200013	此模版已被封禁，无法选用
200012	个人模版数已达上限，上限25个

请求示例

content-type: application/json;

{
  "tid":"401",
  "kidList":[1,2],
  "sceneDesc": "测试数据"
}

响应示例

{
  "errmsg": "ok",
  "errcode": 0,
  "priTmplId": "9Aw5ZV1j9xdWTFEkqCpZ7jWySL7aGN6rQom4gXINfJs"
}

云调用

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

接口方法

openapi.subscribeMessage.addTemplate

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

请求参数

属性	类型	必填	说明
tid	string	是	模板标题 id，可通过接口获取，也可登录小程序后台查看获取
kidList	Array.<number>	是	开发者自行组合好的模板关键词列表，关键词顺序可以自由搭配（例如 [3,5,4] 或 [4,5,3]），最多支持5个，最少2个关键词组合
sceneDesc	string	否	服务场景描述，15个字以内

返回值

Object

返回的 JSON 数据包

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

errCode 的合法值

值	说明	最低版本
0	成功

异常

Object

抛出的异常

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

errCode 的合法值

值	说明	最低版本
200014	模版 tid 参数错误
200020	关键词列表 kidList 参数错误
200021	场景描述 sceneDesc 参数错误
200011	此账号已被封禁，无法操作
200013	此模版已被封禁，无法选用
200012	个人模版数已达上限，上限25个

请求示例

content-type: application/json;

const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.subscribeMessage.addTemplate({
        tid: '401',
        kidList: [
          1,
          2
        ],
        sceneDesc: '测试数据'
      })
    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.addTemplate({
        errmsg: 'ok',
        errcode: 0,
        priTmplId: '9Aw5ZV1j9xdWTFEkqCpZ7jWySL7aGN6rQom4gXINfJs'
      })
    return result
  } catch (err) {
    return err
  }
}

上一节：微信小程序生物认证·verifySignature

下一节：微信小程序订阅消息·deleteTemplate

"微信小程序开发文档"的目录

微信小程序开发文档 微信小程序 订阅消息·addTemplate

subscribeMessage.addTemplate

HTTPS 调用

请求地址

请求参数

返回值

Object

请求示例

响应示例

云调用

接口方法

请求参数

返回值

Object

异常

Object

请求示例

响应示例

微信小程序开发文档微信小程序订阅消息·addTemplate