Skip to main content
Version: 3.x

Taro.requestSubscribeDeviceMessage(option)

订阅设备消息接口，调用后弹出授权框，用户同意后会允许开发者给用户发送订阅模版消息。当用户点击“允许”按钮时，模板消息会被添加到用户的小程序设置页，通过 wx.getSetting 接口可获取用户对相关模板消息的订阅状态。

支持情况：

参考文档

类型​

(option: Option) => Promise<FailCallbackResult | SuccessCallbackResult>

参数​

参数类型
optionOption

Option​

参数类型必填说明
tmplIdsstring[]是需要订阅的消息模板的 id 的集合，一次调用最多可订阅3条消息
snstring是设备唯一序列号。由厂商分配，长度不能超过128字节。字符只接受数字，大小写字母，下划线（_）和连字符（-）。
snTicketstring是设备票据，5分钟内有效。
modelIdstring是设备型号 id 。通过微信公众平台注册设备获得。
complete(res: TaroGeneral.CallbackResult) => void否接口调用结束的回调函数（调用成功、失败都会执行）
fail(result: FailCallbackResult) => void否接口调用失败的回调函数
success(result: SuccessCallbackResult) => void否接口调用成功的回调函数

FailCallbackResult​

参数类型说明
errCodenumber接口调用失败错误码，有可能为空
errMsgstring接口调用失败错误信息

SuccessCallbackResult​

参数类型说明
[TEMPLATE_ID]"accept" or "reject" or "ban" or "filter" or "acceptWithAudio"[TEMPLATE_ID]是动态的键，即模板id
errMsgstring接口调用成功时errMsg值为'requestSubscribeMessage:ok'

示例代码​

表示用户同意订阅 zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE 这条消息

{
  "errMsg": "requestSubscribeDeviceMessage:ok",
  "zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE": "accept"
}

TemplateReflex​

模版消息订阅类型

参数说明
accept表示用户同意订阅该条id对应的模板消息
reject表示用户拒绝订阅该条id对应的模板消息
ban表示已被后台封禁
filter表示该模板因为模板标题同名被后台过滤
acceptWithAudio表示用户接收订阅消息并开启了语音提醒

示例代码​

Taro.requestSubscribeDeviceMessage({
  tmplIds: ['xxxxx'],
  sn: 'xxxx',
  snTicket: 'xxxxx',
  modelId: 'xxx',
  success(res) {
    console.log(res)
  },
  fail(res) {
    console.log(res)
  }
})