接口日志

前言

接口管理、接口日志、消息模板、消息管理、我的消息的表结构关系如下：

E-R图

消息发送接口调用逻辑：

UML图

菜单介绍

接口管理

用于定义消息通过什么接口发送，消息包括但不限于：站内信、邮件、短信。接口管理的每条数据，对应UML图中的一个实现类。

「灯灯」已封装的接口：

1. 邮件接口
   • 邮件（任意厂商的邮件）
2. 短信接口
   • 腾讯云短信
   • 阿里云短信
   • 百度云短信
   • 创蓝短信
3. 站内信接口
   • 站内消息

若上述接口不能满足贵司的开发需求，可以先在接口管理页面新增一条接口数据，并在代码中编写接口代码。

接口日志

记录接口的发送情况。如：成功执行次数、失败执行次数、消息发送明细。

消息模板

全局消息模板，调用消息发送接口发送消息时，需要提前在此配置消息模板，方可发送消息。

消息模板依赖于接口管理，意思是在定义消息模板时，就必须确定该模板需要通过什么接口进行发送，若一个业务需要同时发送短信、邮件、站内信通知，则需要配置3个模板，并绑定3个接口

个性消息模板

租户自己的消息模板，当全局消息模板的内容不满足住户的需求时，可以在此修改个性消息模板。租户修改个性消息模板后，并不会影响其他租户的消息模板。

字段介绍

1. 成功次数

   对接口管理中各个接口执行成功次数的统计

2. 失败次数

   对接口管理中各个接口执行失败次数的统计

3. 请求参数

   调用发送消息接口时，传递的参数。

4. 接口返回

   第三方接口调用成功后，第三方返回的json

5. 异常信息

   接口调用失败的异常信息

6. 执行状态

   • 成功：执行实现类逻辑成功。只能代表成功调用了第三方接口，并不能保证用户一定能收到消息。

   • 失败：执行实现类逻辑失败。可能是调用接口异常、接口设置的参数设置异常等。

功能介绍

1. 删除

   删除接口日志以及日志执行记录

2. 查看

   查看日志的具体执行记录