微信小程序-小程序订阅消息（四）

最新推荐文章于 2025-03-10 17:16:39 发布
最新推荐文章于 2025-03-10 17:16:39 发布
阅读量1.1w 收藏 18
点赞数 6
文章标签： 微信小程序 小程序
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/MinggeQingchun/article/details/129822306
版权

一、小程序订阅消息

小程序订阅消息 | 微信开放文档

功能介绍

消息能力是小程序能力中的重要组成，我们为开发者提供了订阅消息能力，以便实现服务的闭环和更优的体验。

  • 订阅消息推送位置：服务通知
  • 订阅消息下发条件：用户自主订阅
  • 订阅消息卡片跳转能力：点击查看详情可跳转至该小程序的页面

消息类型

1. 一次性订阅消息

一次性订阅消息用于解决用户使用小程序后，后续服务环节的通知问题。用户自主订阅后，开发者可不限时间地下发一条对应的服务消息；每条消息可单独订阅或退订。

2. 长期订阅消息

一次性订阅消息可满足小程序的大部分服务场景需求，但线下公共服务领域存在一次性订阅无法满足的场景，如航班延误，需根据航班实时动态来多次发送消息提醒。为便于服务，我们提供了长期性订阅消息，用户订阅一次后，开发者可长期下发多条消息。

目前长期性订阅消息仅向政务民生、医疗、交通、金融、教育等线下公共服务开放，后期将逐步支持到其他线下公共服务业务。

3. 设备订阅消息

设备订阅消息是一种特殊类型的订阅消息，它属于长期订阅消息类型，且需要完成「设备接入」才能使用。

设备订阅消息用于在设备触发某些需要人工介入的事件时（例如设备发生故障、设备耗材不足等），向用户发送消息通知。详见设备订阅消息文档。

使用说明

步骤一：获取模板 ID

在微信公众平台手动配置获取模板 ID：
登录 https://mp.weixin.qq.com 获取模板，如果没有合适的模板，可以申请添加新模板，审核通过后可使用。

步骤二：获取下发权限

一次性订阅消息、长期订阅消息，详见接口 wx.requestSubscribeMessage

设备订阅消息，详见接口 wx.requestSubscribeDeviceMessage

步骤三：调用接口下发订阅消息

一次性订阅消息、长期订阅消息，详见服务端接口 subscribeMessage.send，次数限制：开通支付能力的小程序下发上限是3kw/日，没开通的是1kw/日。

设备订阅消息，详见服务端接口 hardwareDevice.send

注意事项

  • 用户勾选 “总是保持以上选择，不再询问” 之后，下次订阅调用 wx.requestSubscribeMessage 不会弹窗，保持之前的选择，修改选择需要打开小程序设置进行修改。

订阅消息事件推送

1、当用户触发订阅消息弹框后，用户的相关行为事件结果会推送至开发者所配置的服务器地址或微信云托管服务。

XML格式示例

<xml>
    <ToUserName><![CDATA[gh_123456789abc]]></ToUserName>
    <FromUserName><![CDATA[otFpruAK8D-E6EfStSYonYSBZ8_4]]></FromUserName>
    <CreateTime>1610969440</CreateTime>
    <MsgType><![CDATA[event]]></MsgType>
    <Event><![CDATA[subscribe_msg_popup_event]]></Event>
    <SubscribeMsgPopupEvent>
        <List>
            <TemplateId><![CDATA[VRR0UEO9VJOLs0MHlU0OilqX6MVFDwH3_3gz3Oc0NIc]]></TemplateId>
            <SubscribeStatusString><![CDATA[accept]]></SubscribeStatusString>
            <PopupScene>2</PopupScene>
        </List>
        <List>
            <TemplateId><![CDATA[9nLIlbOQZC5Y89AZteFEux3WCXRRRG5Wfzkpssu4bLI]]></TemplateId>
            <SubscribeStatusString><![CDATA[reject]]></SubscribeStatusString>
            <PopupScene>2</PopupScene>
        </List>
    </SubscribeMsgPopupEvent>
</xml>

JSON 格式示例

{
  "ToUserName": "gh_123456789abc",
  "FromUserName": "o7esq5OI1Uej6Xixw1lA2H7XDVbc",
  "CreateTime": "1620973045",
  "MsgType": "event",
  "Event": "subscribe_msg_popup_event",
  "List": [   {
        "TemplateId": "hD-ixGOhYmUfjOnI8MCzQMPshzGVeux_2vzyvQu7O68",
        "SubscribeStatusString": "accept",
        "PopupScene": "0"
    }],
 }

若 "List" 只有一个对象，则只返回对象本身；若 "List" 多于一个对象，则返回一个包含所有对象的数组。

参数说明

参数说明
ToUserName小程序帐号ID
FromUserName用户openid
CreateTime时间戳
TemplateId模板id（一次订阅可能有多个id）
SubscribeStatusString订阅结果（accept接收；reject拒收）
PopupScene弹框场景，0代表在小程序页面内

2、当用户在手机端服务通知里消息卡片右上角“...”管理消息时，相应的行为事件会推送至开发者所配置的服务器地址或微信云托管服务。（目前只推送取消订阅的事件，即对消息设置“拒收”）

XML 格式示例

