swan.subscribeService

基础库 3.150.1 开始支持，低版本需做兼容处理。

解释：小程序消息订阅服务，包括取消订阅和查询订阅；订阅操作详见 form 表单。
Web 态说明：Web 态暂不支持消息订阅功能，调用该 API 会触发 success 回调，返回参数中的字段均为模拟值，仅供参考。

方法参数

Object object

object 参数说明

参数名类型是否必填默认值说明
templateIdString是-模板消息所用的模板库标题 ID ，与使用 form 表单订阅时，template-id 对应的值相同
subscribeIdString是-订阅唯一标识，与使用 form 表单订阅时，subscribe-id 对应的值相同
typeString否query订阅的操作类型：query（查询订阅）cancel（取消订阅）
successFunction否-接口调用成功的回调函数
failFunction否-接口调用失败的回调函数
completeFunction否-接口调用结束的回调函数（调用成功、失败都会执行）

success 返回参数说明

参数名类型说明
typeString订阅的操作类型：query（查询订阅）cancel（取消订阅）
form_idString对应提交 form 表单时返回的 formId 。当传入参数 type 为 query 时有此字段
statusNumber订阅状态；1：表示已订阅，0：表示已取消订阅，-1：表示未找到此订阅。当传入参数 type 为 query 时或 type 为 cancel 且未找到此订阅时有此字段
update_timeNumber订阅更新时间
app_keyString小程序唯一标识

示例

在开发者工具中打开

在开发者工具中打开

在 WEB IDE 中打开

代码示例

  • JS
  1. swan.subscribeService({
  2.     templateId: 'BD0003',
  3.     subscribeId: '8026',
  4.     type: 'query',
  5.     success(res) {
  6.         swan.showModal({
  7.             title: 'success',
  8.             content: JSON.stringify(res)
  9.         });
  10.     },
  11.     fail(err) {
  12.         swan.showModal({
  13.             title: 'fail',
  14.             content: JSON.stringify(err)
  15.         });
  16.     }
  17. })