消息配置

消息配置主要用于填写短信、邮件相关的配置信息,然后配合消息模板发送对应的消息进行通知。例如:告警通知、用户密码找回等

前置条件

部署ThingsKit平台,用户登录平台

说明:如果登录用户是超级管理员则配置的是平台的消息配置,如果是租户管理员则配置的是租户的消息配置,同时各自的消息配置数据都是隔离的,不会影响各自的调用。

操作步骤

点击左侧菜单,“消息管理 => 租户角色 =>新增角色”,完成信息输入,点击“确认”按钮。

新增短信配置

新增邮件配置

image-20220304113125113

说明:使用smtp协议,需要用户开启smtp协议,具体操作请查看对应邮件服务器说明

参数说明

参数输入描述
配置名称必填长度限制为30个字符。
消息类型必填目前只支持短信、邮件两种通知方式,后续将支持钉钉、微信、企业微信等通知方式。
平台类型必填(短信)目前只支持阿里、腾讯两种短信
accessKeyId必填(短信)阿里或腾讯发送短信的accessKey,获取相应的accessKey需要用户登录相应的平台自行获取
accessKeySecret必填(短信)阿里或腾讯发送短信的accessKeySecret,获取相应的accessKeySecret需要用户登录相应的平台自行获取
服务器地址必填(邮件)邮件服务器地址
端口必填(邮件)邮件服务器的端口
用户名必填(邮件)邮件发送的账号
密码必填(邮件)邮件发送的密码。注意:邮件发送的密码请用户根据使用的邮件服务器查看
状态必填只有开启的消息配置才会有用
备注非必填可以记录消息配置相关作用

消息模板

消息模板是用于通知用户的模板。用户可以根据以下模板参数配置适合自己的消息模板。

说明:平台将只会提供上述模板的变量属性,请申请模板的用户严格按照上述模板变量进行配置,否则将造成模板不可使用。

前置条件

用户已经配置好 消息配置,并且是**“启用”**状态

操作步骤

创建模板

点击左侧菜单,“消息管理 => 消息模板 => 新增模板配置”,完成信息输入,点击“确认”按钮。

image-20220304151131186

参数说明
模板用途提供参数
告警设备所属组织:organization 设备名称:device_name 告警等级:severity 告警类型:type 告警时间:createtime
手机登录验证码:code
密码找回验证码:code
测试模板

模板创建成功后,用户可以通过点击“发送”按钮,进行短信发送测试。发送成功后,可以在消息记录里面查看是否成功。

image-20220304152323090

参数说明
参数输入描述
消息类型必填项平台目前支持短信、邮件两种消息类型
配置名称必填项下拉选择:选择的之前通过消息配置创建的配置,且状态是已启用
模板名称必填项为当前模板定义的名称,长度限制32个字符
模板编号必填项该模板编号与短信平台的“模板CODE 或 模板ID”应保持一致
签名必填项该签名与短信平台申请的签名应保持一致
模板用途必填项模板用途:登录、忘记密码、告警通知

消息记录

消息记录包含了短信发送记录和邮件发送记录,同时可以通过记录查看是否成功及失败的原因。

操作步骤

短信发送记录

点击左侧菜单,“消息管理 => 消息记录”,默认展示短信发送记录,通过点击tab可切换到邮件发送记录。点击“查看”可以查看发送的变量属性和值。

image-20220304155406638

邮件发送记录

点击左侧菜单,“消息管理 => 消息记录”,默认展示短信发送记录,通过点击tab可切换到邮件发送记录。点击“查看”可以查看发送的变量属性和值。

image-20220304155406638