跳到主要内容
版本:3.x

Taro.requestSubscribeMessage(option)

请求订阅消息

注意:2.8.2 版本开始,用户发生点击行为或者发起支付回调后,才可以调起订阅消息界面。

支持情况:

参考文档

类型

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

参数

参数类型
optionOption

Option

参数类型必填说明
tmplIdsstring[]需要订阅的消息模板的id的集合(注意:iOS客户端7.0.6版本、Android客户端7.0.7版本之后的一次性订阅/长期订阅才支持多个模板消息,iOS客户端7.0.5版本、Android客户端7.0.6版本之前的一次订阅只支持一个模板消息)消息模板id在[微信公众平台(mp.weixin.qq.com)-功能-订阅消息]中配置
API 支持度: weapp, tt
entityIdsstring[]需要订阅的消息模板 id 集合(注意:1、一次性模板 id 和长期性模板 id 不可同时使用,2、一次最多传入三个模板 id
API 支持度: alipay
thirdTypeAppIdstring模板小程序 appId,仅在服务商代调用场景下需要传入
API 支持度: alipay
complete(res: TaroGeneral.CallbackResult) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(result: FailCallbackResult) => void接口调用失败的回调函数
success(result: SuccessCallbackResult) => void接口调用成功的回调函数

FailCallbackResult

参数类型说明
errCodenumber接口调用失败错误码
errMsgstring接口调用失败错误信息

SuccessCallbackResult

参数类型必填说明
[TEMPLATE_ID]"accept" or "reject" or "ban"动态的键,即模板id
behaviorstring用户订阅操作结果。

or 枚举值 or 描述 or
or --- or ---- or
or subscribe or 订阅成功 or
API 支持度: alipay
keepboolean一次性订阅,是否勾选 总是保持以上选择,不再询问。

or 枚举值 or 描述 or
or --- or ---- or
or true or 勾选 or
or false or 未勾选 or
API 支持度: alipay
refuseboolean长期性订阅,是否点击 拒绝,不再询问。

or 枚举值 or 描述 or
or --- or ---- or
or true or 点击 or
or false or 未点击 or
API 支持度: alipay
resultISubscribeResult订阅数据
API 支持度: alipay
showboolean本次订阅过程是否弹出了订阅面板。

or 枚举值 or 描述 or
or --- or ---- or
or true or 弹出 or
or false or 未弹出 or
API 支持度: alipay
errMsgstring接口调用成功时errMsg值为'requestSubscribeMessage:ok'

示例代码

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

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

ISubscribeResult

参数类型说明
subscribeEntityIdsstring[]订阅成功的模板列表
subscribedEntityIdsstring[]最终订阅成功的模板列表
unsubscribedEntityIdsstring[]未订阅的模板列表
currentSubscribedEntityIdsstring[]本次新增订阅成功的模板列表

TemplateReflex

模版消息订阅类型

参数说明
accept表示用户同意订阅该条id对应的模板消息
API 支持度: weapp, alipay, tt
reject表示用户拒绝订阅该条id对应的模板消息
API 支持度: weapp, alipay, tt
ban表示已被后台封禁
API 支持度: weapp, tt
filter表示该模板因为模板标题同名被后台过滤
API 支持度: weapp
fail表示该条 id 对应的模版消息授权失败
API 支持度: tt

示例代码

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