fxkh-txl-service/docs/短信管理模块API文档.md

# 短信管理模块 API 文档

## 1. 生日短信管理 (SmsBirthdayController)

### 1.1 修改生日短信配置
- **接口地址**: `/smsBirthday/edit`
- **请求方法**: `POST`
- **参数**:
  ```json
  {
    "id": "Long",
    "executionTmStr": "String",
    "status": "Integer",
    "template": "String",
    "createTm": "Date"
  }
  ```

### 1.2 查询生日短信配置
- **接口地址**: `/smsBirthday/get`
- **请求方法**: `GET`
- **参数**: 无

---

## 2. 短信日志管理 (SmsLogController)

### 2.1 分页查询短信日志
- **接口地址**: `/smsLog/page`
- **请求方法**: `POST`
- **参数**:
  ```json
  {
    "sendTm": "Date",
    "name": "String",
    "phone": "String",
    "remark": "String",
    "content": "String"
  }
  ```

### 2.2 新增短信日志
- **接口地址**: `/smsLog/add`
- **请求方法**: `POST`
- **参数**:
  ```json
  {
    "sendTm": "Date",
    "name": "String",
    "phone": "String",
    "remark": "String",
    "content": "String"
  }
  ```

### 2.3 修改短信日志
- **接口地址**: `/smsLog/edit`
- **请求方法**: `POST`
- **参数**:
  ```json
  {
    "id": "Long",
    "sendTm": "Date",
    "name": "String",
    "phone": "String",
    "remark": "String",
    "content": "String"
  }
  ```

### 2.4 删除短信日志
- **接口地址**: `/smsLog/del/{id}`
- **请求方法**: `GET`
- **参数**:
  - `id` (路径参数): Long

### 2.5 根据ID查询短信日志
- **接口地址**: `/smsLog/get/{id}`
- **请求方法**: `GET`
- **参数**:
  - `id` (路径参数): Long

---

## 3. 短信任务管理 (SmsTaskController)

### 3.1 分页查询短信任务
- **接口地址**: `/smsTask/page`
- **请求方法**: `POST`
- **参数**:
  ```json
  {
    "subjectName": "String",
    "startDate": "Date",
    "endDate": "Date",
    "executionTmStr": "String",
    "status": "Integer",
    "template": "String",
    "createTm": "Date"
  }
  ```

### 3.2 新增短信任务
- **接口地址**: `/smsTask/add`
- **请求方法**: `POST`
- **参数**:
  ```json
  {
    "subjectName": "String",
    "startDate": "Date",
    "endDate": "Date",
    "executionTmStr": "String",
    "status": "Integer",
    "template": "String",
    "createTm": "Date"
  }
  ```

### 3.3 修改短信任务
- **接口地址**: `/smsTask/edit`
- **请求方法**: `POST`
- **参数**:
  ```json
  {
    "id": "Long",
    "subjectName": "String",
    "startDate": "Date",
    "endDate": "Date",
    "executionTmStr": "String",
    "status": "Integer",
    "template": "String",
    "createTm": "Date"
  }
  ```

### 3.4 删除短信任务
- **接口地址**: `/smsTask/del/{id}`
- **请求方法**: `GET`
- **参数**:
  - `id` (路径参数): Long

### 3.5 根据ID查询短信任务
- **接口地址**: `/smsTask/get/{id}`
- **请求方法**: `GET`
- **参数**:
  - `id` (路径参数): Long

---

## 4. 专家通讯录管理 (SpecialistController)

### 4.1 分页查询专家通讯录
- **接口地址**: `/specialist/page`
- **请求方法**: `POST`
- **参数**:
  ```json
  {
    "name": "String",
    "position": "String",
    "birthday": "Date",
    "title": "String",
    "phone": "String",
    "status": "Integer",
    "createTm": "Date"
  }
  ```

### 4.2 新增专家通讯录
- **接口地址**: `/specialist/add`
- **请求方法**: `POST`
- **参数**:
  ```json
  {
    "name": "String",
    "position": "String",
    "birthday": "Date",
    "title": "String",
    "phone": "String",
    "status": "Integer",
    "createTm": "Date"
  }
  ```

### 4.3 修改专家通讯录
- **接口地址**: `/specialist/edit`
- **请求方法**: `POST`
- **参数**:
  ```json
  {
    "id": "Long",
    "name": "String",
    "position": "String",
    "birthday": "Date",
    "title": "String",
    "phone": "String",
    "status": "Integer",
    "createTm": "Date"
  }
  ```

### 4.4 删除专家通讯录
- **接口地址**: `/specialist/del/{id}`
- **请求方法**: `GET`
- **参数**:
  - `id` (路径参数): Long

### 4.5 根据ID查询专家通讯录
- **接口地址**: `/specialist/get/{id}`
- **请求方法**: `GET`
- **参数**:
  - `id` (路径参数): Long

---

## 说明

- 所有接口返回格式统一为 `ResultJson<T>`
- 参数验证使用 `@Validated` 注解，新增时使用 `Insert.class`，修改时使用 `Update.class`
- 生日短信管理模块特殊处理，只维护单条记录 (ID=1)
- 文档生成时间: 2025-09-23