subscribeMessage.addTemplate

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

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

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

调用方式:

HTTPS 调用

请求地址

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

请求参数

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

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息
priTmplIdstring添加至帐号下的模板id,发送小程序订阅消息时所需

errcode 的合法值

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

请求示例

postData 格式是 x-www-form-urlencoded

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

响应示例

  1. {
  2. "errmsg": "ok",
  3. "errcode": 0,
  4. "priTmplId": "9Aw5ZV1j9xdWTFEkqCpZ7jWySL7aGN6rQom4gXINfJs"
  5. }

云调用

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

接口方法

  1. openapi.subscribeMessage.addTemplate

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

请求参数

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

返回值

Object

返回的 JSON 数据包

属性类型说明
errCodenumber错误码
errMsgstring错误信息
priTmplIdstring添加至帐号下的模板id,发送小程序订阅消息时所需

errCode 的合法值

说明最低版本
0成功

异常

Object

抛出的异常

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

errCode 的合法值

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

请求示例

postData 格式是 x-www-form-urlencoded

  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.addTemplate({
  6. tid: '401',
  7. kidList: [
  8. 1,
  9. 2
  10. ],
  11. sceneDesc: '测试数据'
  12. })
  13. console.log(result)
  14. return result
  15. } catch (err) {
  16. console.log(err)
  17. return err
  18. }
  19. }

响应示例

  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.addTemplate({
  6. errmsg: 'ok',
  7. errcode: 0,
  8. priTmplId: '9Aw5ZV1j9xdWTFEkqCpZ7jWySL7aGN6rQom4gXINfJs'
  9. })
  10. console.log(result)
  11. return result
  12. } catch (err) {
  13. console.log(err)
  14. return err
  15. }
  16. }