<xml>
    <ToUserName><![CDATA[gh_123456789abc]]></ToUserName>
    <FromUserName><![CDATA[otFpruAK8D-E6EfStSYonYSBZ8_4]]></FromUserName>
    <CreateTime>1610969440</CreateTime>
    <MsgType><![CDATA[event]]></MsgType>
    <Event><![CDATA[subscribe_msg_change_event]]></Event>
    <SubscribeMsgChangeEvent>
        <List>          <TemplateId><![CDATA[VRR0UEO9VJOLs0MHlU0OilqX6MVFDwH3_3gz3Oc0NIc]]></TemplateId>
            <SubscribeStatusString><![CDATA[reject]]></SubscribeStatusString>
        </List>
    </SubscribeMsgChangeEvent>
</xml>

JSON 格式示例

{
      "ToUserName": "gh_123456789abc",
      "FromUserName": "o7esq5OI1Uej6Xixw1lA2H7XDVbc",
      "CreateTime": "1610968440",
      "MsgType": "event",
      "Event": "subscribe_msg_change_event",
      "List": [  {
                "TemplateId":"BEwX0BOT3MqK3Uc5oTU3CGBqzjpndk2jzUf7VfExd8",
                "SubscribeStatusString": "reject"
      }],
}

若 "List" 只有一个对象，则只返回对象本身；若 "List" 多于一个对象，则返回一个包含所有对象的数组。

参数说明

参数说明
ToUserName小程序帐号ID
FromUserName用户openid
CreateTime时间戳
TemplateId模板id（一次订阅可能有多个id）
SubscribeStatusString订阅结果（reject拒收）

3、调用订阅消息接口发送消息给用户的最终结果，会推送下发结果事件至开发者所配置的服务器地址或微信云托管服务。

XML格式示例

<xml>
    <ToUserName><![CDATA[gh_123456789abc]]></ToUserName>
    <FromUserName><![CDATA[otFpruAK8D-E6EfStSYonYSBZ8_4]]></FromUserName>
    <CreateTime>1610969468</CreateTime>
    <MsgType><![CDATA[event]]></MsgType>
    <Event><![CDATA[subscribe_msg_sent_event]]></Event>
    <SubscribeMsgSentEvent>
        <List>       <TemplateId><![CDATA[VRR0UEO9VJOLs0MHlU0OilqX6MVFDwH3_3gz3Oc0NIc]]></TemplateId>
            <MsgID>1700827132819554304</MsgID>
            <ErrorCode>0</ErrorCode>
            <ErrorStatus><![CDATA[success]]></ErrorStatus>
        </List>
    </SubscribeMsgSentEvent>
</xml>

JSON 格式示例

{
    "ToUserName": "gh_123456789abc",
    "FromUserName": "o7esq5PHRGBQYmeNyfG064wEFVpQ",
    "CreateTime": "1620963428",
    "MsgType": "event",
    "Event": "subscribe_msg_sent_event",
    "List": {
        "TemplateId": "BEwX0BO-T3MqK3Uc5oTU3CGBqzjpndk2jzUf7VfExd8",
        "MsgID": "1864323726461255680",
        "ErrorCode": "0",
        "ErrorStatus": "success"
      }
      
}

参数说明

参数说明
ToUserName小程序帐号ID
FromUserName用户openid
CreateTime时间戳
TemplateId模板id（一次订阅可能有多个id）
MsgID消息id（调用接口时也会返回）
ErrorCode推送结果状态码（0表示成功）
ErrorStatus推送结果状态码对应的含义

注意：失败仅包含因异步推送导致的系统失败

订阅消息语音提醒

从基础库 2.18.0 开始支持

当前小程序订阅消息通知与微信消息的通知的提示音是一样的，对于部分订阅消息模板，增加语音提醒能力，播报语料部分字段支持开发者定义。

当开发者调用wx.requestSubscribeMessage时仅订阅1条消息且该模板支持开启语音提醒，用户在订阅时可以选择开启语音提醒。开启后将在接收订阅消息时会同步播报语音提醒。

当用户开启了语音提醒，开发者通过wx.getSetting获取的该模板的订阅状态为'acceptWithAudio'。

订阅弹窗样式如下：

当前支持开启语音提醒的模板及播报语料如下：

标题类型类目播报语料
收款到账通知长期订阅金融业-银行、金融业-收单商户服务小程序示例收款10元，其中“小程序示例”会播报为下发小程序的小程序简称，10会播报为模版中的收款金额

以下情况会导致语音提醒无法播报：

  1. 用户将服务通知设置为免打扰
  2. 用户开启了手机静音模式或手机音量过低
  3. 用户未打开微信新消息通知，可引导用户前往微信-“我”-“设置”-“新消息通知”中打开
  4. 用户未打开系统对微信的通知
  5. 用户开启了低电量模式
  6. 用户版本过低：需要iOS 8.0.6与安卓8.0.3及以上

订阅消息添加提醒

从基础库 2.22.0 开始支持

用户在订阅小程序长期订阅消息时，可以根据自己的使用情况添加提醒。添加后，用户在收到消息时，在微信内将由横幅通知提醒。

当用户添加了提醒，开发者通过wx.getSetting获取的该模板的订阅状态为'acceptWithForcePush'。

订阅弹窗样式如下：

二、wx.requestSubscribeMessage(Object object)

wx.requestSubscribeMessage(Object object) | 微信开放文档

功能描述

调起客户端小程序订阅消息界面，返回用户订阅消息的操作结果。当用户勾选了订阅面板中的“总是保持以上选择，不再询问”时，模板消息会被添加到用户的小程序设置页，通过 wx.getSetting 接口可获取用户对相关模板消息的订阅状态。

