# 添加模板
接口应在服务器端调用,详细说明参见服务端API。
本接口支持云调用。需开发者工具版本 >=
1.02.1904090
(最新稳定版下载),wx-server-sdk
>=0.4.0
# 接口说明
# 接口英文名
addMessageTemplate
# 功能描述
该接口用于组合模板并添加至账号下的个人模板库。
# 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxaapi/newtmpl/addtemplate?access_token=ACCESS_TOKEN
# 云调用
出入参和HTTPS调用相同,调用方式可查看云调用说明文档
接口方法为: openapi.subscribeMessage.addTemplate
# 第三方调用
调用方式以及出入参和HTTPS相同,仅是调用的token不同
该接口所属的权限集id为:18、89
服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用
# 请求参数
属性 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用access_token或者authorizer_access_token |
tid | string | 是 | 模板标题 id,可通过接口获取,也可登录小程序后台查看获取 |
kidList | array<number> | 是 | 开发者自行组合好的模板关键词列表,关键词顺序可以自由搭配(例如 [3,5,4] 或 [4,5,3]),最多支持5个,最少2个关键词组合。若为新的一次性订阅消息模板(tid >= 10000001 && tid < 20000000),则该项需传空数组。 |
sceneDesc | string | 否 | 服务场景描述,15个字以内 |
# 返回参数
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
priTmplId | string | 添加至账号下的模板id,发送小程序订阅消息时所需 |
# 调用示例
示例说明: HTTPS请求示例 建议使用 application/x-www-form-urlencoded 的请求内容格式,不支持 application/json 格式。
# 请求数据示例
{ "tid":"401", "kidList":[1,2], "sceneDesc": "测试数据" } // x-www-form-urlencoded body 内容为 tid=401&kidList=1&kidList=2&sceneDesc=%E6%B5%8B%E8%AF%95%E6%95%B0%E6%8D%AE
# 返回数据示例
{ "errmsg": "ok", "errcode": 0, "priTmplId": "9Aw5ZV1j9xdWTFEkqCpZ7jWySL7aGN6rQom4gXINfJs" }
示例说明: 云函数调用示例
# 请求数据示例
const cloud = require('wx-server-sdk') cloud.init({ env: cloud.DYNAMIC_CURRENT_ENV, }) exports.main = async (event, context) => { try { const result = await cloud.openapi({ convertCase: false }).subscribeMessage.addTemplate({ "tid": '401', "kidList": [ 1, 2 ], "sceneDesc": '测试数据' }) return result } catch (err) { return err } }
# 返回数据示例
{ "errMsg": "openapi.subscribeMessage.addTemplate:ok", "errCode": 0, "priTmplId": "9Aw5ZV1j9xdWTFEkqCpZ7jWySL7aGN6rQom4gXINfJs" }
# 错误码
错误码 | 错误码取值 | 解决方案 |
---|---|---|
-1 | system error | 系统繁忙,此时请开发者稍候再试 |
40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
200012 | 个人模板数已达上限,上限25个 | |
200014 | 模板 tid 参数错误 | |
200020 | 关键词列表 kidList 参数错误 | |
200021 | 场景描述 sceneDesc 参数错误 |