# 聚合推送

**Repository Path**: coder-hjq/jh-push

## Basic Information

- **Project Name**: 聚合推送
- **Description**: 聚合推送整合常用的短信渠道，多渠道聚合，提供统一API推送消息。包括但不限于短信，也可以集成钉钉、企微消息。项目目前刚开源不久，渠道较少，欢迎各位大佬PR。我也会尽快集成更多的渠道。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: http://push.lframework.com
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 17
- **Created**: 2024-07-11
- **Last Updated**: 2024-07-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### 项目背景
在对接不同的短信渠道时，经常会因为这些情况而头疼：
* 需要去查阅各个渠道的API文档。
* 需要引入各个渠道的SDK，有的时候没有SDK还要手动封装。
* 调完接口后，还要写策略查询短信发送情况。
* 不同的渠道API返回参数不一样，都要写代码处理。

聚合推送旨在为不同的短信渠道提供统一的聚合接口，并且加入主动回调通知。当然，目前也做不到聚合API的所有渠道的参数都相同（这个是目标）。只能说尽可能的缩小差异吧。

### 主要技术框架
#### 前端
* Vue 2.6.11
* ant-design-vue 1.7.8
* vxe-table 3.6.6
* vue-antd-admin

#### 后端
* Springboot 2.2.2.RELEASE
* MyBatis-plus 3.4.2
* SaToken 1.29.0
* HuTool 5.7.17
* Lombok 1.18.10
* EasyExcel 2.2.10（内置了两种导出excel方式：一次性导出、分段导出（只支持简单表头））
* Knife4j 2.0.9
* Druid 1.12.16
* PageHelper 1.3.1

### License
项目使用Apache 2.0许可证，请遵守此许可证的限制条件。

### 接口文档
<a href="https://gitee.com/lframework/jh-push/wikis" target="_blank">点此查看</a>

### 演示环境地址
<a href="http://push.lframework.com" target="_blank">点此进入</a>

### 已支持的渠道
* 阿里云短信
* 腾讯云短信

### 注意事项
#### 推送单状态说明
推送单状态：0-待推送 3-推送中 6-推送完成 9-推送失败
调用创建推送单接口后，如果status为9时，那么代表创建推送单失败。如果status为3，那么代表调用渠道短信接口成功。
#### 推送单状态什么时候变成6？
在所有的短信全部查询到批次明细结果了，那么推送单状态会变为6。
#### 推送单状态的作用？
简单来说：推送单的状态除了9以外，其他的值都无需关心。因为只有9代表着发送短信失败，而其他状态都代表着调用渠道得到发送短信接口成功。至于短信是否真的发送成功了，是需要看batchDetail的状态。