注意事项

  • 一次性模板 id 和永久模板 id 不可同时使用。
  • 低版本基础库2.4.4~2.8.3 已支持订阅消息接口调用，仅支持传入一个一次性 tmplId / 永久 tmplId。
  • 2.8.2 版本开始，用户发生点击行为或者发起支付回调后，才可以调起订阅消息界面。
  • 2.10.0 版本开始，开发版和体验版小程序将禁止使用模板消息 formId。
  • 一次授权调用里，每个tmplId对应的模板标题不能存在相同的，若出现相同的，只保留一个。
  • 2.10.0 版本开始，支持订阅语音消息提醒，详情

参数

Object object

属性类型默认值必填说明
tmplIdsArray是需要订阅的消息模板的id的集合，一次调用最多可订阅3条消息（注意：iOS客户端7.0.6版本、Android客户端7.0.7版本之后的一次性订阅/长期订阅才支持多个模板消息，iOS客户端7.0.5版本、Android客户端7.0.6版本之前的一次订阅只支持一个模板消息）消息模板id在[微信公众平台(mp.weixin.qq.com)-功能-订阅消息]中配置。每个tmplId对应的模板标题需要不相同，否则会被过滤。
successfunction否接口调用成功的回调函数
failfunction否接口调用失败的回调函数
completefunction否接口调用结束的回调函数（调用成功、失败都会执行）

object.success 回调函数

参数

Object res

属性类型说明
errMsgString接口调用成功时errMsg值为'requestSubscribeMessage:ok'
[TEMPLATE_ID: string]String[TEMPLATE_ID]是动态的键，即模板id，值包括'accept'、'reject'、'ban'、'filter'。'accept'表示用户同意订阅该条id对应的模板消息，'reject'表示用户拒绝订阅该条id对应的模板消息，'ban'表示已被后台封禁，'filter'表示该模板因为模板标题同名被后台过滤。例如 { errMsg: "requestSubscribeMessage:ok", zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE: "accept"} 表示用户同意订阅zun-LzcQyW-edafCVvzPkK4de2Rllr1fFpw2A_x0oXE这条消息

object.fail 回调函数

参数

Object res

属性类型说明
errMsgString接口调用失败错误信息
errCodeNumber接口调用失败错误码

错误码

errCodeerrMsg说明
10001TmplIds can't be empty参数传空了
10002Request list fail网络问题，请求消息列表失败
10003Request subscribe fail网络问题，订阅请求发送失败
10004Invalid template id参数类型错误
10005Cannot show subscribe message UI无法展示 UI，一般是小程序这个时候退后台了导致的
20001No template data return, verify the template id exist没有模板数据，一般是模板 ID 不存在 或者和模板类型不对应 导致的
20002Templates type must be same模板消息类型 既有一次性的又有永久的
20003Templates count out of max bounds模板消息数量超过上限
20004The main switch is switched off用户关闭了主开关，无法进行订阅
20005This mini program was banned from subscribing messages小程序被禁封
20013Reject DeviceMsg Template不允许通过该接口订阅设备消息

示例代码

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

三、发送订阅消息

发送订阅消息 | 微信开放文档

发送订阅消息

 调试工具

接口应在服务器端调用，详细说明参见服务端API。

本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载），wx-server-sdk >= 0.4.0

接口说明

接口英文名

sendMessage

功能描述

该接口用于发送订阅消息。

调用方式

HTTPS 调用


POST https://api.weixin.qq.com/cgi-bin/message/subscribe/send?access_token=ACCESS_TOKEN

云调用

  • 出入参和HTTPS调用相同，调用方式可查看云调用说明文档

  • 接口方法为: openapi.subscribeMessage.send

第三方调用

  • 调用方式以及出入参和HTTPS相同，仅是调用的token不同

  • 该接口所属的权限集id为：18

  • 服务商获得其中之一权限集授权后，可通过使用authorizer_access_token代商家进行调用

请求参数

属性类型必填说明
access_tokenstring是接口调用凭证，该参数为 URL 参数，非 Body 参数。使用access_token或者authorizer_access_token
template_idstring是所需下发的订阅模板id
pagestring否点击模板卡片后的跳转页面，仅限本小程序内的页面。支持带参数,（示例index?foo=bar）。该字段不填则模板无跳转
touserstring是接收者（用户）的 openid
datastring是模板内容，格式形如 { "key1": { "value": any }, "key2": { "value": any } }的object
miniprogram_statestring是跳转小程序类型：developer为开发版；trial为体验版；formal为正式版；默认为正式版
langstring是进入小程序查看”的语言类型，支持zh_CN(简体中文)、en_US(英文)、zh_HK(繁体中文)、zh_TW(繁体中文)，默认为zh_CN

返回参数

属性类型说明
errcodenumber错误码
errmsgstring错误信息

其他说明

订阅消息参数值内容限制说明

参数类别参数说明参数值限制说明
thing.DATA事物20个以内字符可汉字、数字、字母或符号组合
number.DATA数字32位以内数字只能数字，可带小数
letter.DATA字母32位以内字母只能字母
symbol.DATA符号5位以内符号只能符号
character_string.DATA字符串32位以内数字、字母或符号可数字、字母或符号组合
time.DATA时间24小时制时间格式（支持+年月日），支持填时间段，两个时间点之间用“~”符号连接例如：15:01，或：2019年10月1日 15:01
date.DATA日期年月日格式（支持+24小时制时间），支持填时间段，两个时间点之间用“~”符号连接例如：2019年10月1日，或：2019年10月1日 15:01
amount.DATA金额1个币种符号+10位以内纯数字，可带小数，结尾可带“元”可带小数
phone_number.DATA电话17位以内，数字、符号电话号码，例：+86-0766-66888866
car_number.DATA车牌8位以内，第一位与最后一位可为汉字，其余为字母或数字车牌号码：粤A8Z888挂
name.DATA姓名10个以内纯汉字或20个以内纯字母或符号中文名10个汉字内；纯英文名20个字母内；中文和字母混合按中文名算，10个字内
phrase.DATA汉字5个以内汉字5个以内纯汉字，例如：配送中
enum.DATA枚举值只能上传枚举值范围内的字段值调用接口获取参考枚举值

