发送微信订阅消息

该接口给特定的用户发送一个特定的订阅消息

可以通过查询接口在发送前查询可用订阅

智能过滤需要个人版及以上套餐版本

BaaS.wechat.sendSubscribeMessage(data)

参数说明

data 是 Object 类型，它包括以下几个属性

参数类型必填说明
recipient_typeString是推送类型，可选值： user_id、user_list、user_group、schema_user
<recipient_params>Array、Integer、String、Object是根据recipient_type来填写不同的参数名， 详见下方表格说明
template_idString是模板 ID （微信后台配置）
keywordsObject是关键字，请参照 微信官方文档
schema_nameString否数据表名，如果 recipient_type 为 schema_user 则为必填项，表示对该表名的数据表进行用户筛选
pageString否点击模板卡片后的跳转页面，仅限本小程序内的页面。支持带参数。该字段不填则模板无跳转。
can_send_subscription_messageBoolean否是否过滤无效用户
recipient_type 类型recipient_params类型说明
user_iduser_idInteger推送单个用户，传入用户 ID (对应 _userprofile 表中的 id 字段)
user_listuser_listInteger Array推送批量用户，传入用户 id 列表
user_groupuser_group_nameString用户组名，注意这里是提交用户组名称，而不是用户组 id
schema_useruser_profile_filtersString对指定数据表的查询条件，用于筛选用户

RateLimit 类型说明:

属性类型必填说明
intervalNumber是时间间隔
limitNumber是每批次发送条数

请求示例 - user_id

  1. let data = {
  2.   recipient_type: 'user_id',
  3.   user_id: 23425,
  4.   template_id: "tadfDf23asdi8dfd",
  5.   page: "pages/index/index",
  6.   keywords: {
  7.     thing01: {
  8.       value: "书籍",
  9.     },
  10.     number01: {
  11.       value: "50.5",
  12.     }
  13.   }
  14. }
  16. BaaS.wechat.sendSubscribeMessage(data).then(res => {
  17.   // 发送成功
  18. }, err => {
  19.   // 发送失败
  20. })

请求示例 - user_list

  1. let data = {
  2.   recipient_type: 'user_list',
  3.   user_list: [123, 456, 789],
  4.   template_id: "tadfDf23asdi8dfd",
  5.   // 其他参数
  6. }
  8. BaaS.wechat.sendSubscribeMessage(data)

user_list 的长度不能超过 1000

请求示例 - user_group

  1. let data = {
  2.   recipient_type: 'user_group',
  3.   user_group_name: '运营人员',
  4.   template_id: "tadfDf23asdi8dfd",
  5.   // 其他参数
  6. }
  8. BaaS.wechat.sendSubscribeMessage(data)

请求示例 - schema_user

schema_user 允许同时存在 user_profile_filters 和 user_group_name 参数

如果 recipient_type 为 schema_user 且参数中包含 user_group_name 字段，则 user_profile_filters 字段中，最外层的 $and 或 $or 不能省略。

  1. let data = {
  2.   recipient_type: 'schema_user',
  3.   user_profile_filters: {
  4.     "$and": [
  5.       {
  6.         "is_authorize": true
  7.       },
  8.       {
  9.         "array_field": {
  10.           "$in": [
  11.             "value_1",
  12.             "value_2"
  13.           ]
  14.         }
  15.       }
  16.     ]
  17.   },
  18.   user_group_name: ['运营人员', '技术人员'],
  19.   template_id: "tadfDf23asdi8dfd",
  20.   // 其他参数
  21. }
  23. BaaS.wechat.sendSubscribeMessage(data)

其中 keywords 为微信后台中实际关键词对应的键值

关键词对应键值示例关键词对应键值示例

user_profile_filters 语法

操作符示例示例说明
={ a:{ $eq: '123' } }a == '123'
<{ a: { $lt: 22 } }a 小于 22
<={ a: { $lte: 22 } }a 小于等于 22
>{ a: { $gt: 22 } }a 大于 22
>={ a: { $gte: 22 } }a 大于等于 22
in{ a: { $in: [123, 456] } }a 存在于 [123, 456] , eg: 123 in [123, 456]
range{ a: { $range: [0, 5] } }a 存在于 [0, 1, 2, 3, 4] 中, eg: 1 in [0, 1, 2]
!={ a: { $ne: '123' } }a 不等于 '123', eg '456' != '123'
not in{ a: { $nin: [123, 456] } }a 不在 [123, 456] 中, eg: 888 不在 [123， 456] 中
contains{ a: { $contains: '123'} }a 包含 '123', eg: 'abc123' 包含 ‘123’
regex{ a: { $regex: '123', $options: 'g'} }a.match(/123/g)
all{ a: { $all: [1, 2, 3] } }a 包含了 [1, 2, 3] , eg: [1, 2, 3] 包含了 [1, 2]
is null{ a: { $isnull: true} } }a 是否为空
center{ a: { $center: {"radius": 123, "coordinates": [1, 2]} } }请参考withincircle
intersects{ a: { $intersects: {"type": GEOJSON, "coordinates": [1, 2]} }}请参考include
nearsphere{ a: {"$nearsphere":{"geometry":{"type":"Point","coordinates":[1,2]},"min_distance":3,"max_distance":4}} }请参考withinRegion