wx.miniapp.requestSubscribeMessage
WARNING
请注意,当前域名 https://dev.weixin.qq.com/docs/framework
文档已不维护,请前往微信文档中心 找到对应的新文档继续使用
跳转微信获取一次性订阅消息
接入前注意事项
- 该能力依赖微信 Open SDK ,需按照指引在微信开放平台创建移动应用账号,以完成相关初始化配置,详情可查看微信移动应用能力初始化指引
- 在进行一次性订阅消息授权接入之前,需要在微信开放平台注册开发者账号,并拥有一个已审核通过的移动应用,获得相应的下发消息模板 ID 后,可开始接入流程。接入文档可以查看 这里
参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
templateId | string | - | 否 | 订阅消息模板 ID,在微信开放平台提交应用审核通过后获得。查看模板id的路径为:微信开放平台 - 移动应用 - 能力专区 - 一次性订阅消息 |
reserved | string | - | 否 | 用于保持请求和回调的状态,授权请后原样带回给第三方。该参数可用于防止 csrf 攻击(跨站请求伪造攻击),建议第三方带上该参数,可设置为简单的随机数加 session 进行校验,开发者可以填写 a-zA-Z0-9 的参数值,最多 128 字节,要求做 urlencode |
scene | number | - | 否 | 场景值 |
success | function | 否 | 获取后成功回调 | |
fail | function | 否 | 获取失败回调 |
JSAPI 代码例子
// login
wx.miniapp.requestSubscribeMessage({
scene: 123,
reserved: 'hello',
templateId: 'aY74R-PsuU6c-IWTMNzyMstLJ0ZMrfn9nIpGLpkTBPs',
success(e) {
console.log(`requestSubscribeMessage success`, e)
},
fail(e) {
console.log(`requestSubscribeMessage fail`, e)
}
})