设置模块 SDK

@ray-js/wechat-ms-setting SDK 提供小程序订阅消息的能力和订阅消息列表的配置能力。

安装

yarn add @ray-js/wechat-ms-setting

// or

npm install @ray-js/wechat-ms-setting

微信订阅消息的发送开关

bizTypeConfig

请求参数

参数名	类型	描述	是否必传
device_id	string	设备 ID	true

返回参数

参数名	类型	描述
office_account_fans	boolean	是否关注公众号
use_applet_send	boolean	是否开启小程序推送
use_office_account_send	boolean	是否开启公众号推送

请求示例

import MsSettingApi from '@ray-js/wechat-ms-setting';

MsSettingApi.bizTypeConfig(device_id)
  .then(response => {
    console.log(response);
  })
  .catch(error => console.log(error));

返回示例

{
  office_account_fans: false;
  use_applet_send: false;
  use_office_account_send: false;
}

微信消息推送配置列表

msgConfigList

请求参数

参数名	类型	描述	是否必传
device_id	string	设备 ID	true

返回参数

参数名	类型	描述
config_v_o_list	ConfigListItem[]	微信消息推送配置列表

ConfigListItem 说明

参数名	类型	描述
prop_code	string	微信消息推送配置 Code
prop_value	string	微信消息推送配置 Value

微信消息推送配置 Code

• LOCK_SEND_REMOTE_APPLY_MSG_SWITCH：门锁是否发送远程开门请求消息
• LOCK_SEND_ALARM_MSG_SWITCH：门锁是否发送告警消息
• LOCK_SEND_OPEN_INSIDE_SWITCH：门锁是否发送内侧开门消息
• LOCK_SEND_OFFLINE_PWD_SWITCH：门锁是否发送离线密码开门消息
• LOCK_SEND_REMOTE_UNLOCK_SWITCH：门锁是否发送远程解锁消息
• LOCK_SEND_FINGER_UNLOCK_SWITCH：门锁是否发送指纹开门消息
• LOCK_SEND_TEMP_UNLOCK_SWITCH：门锁是否发送临时密码开门消息
• LOCK_SEND_CARD_UNLOCK_SWITCH：门锁是否发送门卡开门消息
• LOCK_SEND_FINGER_ALARM_SWITCH：门锁是否发送指纹胁迫消息
• LOCK_SEND_CLOSE_SWITCH：门锁是否发送关门消息

请求示例

import MsSettingApi from '@ray-js/wechat-ms-setting';

MsSettingApi.msgConfigList(device_id)
  .then(response => {
    console.log(response);
  })
  .catch(error => console.log(error));

返回示例

{
  config_v_o_list: [
    {
      prop_code: "LOCK_SEND_REMOTE_APPLY_MSG_SWITCH"
      prop_value: "true"
    },
    {
      prop_code: "LOCK_SEND_ALARM_MSG_SWITCH"
      prop_value: "true"
    }
  ]
}

更新微信消息推送配置

msgConfigUpdate

请求参数

参数名	类型	描述	是否必传
device_id	string	设备 ID	true
prop_code	string	微信消息推送配置 Code	true
prop_value	string	微信消息推送配置 Value	true

返回参数

返回参数为 Boolean 类型，表示是否更新成功。

请求示例

import MsSettingApi from '@ray-js/wechat-ms-setting';

MsSettingApi.msgConfigUpdate({
  device_id: 'xxxx',
  prop_code: 'LOCK_SEND_TEMP_UNLOCK_SWITCH',
  prop_value: 'true',
})
  .then(response => {
    console.log(response);
  })
  .catch(error => console.log(error));

返回示例

true;

小程序消息订阅时的回调函数

handleMiniProgramSubscribe

请求参数

参数名	类型	描述	是否必传
device_id	string	设备 ID	true
isAppletSend	bool	是否开启了小程序推送	true
success	(success) => void	订阅成功回调	false
fail	(fail) => void	订阅失败回调	false

请求示例

import MsSettingApi from '@ray-js/wechat-ms-setting';

MsSettingApi.handleMiniProgramPush({
  device_id: 'xxxx',
  isAppletSend: true,
  success: success => console.log(success),
  fail: fail => console.log(fail),
});