xyz.migoo.framework.infra.service.developer.sms.SmsLogService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of migoo-webserver-infra-developer Show documentation
The newest version!
package xyz.migoo.framework.infra.service.developer.sms;

import xyz.migoo.framework.common.pojo.PageResult;
import xyz.migoo.framework.infra.controller.developer.sms.vo.log.SmsLogPageReqVO;
import xyz.migoo.framework.infra.dal.dataobject.developer.sms.SmsLogDO;
import xyz.migoo.framework.infra.dal.dataobject.developer.sms.SmsTemplateDO;

import java.time.LocalDateTime;
import java.util.Map;

public interface SmsLogService {

    /**
     * 创建短信日志
     *
     * @param mobile          手机号
     * @param userId          用户编号
     * @param userType        用户类型
     * @param isSend          是否发送
     * @param template        短信模板
     * @param templateContent 短信内容
     * @param templateParams  短信参数
     * @return 发送日志编号
     */
    Long createSmsLog(String mobile, Long userId, Integer userType, Boolean isSend,
                      SmsTemplateDO template, String templateContent, Map templateParams);

    /**
     * 更新日志的发送结果
     *
     * @param id           日志编号
     * @param success      发送是否成功
     * @param apiSendCode  短信 API 发送结果的编码
     * @param apiSendMsg   短信 API 发送失败的提示
     * @param apiRequestId 短信 API 发送返回的唯一请求 ID
     * @param apiSerialNo  短信 API 发送返回的序号
     */
    void updateSmsSendResult(Long id, Boolean success,
                             String apiSendCode, String apiSendMsg,
                             String apiRequestId, String apiSerialNo);

    /**
     * 更新日志的接收结果
     *
     * @param id             日志编号
     * @param success        是否接收成功
     * @param receiveTime    用户接收时间
     * @param apiReceiveCode API 接收结果的编码
     * @param apiReceiveMsg  API 接收结果的说明
     */
    void updateSmsReceiveResult(Long id, Boolean success, LocalDateTime receiveTime, String apiReceiveCode, String apiReceiveMsg);

    /**
     * 获得短信日志分页
     *
     * @param pageReqVO 分页查询
     * @return 短信日志分页
     */
    PageResult getSmsLogPage(SmsLogPageReqVO pageReqVO);

    SmsLogDO getData(Long id);
}