1. 信使、分级推送及代理服务 使用文档
信使、分级推送及代理服务
- 信使服务:专门提供发送消息能力的服务,比如短信、email
- 分级推送服务:根据业务设置发送消息的场景,调用信使的消息能力
- 代理服务:把业务数据发给分级推送服务
1.1. 信使配置
信使模块下有三个菜单:推送任务、推送通道、推送记录
配置的步骤如下:
- 先要配置推送通道
- 在根据推送通道配置推送任务
- 由分级推送触发信使的推送任务后产生推送记录
1.1.1. 推送记录
推送记录顾名思义,就是我们每个信使任务触发的消息推送记录,其中列表包含内容如下:
- 可看到接收消息的用户和接收的内容,
- 记录编号是推送记录的记录编号,
- 任务编号是推送任务的标识
1.1.2. 推送通道
这个是我们推送的具体能力,目前我们当下版本接入的有短信推送和邮件推送,后续会迭代接入APP推送、钉钉接入的推送、微信公众号的推送等业务需求推送能力。
配置步骤如下:
- 输入推送通道名称
- 选择推送服务商,目前可用的有华为云短信,阿里云短信,SMTP协议的邮件发送
- SMTP协议的邮件发送:邮件推送能力配置的是发件人,所以需要客户现场提供发件人邮箱的可用信息
- 华为云短信、阿里云短信:根据客户申请的模板信息进行对应的配置,在阿里云控制台、华为云控制台能找到全部对应的信息
以上是我们当下支持的信使的业务推送能力,接下来,我们需要基于这些能力去配置对应的推送业务。
1.1.3. 推送任务
推送任务和推送通道的关系好比人和餐具,推送通道就像是餐具,固定那么几种,而推送任务就像是使用餐具的人,可以是很多,所以一个推送通道可以对接多个推送任务,这个关系要清楚。
添加推送任务的时候,选择我们刚刚添加的推送通道,发送方式可选择“立即发送”、“定时发送”
1.2. 分级推送配置
按上述配置完毕后,已经完成了基本的信使配置,然而我们也需要通过配置自己的发送场景业务来对接MixIot的数据,从而达到发送消息的目的,这个配置就是分级推送。
分级推送模块下有两个菜单:推送任务、推送模板
配置的步骤如下:
- 先要配置推送模板
- 在根据推送模板配置推送任务
1.2.1. 推送模板
添加推送模板的时候可选择不同的业务场景,选定一个场景后,其他表单项自动填充,然后提交即可,举例如下:
1.2.2. 推送任务
在完成推送模板创建后,可根据推送模板创建推送任务,此时创建任务的时候需要选择消息类型,消息类型在任务列表中保持是唯一的,如果重复添加则会报出如下提示:
换言之,一个发送场景业务类型只能配一个任务。其他表单项按照实际业务场景需求配置即可。
1.3. 代理配置
按上述配置完毕后,已经完成了基本的信使配置、分级推送配置,接下来就是在代理服务中事件的监听即可完成整体业务流的配置。
如上所示,这里配置了多个代理事件,我们目前关注的都会在代理服务中默认配置好的,如果没有配置好,请按如下完成代理服务的配置
1.3.1. 维保到期事件代理
代理事件: mixtimer_event
匹配参数: {"block": "mixtimer"}
回调地址: http://mixgrading/mixgrading/api
回调参数: {"action": "send_timer_message", "actionid": "", "method": "http"}
1.3.2. retainer历程事件代理
代理事件: retainer_open
匹配参数: {"block": "retainer"}
回调地址: http://mixgrading/mixgrading/api
回调参数: {"action": "send_retainer_message", "actionid": "", "method": "http"}
代理事件: retainer_close
匹配参数: {"block": "retainer"}
回调地址: http://mixgrading/mixgrading/api
回调参数: {"action": "send_retainer_message", "actionid": "", "method": "http"}
1.3.3. 适配器上下线事件代理
代理事件: terminal_online
匹配参数: {"block": "mapping"}
回调地址: http://mixgrading/mixgrading/api
回调参数: {"action": "send_terminal_status", "actionid": "", "method": "http"}
代理事件: terminal_offline
匹配参数: {"block": "mapping"}
回调地址: http://mixgrading/mixgrading/api
回调参数: {"action": "send_terminal_status", "actionid": "", "method": "http"}
1.3.4. 报表产生事件代理
代理事件: send_report
匹配参数: {"block": "report"}
回调地址: http://mixgrading/mixgrading/api
回调参数: {"action": "send_report_message", "actionid": "", "method": "http"}
1.3.5. 新维保(设备管理)到期事件代理
代理事件: equipmanage_event
匹配参数: {"block": "equipmanage"}
回调地址: http://mixgrading/mixgrading/api
回调参数: {"action": "send_equipment_manager_message", "actionid": "", "method": "http"}
1.4. 附录
1.4.1. 短信模板配置说明
由于华为云短信的能力总在更新,故我们现在设置了多套华为云短信模板,业务需要的话请在华为云的管理平台上按如下配置进行添加。
华为云短信官方文档:
1.4.1.1. 历程模板
模板内容: 尊敬用户您好,您的设备编号: \${1},设备名称: \${2}于\${3}生成了\${4}报警,请及时处理。
所属签名: 智物联(请选择你自己签名)
变量1: 变量类型:其他号码
变量2: 变量类型:其他, 变量说明:设备名称
变量3: 变量类型:日期时间
变量4: 变量类型:其他, 变量说明:报警内容
申请说明: 用于设备远程监控告警业务通知使用
模板类型: 通知类
1.4.1.2. 适配器上下线
模板内容: 您的采集网关\${1}(\${2})于\${3}\${4};
所属签名: 智物联(请选择你自己签名)
变量1: 变量类型:其他, 变量说明:网关设备名称
变量2: 变量类型:其他号码
变量3: 变量类型:日期时间
变量4: 变量类型:其他, 变量说明:上线、离线
申请说明: 字数要在40字及其以上 举例:您的采集网关AX0812(OBJ1824074700832)于15:56:40离线;
模板类型: 通知类
1.4.1.3. 维保消息
模板内容: 您的设备:\${1}需要于\${2}进行:\${3},当前剩余时间为:\${4},请及时处理;
所属签名: 智物联(请选择你自己签名)
变量1: 变量类型:其他, 变量说明:设备名称:空压机001号
变量2: 变量类型:日期时间
变量3: 变量类型:其他, 变量说明:维保项目说明:达利维保任务单
变量4: 变量类型:其他, 变量说明:剩余操作时长:1H2M3S(1小时2分钟3秒)
申请说明: 维保快到期的时候的通知
模板类型: 通知类
1.4.1.4. 报表消息
模板内容: 您的\${1}的报表已于\${2}生成,请查阅;
所属签名: 智物联(请选择你自己签名)
变量1: 变量类型:其他, 变量说明:报表项目名称:一车间月度生产报表变量2: 变量类型:日期时间
申请说明: 报表文件生成后发起通知
模板类型: 通知类
1.4.1.5. 设备管理消息
模板内容: 您在:\${1}\${2}的设备:\${3}需要进行:\${4},当前剩余时间为:\${5}
所属签名: 智物联(请选择你自己签名)
变量1: 变量类型:其他, 变量说明:工厂名称:北区1车间
变量2: 变量类型:其他, 变量说明:坐标信息
变量3: 变量类型:其他, 变量说明:设备名称:空压机1号
变量4: 变量类型:其他, 变量说明:维保内容说明:检修维护
变量5: 变量类型:其他, 变量说明:剩余时长:1H2M3S(1小时2分钟3秒)
申请说明: 设备维保即将到期发起通知
模板类型: 通知类