符号表示除中文、英文、数字外的常见符号，不能带有换行等控制字符。 时间格式支持HH:MM:SS或者HH:MM。 日期包含年月日，为y年m月d日，y年m月、m月d日格式，或者用‘-’、‘/’、‘.’符号连接，如2018-01-01，2018/01/01，2018.01.01，2018-01，01-01。 每个模板参数都会以类型为前缀，例如第一个数字模板参数为number01.DATA，第二个为number02.DATA

例如，模板的内容为

姓名: {{name01.DATA}}
金额: {{amount01.DATA}}
行程: {{thing01.DATA}}
日期: {{date01.DATA}}

则对应的json为

{
  "touser": "OPENID",
  "template_id": "TEMPLATE_ID",
  "page": "index",
  "data": {
      "name01": {
          "value": "某某"
      },
      "amount01": {
          "value": "￥100"
      },
      "thing01": {
          "value": "广州至北京"
      } ,
      "date01": {
          "value": "2018-01-01"
      }
  }
}

调用示例

示例说明: HTTPS请求示例

请求数据示例


{
  "touser": "OPENID",
  "template_id": "TEMPLATE_ID",
  "page": "index",
  "miniprogram_state":"developer",
  "lang":"zh_CN",
  "data": {
      "number01": {
          "value": "339208499"
      },
      "date01": {
          "value": "2015年01月05日"
      },
      "site01": {
          "value": "TIT创意园"
      } ,
      "site02": {
          "value": "广州市新港中路397号"
      }
  }
}

返回数据示例


{
"errcode":0,
"errmsg":"ok"
}

示例说明: 云函数调用示例

请求数据示例


const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.subscribeMessage.send({
        "touser": 'OPENID',
        "page": 'index',
        "lang": 'zh_CN',
        "data": {
          "number01": {
            "value": '339208499'
          },
          "date01": {
            "value": '2015年01月05日'
          },
          "site01": {
            "value": 'TIT创意园'
          },
          "site02": {
            "value": '广州市新港中路397号'
          }
        },
        "templateId": 'TEMPLATE_ID',
        "miniprogramState": 'developer'
      })
    return result
  } catch (err) {
    return err
  }
}

返回数据示例


{
"errcode":0,
"errmsg":"ok"
}

错误码

错误码错误码取值解决方案
40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误，或者 access_token 无效。请开发者认真比对 AppSecret 的正确性，或查看是否正在为恰当的公众号调用接口
40003invalid openid不合法的 OpenID ，请开发者确认 OpenID （该用户）是否已关注公众号，或是否是其他公众号的 OpenID
40014invalid access_token不合法的 access_token ，请开发者认真比对 access_token 的有效性（如是否过期），或查看是否正在为恰当的公众号调用接口
40037invalid template_id不合法的 template_id
85107

四、开放接口

开放接口 | 微信开放文档

开发者可调用接口完成模板选用和消息下发，同时可以授权给第三方开发。

1 addTemplate 选用模板

2 deleteTemplate 删除模板

3 getCategory 获取公众号类目

4 getPubTemplateKeyWordsById 获取模板中的关键词

5 getPubTemplateTitleList 获取所属类目的公共模板

6 getTemplateList 获取私有模板列表

7 send 发送订阅通知

同时可以接收事件推送

addTemplate选用模板

从公共模板库中选用模板，到私有模板库中

请求地址

POST https://api.weixin.qq.com/wxaapi/newtmpl/addtemplate?access_token=ACCESS_TOKEN

请求参数

属性类型默认值必填说明
access_tokenstring是接口调用凭证
tidstring是模板标题 id，可通过getPubTemplateTitleList接口获取，也可登录公众号后台查看获取
kidListArray.<number>是开发者自行组合好的模板关键词列表，关键词顺序可以自由搭配（例如 [3,5,4] 或 [4,5,3]），最多支持5个，最少2个关键词组合
sceneDescstring是服务场景描述，15个字以内

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息
priTmplIdstring添加至帐号下的模板id，发送订阅通知时所需

errcode 的合法值

值说明最低版本
200014模版 tid 参数错误
200020关键词列表 kidList 参数错误
200021场景描述 sceneDesc 参数错误
200011此账号已被封禁，无法操作
200013此模版已被封禁，无法选用
200012私有模板数已达上限，上限 50 个

请求数据示例

{
  "tid":"401",
  "kidList":[1,2],
  "sceneDesc": "测试数据"
}

返回数据示例

{
  "errmsg": "ok",
  "errcode": 0,
  "priTmplId": "9Aw5ZV1j9xdWTFEkqCpZ7jWySL7aGN6rQom4gXINfJs"
}

deleteTemplate删除模板

删除私有模板库中的模板

请求地址

POST https://api.weixin.qq.com/wxaapi/newtmpl/deltemplate?access_token=ACCESS_TOKEN

请求参数

属性类型默认值必填说明
access_tokenstring是接口调用凭证
priTmplIdstring是要删除的模板id

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息

errcode 的合法值

