推送模板配置控制器文档

接口信息

• 控制器类: MerchantPushConfigController
• 包路径: com.qisheng.push.web
• 功能描述: 负责处理商户推送配置的增删改查和审核操作

类图

接口列表

1. 获取推送配置

• 请求方式: GET
• URL: /{merchantId}/push_config
• 功能: 获取商户的推送配置信息
• 参数:
  • merchantId: 商户ID (路径参数)
  • req: 推送配置查询请求对象 (查询参数)
• 返回: ObjectResponse
• 示例:

GET /82/push_config?module=ORDER_COMPLETE

2. 更新推送配置

• 请求方式: PATCH
• URL: /{merchantId}/push_config
• 功能: 更新商户的推送配置信息
• 参数:
  • merchantId: 商户ID (路径参数)
  • req: 推送配置更新请求对象 (请求体)
• 返回: ObjectResponse
• 示例:

PATCH /82/push_config
{
  "items": [
    {
      "id": 123,
      "name": "订单完成通知",
      "module": "ORDER_COMPLETE",
      "smsEnable": "Y",
      "wechatEnable": "Y",
      "smsContent": "尊敬的客户，您的订单已完成，感谢您的惠顾。"
    }
  ]
}

3. 初始化推送配置

• 请求方式: POST
• URL: /{merchantId}/push_config
• 功能: 初始化商户的推送配置信息
• 参数:
  • merchantId: 商户ID (路径参数)
  • req: 推送配置初始化请求对象 (请求体)
• 返回: ObjectResponse
• 示例:

POST /82/push_config
{
  "module": "ORDER_COMPLETE"
}

4. 推送配置审核

• 请求方式: PATCH
• URL: /{merchantId}/push_config_audit
• 功能: 提交推送配置审核
• 参数:
  • merchantId: 商户ID (路径参数)
  • req: 推送配置审核请求对象 (请求体)
• 返回: BaseResponse
• 示例:

PATCH /82/push_config_audit
{
  "id": 123,
  "smsContent": "尊敬的客户，您的订单已完成，感谢您的惠顾。"
}

5. 获取审核列表

• 请求方式: GET
• URL: /{merchantId}/mgj_push_config
• 功能: 获取推送配置审核列表
• 参数:
  • merchantId: 商户ID (路径参数)
  • req: 推送配置历史查询请求对象 (查询参数)
• 返回: PageResponse
• 示例:

GET /82/mgj_push_config?pageNum=1&pageSize=20&auditStatus=UNAUDIT

6. 更新审核状态

• 请求方式: POST
• URL: /{merchantId}/mgj_push_config
• 功能: 更新推送配置审核状态
• 参数:
  • merchantId: 商户ID (路径参数)
  • req: 推送配置历史更新请求对象 (请求体)
• 返回: BaseResponse
• 示例:

POST /82/mgj_push_config
{
  "id": 123,
  "auditStatus": "PASS",
  "auditContent": "审核通过"
}

调用流程

1. 获取推送配置流程

2. 更新推送配置流程

3. 推送配置审核流程

主要功能说明

1. 推送配置管理

• 获取配置: 根据模块名称获取推送配置
• 更新配置: 更新推送配置内容和启用状态
• 初始化配置: 为商户初始化默认的推送配置

2. 推送配置审核

• 提交审核: 将推送配置提交审核
• 获取审核列表: 查询待审核的推送配置
• 更新审核状态: 更新审核结果（通过/拒绝）

3. 配置项属性

• 短信启用: 是否启用短信推送
• 微信启用: 是否启用微信推送
• 短信微信绑定启用: 是否启用短信微信绑定推送
• 短信内容: 短信推送内容
• 微信内容: 微信推送内容

注意事项

1. 审核流程

• 修改短信内容需要提交审核
• 审核状态包括：未审核(UNAUDIT)、通过(PASS)、拒绝(REJECT)
• 审核通过后，配置才能生效

2. 消息通知

• 推送配置更新时，如果微信内容有变化，会发送MQ消息
• 提交审核时，会发送审核通知短信给管理员

3. 多语言支持

• 支持配置不同语言的推送内容
• 通过 language 字段区分不同语言版本

4. 默认配置

• 系统提供默认的推送配置模板
• 通过 isDefault 字段标识是否为默认配置