消息模块是模板 / 发件配置 / 通知记录的后台管理面:实际投递是异步的(发送受理经内部 JMS,出口为邮件服务与阿里云短信),受理成功不等于送达。场景手册(institutional/retail)没有对本模块建立任何端点正本——集成方最常见的动线(验证码发送)不在本模块,见下文「找对门」。
本页是 data-service
message模块接口的业务说明,非业务说明不在本页复述:
- OpenAPI JSON(可直接导入 Postman 等工具):
https://zxs.netbodycamera.com/main-service/v3/api-docs/message- 在线 Swagger 视图:data-service · 消息
- 端点全量清单(含权限点与中文说明):清单层 · message
参数、请求/响应字段、错误码等契约事实一律见上述 Swagger 与清单层;本页只讲业务语义与动线。
user-email/sendVerificationCode 与 user-phone-number/sendVerificationCode(业务语义见用户中心(业务));本模块只承载模板与发件配置。邮件记录面 CRUD(场景页未引用);契约见清单层 · email。
邮件发件(SMTP 类)配置 CRUD;契约见清单层。
邮件模板主档 CRUD;契约见清单层。
模板与发件配置的组合关联 CRUD(哪套模板用哪个发件出口);契约见清单层。
站内通知记录 CRUD;契约见清单层 · notification。
通知配置 CRUD;契约见清单层。
通知模板主档 CRUD;契约见清单层。
通知模板与配置的组合关联 CRUD;契约见清单层。
面向具体用户的通知送达/阅读记录 CRUD(用户通知收件箱的数据面);契约见清单层。
短信记录面 CRUD(场景页未引用);契约见清单层 · sms。
短信发件配置 CRUD——实际出口为阿里云短信(客户端实例缓存见运行时关联);契约见清单层。
短信套餐(计费/配额维度)主档 CRUD;契约见清单层。
短信模板主档 CRUD;契约见清单层。
短信模板与发件配置的组合关联 CRUD;契约见清单层。
本模块相关的运行时事实(全量表见 data-service 缓存,此处只点名不复述):
DySmsApiConfig#clientCache(最多 2 个实例、3 分钟过期、移除时关闭连接):阿里云短信 API AsyncClient 实例缓存——短信出口的客户端供给方。sendVerificationCode 的异步完成判据(发布消息 + 写缓存 ≠ 送达,未核验项见该族场景页「已知缺口」)。