值说明最低版本
20001系统错误（包含该账号下无该模板等）
20002参数错误
200014模版 tid 参数错误

请求数据示例

{
  "priTmplId": "wDYzYZVxobJivW9oMpSCpuvACOfJXQIoKUm0PY397Tc"
}

返回数据示例

{
  "errmsg": "ok",
  "errcode": 0
}

getCategory获取公众号类目

获取公众号所属类目，可用于查询类目下的公共模板

请求地址

GET https://api.weixin.qq.com/wxaapi/newtmpl/getcategory?access_token=ACCESS_TOKEN

请求参数

属性类型默认值必填说明
access_tokenstring是接口调用凭证

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息
dataArray.<Objtect>类目列表

data 的结构

属性类型说明
idnumber类目id，查询公共模板库时需要
namestring类目的中文名

errcode 的合法值

值说明最低版本
20001系统错误

请求数据示例

{
}

返回数据示例

{
   "errcode": 0,
   "errmsg": "ok",
   "data": [
       {
           "id": 616,
           "name": "公交"
       }
   ]
}

getPubTemplateKeyWordsById获取模板中的关键词

获取公共模板下的关键词列表

请求地址

GET https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatekeywords?access_token=ACCESS_TOKEN

请求参数

属性类型默认值必填说明
access_tokenstring是接口调用凭证
tidstring是模板标题 id，可通过接口获取

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息
countnumber公共模板列表总数
dataArray.<Objtect>关键词列表

data 的结构

属性类型说明
kidnumber关键词 id，选用模板时需要
namestring关键词内容
examplestring关键词内容对应的示例
rulestring参数类型

errcode 的合法值

值说明最低版本
20001系统错误

请求数据示例

参数在 URL 的 query 里面，例如： https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatekeywords?access_token=ACCESS_TOKEN&tid=99

{
  "tid": "99"
}

返回数据示例

{
   "errcode": 0,
   "errmsg": "ok",
   "data": [
       {
           "kid": 1,
           "name": "物品名称",
           "example": "名称",
           "rule": "thing"
       }
   ]
}

getPubTemplateTitleList获取类目下的公共模板

获取类目下的公共模板，可从中选用模板使用

请求地址

GET https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatetitles?access_token=ACCESS_TOKEN

请求参数

属性类型默认值必填说明
idsstring是类目 id，多个用逗号隔开
startnumber是用于分页，表示从 start 开始，从 0 开始计数
limitnumber是用于分页，表示拉取 limit 条记录，最大为 30

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息
countnumber公共模板列表总数
dataArray.<Objtect>模板标题列表

data 的结构

属性类型说明
tidnumber模版标题 id
titlestring模版标题
typenumber模版类型，2 为一次性订阅，3 为长期订阅
categoryIdnumber模版所属类目 id

errcode 的合法值

值说明最低版本
200016start 参数错误
200017limit 参数错误
200018类目 ids 缺失
200019类目 ids 不合法

请求数据示例

参数在 URL 的 query 里面，例如：https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatetitles?access_token=ACCESS_TOKEN&ids="2,616"&start=0&limit=1

{
  "ids": "2,616",
  "start": 0,
  "limit": 1
}

返回数据示例

{
   "errcode": 0,
   "errmsg": "ok",
   "count": 55,
   "data": [
       {
           "tid": 99,
           "title": "付款成功通知",
           "type": 2,
           "categoryId": "616"
       }
   ]
}

getTemplateList获取私有模板列表

获取私有的模板列表

请求地址

GET https://api.weixin.qq.com/wxaapi/newtmpl/gettemplate?access_token=ACCESS_TOKEN

请求参数

属性类型默认值必填说明
access_tokenstring是接口调用凭证

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息
dataArray.<Objtect>个人模板列表

data 的结构

属性类型说明
priTmplIdstring添加至帐号下的模板 id，发送订阅通知时所需
titlestring模版标题
contentstring模版内容
examplestring模板内容示例
typenumber模版类型，2 为一次性订阅，3 为长期订阅

errcode 的合法值

值说明最低版本
20001系统错误

请求数据示例

{
}

返回数据示例

{
   "errcode": 0,
   "errmsg": "ok",
   "data": [
       {
          "priTmplId": "9Aw5ZV1j9xdWTFEkqCpZ7mIBbSC34khK55OtzUPl0rU",
          "title": "报名结果通知",
          "content": "会议时间:{{date2.DATA}}\n会议地点:{{thing1.DATA}}\n",
          "example": "会议时间:2016年8月8日\n会议地点:TIT会议室\n",
          "type": 2
       }
   ]
}

send发送订阅通知

发送订阅通知

请求地址

POST https://api.weixin.qq.com/cgi-bin/message/subscribe/bizsend?access_token=ACCESS_TOKEN

请求参数

属性类型默认值必填说明
access_tokenstring是接口调用凭证
touserstring是接收者（用户）的 openid
template_idstring是所需下发的订阅模板id
pagestring否跳转网页时填写
miniprogramArray.<Objtect>否跳转小程序时填写，格式如{ "appid": "pagepath": { "value": any } }
dataObject是模板内容，格式形如 { "key1": { "value": any }, "key2": { "value": any } }

page 和 miniprogram 同时不填，无跳转；page 和 miniprogram 同时填写，优先跳转小程序；

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息

errcode 的合法值

值说明最低版本
40003touser字段openid为空或者不正确
40037订阅模板id为空不正确
43101用户拒绝接受消息，如果用户之前曾经订阅过，则表示用户取消了订阅关系
47003模板参数不准确，可能为空或者不满足规则，errmsg会提示具体是哪个字段出错
41030page路径不正确

