houzhongjian
2024-09-14 818a0170d8f2950d52cc7300a302356bbc523236
提交 | 用户 | 时间
e7c126 1 package com.iailab.module.system.service.sms;
H 2
3 import com.iailab.framework.common.pojo.PageResult;
4 import com.iailab.module.system.controller.admin.sms.vo.log.SmsLogPageReqVO;
5 import com.iailab.module.system.dal.dataobject.sms.SmsLogDO;
6 import com.iailab.module.system.dal.dataobject.sms.SmsTemplateDO;
7
8 import java.time.LocalDateTime;
9 import java.util.Map;
10
11 /**
12  * 短信日志 Service 接口
13  *
14  * @author zzf
15  * @date 13:48 2021/3/2
16  */
17 public interface SmsLogService {
18
19     /**
20      * 创建短信日志
21      *
22      * @param mobile 手机号
23      * @param userId 用户编号
24      * @param userType 用户类型
25      * @param isSend 是否发送
26      * @param template 短信模板
27      * @param templateContent 短信内容
28      * @param templateParams 短信参数
29      * @return 发送日志编号
30      */
31     Long createSmsLog(String mobile, Long userId, Integer userType, Boolean isSend,
32                       SmsTemplateDO template, String templateContent, Map<String, Object> templateParams);
33
34     /**
35      * 更新日志的发送结果
36      *
37      * @param id 日志编号
38      * @param success 发送是否成功
39      * @param apiSendCode 短信 API 发送结果的编码
40      * @param apiSendMsg 短信 API 发送失败的提示
41      * @param apiRequestId 短信 API 发送返回的唯一请求 ID
42      * @param apiSerialNo 短信 API 发送返回的序号
43      */
44     void updateSmsSendResult(Long id, Boolean success,
45                              String apiSendCode, String apiSendMsg,
46                              String apiRequestId, String apiSerialNo);
47
48     /**
49      * 更新日志的接收结果
50      *
51      * @param id 日志编号
52      * @param success 是否接收成功
53      * @param receiveTime 用户接收时间
54      * @param apiReceiveCode API 接收结果的编码
55      * @param apiReceiveMsg API 接收结果的说明
56      */
57     void updateSmsReceiveResult(Long id, Boolean success,
58                                 LocalDateTime receiveTime, String apiReceiveCode, String apiReceiveMsg);
59
60     /**
61      * 获得短信日志分页
62      *
63      * @param pageReqVO 分页查询
64      * @return 短信日志分页
65      */
66     PageResult<SmsLogDO> getSmsLogPage(SmsLogPageReqVO pageReqVO);
67
68 }