微信小程序API 訂閱消息

2022-05-10 16:09 更新

wx.requestSubscribeMessage(Object object)

基礎(chǔ)庫(kù) 2.4.4 開始支持,低版本需做兼容處理。

調(diào)起客戶端小程序訂閱消息界面,返回用戶訂閱消息的操作結(jié)果。當(dāng)用戶勾選了訂閱面板中的“總是保持以上選擇,不再詢問(wèn)”時(shí),模板消息會(huì)被添加到用戶的小程序設(shè)置頁(yè),通過(guò) wx.getSetting 接口可獲取用戶對(duì)相關(guān)模板消息的訂閱狀態(tài)。

注意事項(xiàng)

  • 一次性模板 id 和永久模板 id 不可同時(shí)使用。
  • 低版本基礎(chǔ)庫(kù)2.4.4~2.8.3 已支持訂閱消息接口調(diào)用,僅支持傳入一個(gè)一次性 tmplId / 永久 tmplId。
  • 2.8.2 版本開始,用戶發(fā)生點(diǎn)擊行為或者發(fā)起支付回調(diào)后,才可以調(diào)起訂閱消息界面。
  • 2.10.0 版本開始,開發(fā)版和體驗(yàn)版小程序?qū)⒔故褂媚0逑?formId。

參數(shù)

Object object

屬性類型默認(rèn)值必填說(shuō)明
tmplIdsArray需要訂閱的消息模板的id的集合,一次調(diào)用最多可訂閱3條消息(注意:iOS客戶端7.0.6版本、Android客戶端7.0.7版本之后的一次性訂閱/長(zhǎng)期訂閱才支持多個(gè)模板消息,iOS客戶端7.0.5版本、Android客戶端7.0.6版本之前的一次訂閱只支持一個(gè)模板消息)消息模板id在[微信公眾平臺(tái)(mp.weixin.qq.com)-功能-訂閱消息]中配置
successfunction接口調(diào)用成功的回調(diào)函數(shù)
failfunction接口調(diào)用失敗的回調(diào)函數(shù)
completefunction接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行)

object.success 回調(diào)函數(shù)

參數(shù)
Object res
屬性類型說(shuō)明
errMsgString接口調(diào)用成功時(shí)errMsg值為'requestSubscribeMessage:ok'
TEMPLATE_IDString[TEMPLATE_ID]是動(dòng)態(tài)的鍵,即模板id,值包括'accept'、'reject'、'ban'。'accept'表示用戶同意訂閱該條id對(duì)應(yīng)的模板消息,'reject'表示用戶拒絕訂閱該條id對(duì)應(yīng)的模板消息,'ban'表示已被后臺(tái)封禁。例如 { errMsg: "requestSubscribeMessage:ok", zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE: "accept"} 表示用戶同意訂閱zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE這條消息

object.fail 回調(diào)函數(shù)

參數(shù)
Object res
屬性類型說(shuō)明
errMsgString接口調(diào)用失敗錯(cuò)誤信息
errCodeNumber接口調(diào)用失敗錯(cuò)誤碼

錯(cuò)誤碼

errCodeerrMsg說(shuō)明
10001TmplIds can't be empty參數(shù)傳空了
10002Request list fail網(wǎng)絡(luò)問(wèn)題,請(qǐng)求消息列表失敗
10003Request subscribe fail網(wǎng)絡(luò)問(wèn)題,訂閱請(qǐng)求發(fā)送失敗
10004Invalid template id參數(shù)類型錯(cuò)誤
10005Cannot show subscribe message UI無(wú)法展示 UI,一般是小程序這個(gè)時(shí)候退后臺(tái)了導(dǎo)致的
20001No template data return, verify the template id exist沒有模板數(shù)據(jù),一般是模板 ID 不存在 或者和模板類型不對(duì)應(yīng) 導(dǎo)致的
20002Templates type must be same模板消息類型 既有一次性的又有永久的
20003Templates count out of max bounds模板消息數(shù)量超過(guò)上限
20004The main switch is switched off用戶關(guān)閉了主開關(guān),無(wú)法進(jìn)行訂閱
20005This mini program was banned from subscribing messages小程序被禁封

示例代碼

wx.requestSubscribeMessage({
  tmplIds: [''],
  success (res) { }
})


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

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)