请求数据示例

{
  "touser": "OPENID",
  "template_id": "TEMPLATEID",
  "page": "mp.weixin.qq.com",
  "miniprogram":{
             "appid":"APPID",
             "pagepath":"index?foo=bar"
  },
  "data": {
      "name1": {
          "value": "广州腾讯科技有限公司"
      },
      "thing8": {
          "value": "广州腾讯科技有限公司"
      },
       "time7": {
          "value": "2019年8月8日"
      }
     }
}

返回数据示例

{
   "errcode": 0,
   "errmsg": "ok",
}

订阅通知参数值内容限制说明

参数类别参数说明参数值限制说明
thing.DATA事物20个以内字符可汉字、数字、字母或符号组合
number.DATA数字32位以内数字只能数字，可带小数
letter.DATA字母32位以内字母只能字母
symbol.DATA符号5位以内符号只能符号
character_string.DATA字符串32位以内数字、字母或符号可数字、字母或符号组合
time.DATA时间24小时制时间格式（支持+年月日），支持填时间段，两个时间点之间用“~”符号连接例如：15:01，或：2019年10月1日 15:01
date.DATA日期年月日格式（支持+24小时制时间），支持填时间段，两个时间点之间用“~”符号连接例如：2019年10月1日，或：2019年10月1日 15:01
amount.DATA金额1个币种符号+10位以内纯数字，可带小数，结尾可带“元”可带小数
phone_number.DATA电话17位以内，数字、符号电话号码，例：+86-0766-66888866
car_number.DATA车牌8位以内，第一位与最后一位可为汉字，其余为字母或数字车牌号码：粤A8Z888挂
name.DATA姓名10个以内纯汉字或20个以内纯字母或符号中文名10个汉字内；纯英文名20个字母内；中文和字母混合按中文名算，10个字内
phrase.DATA汉字5个以内汉字5个以内纯汉字，例如：配送中

符号表示除中文、英文、数字外的常见符号，不能带有换行等控制字符。 时间格式支持HH:MM:SS或者HH:MM。 日期包含年月日，为y年m月d日，y年m月、m月d日格式，或者用‘-’、‘/’、‘.’符号连接，如2018-01-01，2018/01/01，2018.01.01，2018-01，01-01。 每个模板参数都会以类型为前缀，例如第一个数字模板参数为number01.DATA，第二个为number02.DATA

例如，模板的内容为

姓名: {{name01.DATA}}
金额: {{amount01.DATA}}
行程: {{thing01.DATA}}
日期: {{date01.DATA}}

则对应的json为

{
  "touser": "OPENID",
  "template_id": "TEMPLATE_ID",
  "page": "index",
  "data": {
      "name01": {
          "value": "某某"
      },
      "amount01": {
          "value": "￥100"
      },
      "thing01": {
          "value": "广州至北京"
      },
      "date01": {
          "value": "2018-01-01"
      }
  }
}

事件推送

用户操作订阅通知弹窗

场景：用户在图文等场景内订阅通知的操作

参数描述
ToUserName公众号微信号
FromUserName用户 openid
CreateTime时间戳
TemplateId模板 id（一次订阅可能有多条通知，带有多个 id）
SubscribeStatusString用户点击行为（同意、取消发送通知）
PopupScene场景

SubscribeStatusString 的合法值

值说明
accept用户点击“同意”
reject用户点击“取消”

PopupScene 的合法值

值说明
1弹窗来自 H5 页面
2弹窗来自图文消息

XML 示例

<xml>
    <ToUserName><![CDATA[gh_123456789abc]]></ToUserName>
    <FromUserName><![CDATA[otFpruAK8D-E6EfStSYonYSBZ8_4]]></FromUserName>
    <CreateTime>1610969440</CreateTime>
    <MsgType><![CDATA[event]]></MsgType>
    <Event><![CDATA[subscribe_msg_popup_event]]></Event>
    <SubscribeMsgPopupEvent>
        <List>
            <TemplateId><![CDATA[VRR0UEO9VJOLs0MHlU0OilqX6MVFDwH3_3gz3Oc0NIc]]></TemplateId>
            <SubscribeStatusString><![CDATA[accept]]></SubscribeStatusString>
            <PopupScene>2</PopupScene>
        </List>
        <List>
            <TemplateId><![CDATA[9nLIlbOQZC5Y89AZteFEux3WCXRRRG5Wfzkpssu4bLI]]></TemplateId>
            <SubscribeStatusString><![CDATA[reject]]></SubscribeStatusString>
            <PopupScene>2</PopupScene>
        </List>
    </SubscribeMsgPopupEvent>
</xml>

用户管理订阅通知

场景：用户在服务通知管理页面做通知管理时的操作

参数描述
ToUserName公众号微信号
FromUserName用户 openid
CreateTime时间戳
TemplateId模板 id（一次订阅可能有多条通知，带有多个 id）
SubscribeStatusString用户点击行为（仅推送用户拒收通知）

SubscribeStatusString 的合法值

值说明
reject用户点击“取消”

XML 示例

