微信小程序 訂閱消息·addTemplate

2022-05-12 15:26 更新

subscribeMessage.addTemplate

本接口應(yīng)在服務(wù)器端調(diào)用,詳細(xì)說明參見服務(wù)端API
本接口支持云調(diào)用。需開發(fā)者工具版本 >= 1.02.1904090(最新穩(wěn)定版下載
wx-server-sdk >= 0.4.0

組合模板并添加至帳號下的個人模板庫

調(diào)用方式:

  • HTTPS 調(diào)用
  • 云調(diào)用

HTTPS 調(diào)用

請求地址

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

請求參數(shù)

屬性 類型 默認(rèn)值 必填 說明
access_token string 接口調(diào)用憑證
tid string 模板標(biāo)題 id,可通過接口獲取,也可登錄小程序后臺查看獲取
kidList Array.<number> 開發(fā)者自行組合好的模板關(guān)鍵詞列表,關(guān)鍵詞順序可以自由搭配(例如 [3,5,4] 或 [4,5,3]),最多支持5個,最少2個關(guān)鍵詞組合
sceneDesc string 服務(wù)場景描述,15個字以內(nèi)

返回值

Object

返回的 JSON 數(shù)據(jù)包

屬性 類型 說明
errcode number 錯誤碼
errmsg string 錯誤信息
priTmplId string 添加至帳號下的模板id,發(fā)送小程序訂閱消息時所需

errcode 的合法值

說明 最低版本
200014 模版 tid 參數(shù)錯誤
200020 關(guān)鍵詞列表 kidList 參數(shù)錯誤
200021 場景描述 sceneDesc 參數(shù)錯誤
200011 此賬號已被封禁,無法操作
200013 此模版已被封禁,無法選用
200012 個人模版數(shù)已達(dá)上限,上限25個

請求示例

content-type: application/json;

{
  "tid":"401",
  "kidList":[1,2],
  "sceneDesc": "測試數(shù)據(jù)"
}

響應(yīng)示例

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

云調(diào)用

云調(diào)用是小程序·云開發(fā)提供的在云函數(shù)中調(diào)用微信開放接口的能力,需要在云函數(shù)中通過 wx-server-sdk 使用。

接口方法

openapi.subscribeMessage.addTemplate
需在 config.json 中配置 subscribeMessage.addTemplate API 的權(quán)限,詳情

請求參數(shù)

屬性 類型 默認(rèn)值 必填 說明
tid string 模板標(biāo)題 id,可通過接口獲取,也可登錄小程序后臺查看獲取
kidList Array.<number> 開發(fā)者自行組合好的模板關(guān)鍵詞列表,關(guān)鍵詞順序可以自由搭配(例如 [3,5,4] 或 [4,5,3]),最多支持5個,最少2個關(guān)鍵詞組合
sceneDesc string 服務(wù)場景描述,15個字以內(nèi)

返回值

Object

返回的 JSON 數(shù)據(jù)包

屬性 類型 說明
errCode number 錯誤碼
errMsg string 錯誤信息
priTmplId string 添加至帳號下的模板id,發(fā)送小程序訂閱消息時所需

errCode 的合法值

說明 最低版本
0 成功

異常

Object

拋出的異常

屬性 類型 說明
errCode number 錯誤碼
errMsg string 錯誤信息

errCode 的合法值

說明 最低版本
200014 模版 tid 參數(shù)錯誤
200020 關(guān)鍵詞列表 kidList 參數(shù)錯誤
200021 場景描述 sceneDesc 參數(shù)錯誤
200011 此賬號已被封禁,無法操作
200013 此模版已被封禁,無法選用
200012 個人模版數(shù)已達(dá)上限,上限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: '測試數(shù)據(jù)'
      })
    return result
  } catch (err) {
    return err
  }
}

響應(yīng)示例

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
  }
}


以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號