<xml>
    <ToUserName><![CDATA[gh_123456789abc]]></ToUserName>
    <FromUserName><![CDATA[otFpruAK8D-E6EfStSYonYSBZ8_4]]></FromUserName>
    <CreateTime>1610969440</CreateTime>
    <MsgType><![CDATA[event]]></MsgType>
    <Event><![CDATA[subscribe_msg_change_event]]></Event>
    <SubscribeMsgChangeEvent>
        <List>
            <TemplateId><![CDATA[VRR0UEO9VJOLs0MHlU0OilqX6MVFDwH3_3gz3Oc0NIc]]></TemplateId>
            <SubscribeStatusString><![CDATA[reject]]></SubscribeStatusString>
        </List>
    </SubscribeMsgChangeEvent>
</xml>

发送订阅通知

场景：调用 bizsend 接口发送通知

参数描述
ToUserName公众号微信号
FromUserName用户 openid
CreateTime时间戳
TemplateId模板 id（一次订阅可能有多条通知，带有多个 id）
MsgID消息 id
ErrorCode推送结果状态码（0表示成功）
ErrorStatus推送结果状态码文字含义

*失败仅包含因异步推送导致的系统失败

XML 示例

<xml>
    <ToUserName><![CDATA[gh_123456789abc]]></ToUserName>
    <FromUserName><![CDATA[otFpruAK8D-E6EfStSYonYSBZ8_4]]></FromUserName>
    <CreateTime>1610969468</CreateTime>
    <MsgType><![CDATA[event]]></MsgType>
    <Event><![CDATA[subscribe_msg_sent_event]]></Event>
    <SubscribeMsgSentEvent>
        <List>
            <TemplateId><![CDATA[VRR0UEO9VJOLs0MHlU0OilqX6MVFDwH3_3gz3Oc0NIc]]></TemplateId>
            <MsgID>1700827132819554304</MsgID>
            <ErrorCode>0</ErrorCode>
            <ErrorStatus><![CDATA[success]]></ErrorStatus>
        </List>
    </SubscribeMsgSentEvent>
</xml>

五、报错

1、公众号订阅消息发送报47003错误

订阅通知参数值内容限制说明

参数类别参数说明参数值限制说明
thing.DATA事物20个以内字符可汉字、数字、字母或符号组合
number.DATA数字32位以内数字只能数字，可带小数
letter.DATA字母32位以内字母只能字母
symbol.DATA符号5位以内符号只能符号
character_string.DATA字符串32位以内数字、字母或符号可数字、字母或符号组合
time.DATA时间24小时制时间格式（支持+年月日），支持填时间段，两个时间点之间用“~”符号连接例如：15:01，或：2019年10月1日 15:01
date.DATA日期年月日格式（支持+24小时制时间），支持填时间段，两个时间点之间用“~”符号连接例如：2019年10月1日，或：2019年10月1日 15:01
amount.DATA金额1个币种符号+10位以内纯数字，可带小数，结尾可带“元”可带小数
phone_number.DATA电话17位以内，数字、符号电话号码，例：+86-0766-66888866
car_number.DATA车牌8位以内，第一位与最后一位可为汉字，其余为字母或数字车牌号码：粤A8Z888挂
name.DATA姓名10个以内纯汉字或20个以内纯字母或符号中文名10个汉字内；纯英文名20个字母内；中文和字母混合按中文名算，10个字内
phrase.DATA汉字5个以内汉字5个以内纯汉字，例如：配送中
【微信小程序】订阅消息的一次性订阅 vs 长期订阅？其实一次性订阅也能实现长期发布订阅消息
2201_75520614的博客
02-14 5491
相信你也曾被微信的服务通知所骚扰过（bushi）…没错，微信的订阅消息会发送到用户的服务通知处；那么如何实现呢？其实使用一次性订阅模板就可以了！
【微信小程序】订阅消息
chenzhong373095238的博客
01-10 5080
微信小程序订阅消息允许开发者在用户主动触发订阅后，向用户发送服务通知。这有助于提升用户体验和业务转化率。订阅消息分为一次性订阅和长期订阅两种类型，开发者需根据业务需求合理选择。微信小程序的订阅消息分“一次性订阅”和“长期订阅”两种方式：1、一次性订阅就是要用户点击同意一次消息订阅，才能发送一次信息。点击多少次就能发送多少次。2、长期订阅。服务端可以无限，但是教育、交通、医疗等行业才有长期订阅。
微信小程序一次性订阅踩坑记录
a7442358的专栏
09-16 3678
由于是一次性订阅，每次订阅只能发送一次信息，为了让用户更好的知道自己能否有接收订阅消息，以及可以接收订阅消息的次数，所以会采取数据库记录，每次订阅加一，每次发送减一。理论上这样的逻辑是没什么问题，但是却忽略了这种发送次数的控制权限是在微信端，而微信端会在以下情况下清空发送条数，导致数据库的记录和实际发送次数有出入。 1.用户禁止接收订阅消息 如果一个用户在设置中禁止了接收订阅消息，那么该小程序下的所有模板的订阅次数都将会清零。 2.总是保持以上选择，不再询问的订阅消息 如果一个用户首先选择了接收，中途又取消
微信小程序-订阅消息（一次性订阅）- deepseek生成整合
最新发布
weixin_58806609的博客
03-10 257
通知
微信小程序（订阅消息）功能
10-16
主要介绍了微信小程序订阅消息功能，本文给大家介绍的非常详细，具有一定的参考借鉴价值,需要的朋友可以参考下
微信小程序--订阅消息
尚可文武的博客
07-06 3842
微信小程序--订阅消息微信小程序之订阅消息(一次性订阅示例)第一步. 订阅消息模板第二步. 调用微信订阅消息服务：第三步 获取用户OpenId要获取openid就得先获取授权code，微信有接口：1.前端：2.java后端：我的做法：第四步 发送消息1.前端：2.java后端： 微信小程序之订阅消息(一次性订阅示例) 第一步. 订阅消息模板 可选公共模板，如果不满足可以自己申请； 记住模板Id,之后需要用到。 第二步. 调用微信订阅消息服务： 登录成功时调用微信订阅消息服务(也可以用在发送方法里边，我
微信小程序的订阅消息
sunjm666666的博客
10-24 1295
某项业务完成 需要给用户发消息时, 服务端是无法直接给某个小程序发消息的，那么怎么办呢?需要小程序服务端 告诉 微信服务端 让微信服务端帮小程序完成消息发送。
微信小程序之订阅消息
weixin_54000091的博客
08-12 5148
所以不管是通过云函数去发送模板消息还是在服务器中发送模板消息，最终都是要通过服务器。要么在服务器中直接调用发送模板消息的接口，要么服务器先调用云函数，然后云函数中去实现发送模板消息的逻辑。当然实际开发中还是需要服务器去调用该云函数的，因为在订阅消息时，用户信息都存在服务器上。最后多一句嘴，在我们真机调试时，在手机上订阅了消息之后，不管是服务器发送模板消息，还是通过云函数发送模板消息，都是接受不到的。最后因为上面我也说了，如果是通过云函数去发送模板消息，最终还是要通过服务器去调用该云函数。.........
微信小程序-仿喜马拉雅FM电台微信小程序
06-01
标题 "微信小程序-仿喜马拉雅FM电台微信小程序" 提示我们这个项目是关于创建一个类似于喜马拉雅FM的微信小程序。喜马拉雅FM是一款知名的在线音频分享平台，提供了丰富的有声书、音乐、新闻、课程等内容。因此，这个...
微信小程序-原生-使用微信开发者工具
09-05
通过微信小程序的服务消息功能，开发者可以向用户发送模板消息或者订阅消息，进行消息推送。 10. **调试与发布**： 微信开发者工具提供了多种调试模式，包括模拟器、真机调试、远程调试等，帮助开发者找出并修复...
微信小程序-微信小程序－滴滴拉屎
08-06
10. **推送通知**：如果小程序有消息推送需求，可以使用微信小程序的订阅消息功能，通过 wx.requestSubscribeMessage API 获取用户授权，然后在后台发送消息。 11. **调试与发布**：开发者可以使用微信开发者工具...
054-微信小程序-仿网易蜗牛读书.zip
06-11
6. **推送通知与消息提醒**：可以通过微信小程序的订阅消息功能，实现新书上架、阅读时长提醒等通知功能。 7. **动画效果**：为了提高用户体验，开发者可能需要使用`wx.createSelectorQuery`或`wx....
多人会议，uniapp - 微信小程序 - 腾讯云
10-20
本篇文章将深入探讨如何使用uniapp和微信小程序，结合腾讯云的服务，来实现这样的功能。 首先，uniapp是一个跨平台的开发框架，它允许开发者用一套代码库创建多端应用，包括iOS、Android、H5以及微信小程序等。它的...
【微信小程序企业级开发教程】订阅消息功能
李响
02-20 1153
文章目录1 功能介绍2 使用说明 1 功能介绍 消息能力是小程序能力中的重要组成，我们为开发者提供了订阅消息能力，以便实现服务的闭环和更优的体验。 订阅消息推送位置：服务通知 订阅消息下发条件：用户自主订阅 订阅消息卡片跳转能力：点击查看详情可跳转至该小程序的页面 订阅消息包括两种： 一次性订阅消息 一次性订阅消息用于解决用户使用小程序后，后续服务环节的通知问题。用户自主订阅后，开发者可不限时间地下发一条对应的服务消息；每条消息可单独订阅或退订。 长期订阅消息 一次性订阅消息可满足小程序的大部分服务场景需
微信小程序消息订阅功能
囚徒之困
05-17 2090
微信小程序 消息订阅
微信小程序订阅消息
王兆镇的博客
02-15 579
前端弹窗获取订阅消息授权。
小程序订阅消息
qq_51717117的博客
11-18 111
B站：1小时入门小程序云开发，模板消息(订阅消息)的推送_哔哩哔哩_bilibili 开通订阅消息功能，网址：小程序 (qq.com) 新建消息模板，获取模板id（可自定义也可用公用模板，普通用户暂时不能使用长期订阅） 新建一个小程序项目，不选用云开发，删除logs，index.wxml内容，index.js只保留Page({}) 代码思路： 1.获取用户的openid（用户在小程序里的身份证号） ...
微信小程序 -- 订阅消息wx.requestSubscribeMessage
09-15
微信小程序中的订阅消息功能可以通过wx.requestSubscribeMessage接口来实现。在使用该接口之前，需要先获取用户的openid和access_token，并且获取到需要发送的模板ID。接下来，你需要通过接口获取下发订阅消息的权限，并使用模板ID发送订阅消息。具体步骤如下： 1. 获取用户的openid和access_token。 2. 获取需要发送的模板ID。 3. 调用接口获取下发订阅消息的权限。 4. 使用模板ID发送订阅消息。 需要注意的是，当用户勾选了“总是保持以上选择，不再询问”选项后，下次调用wx.requestSubscribeMessage接口将不会再弹出授权弹窗，而是保持之前的选择。如果需要修改选择，用户需要在小程序设置中进行修改。 你可以在小程序中使用以下代码来实现订阅消息的功能： ```html <button bindtap="openPopup" class="openPopup">订阅消息</button> ``` 希望以上信息能够对你有帮助。如有任何问题，请随时提问。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值