org.sophon.module.sms.integration.client.SmsClient Maven / Gradle / Ivy
package org.sophon.module.sms.integration.client;
import java.util.List;
import org.sophon.commons.core.KeyValue;
import org.sophon.module.sms.integration.client.dto.SmsInvokeResult;
import org.sophon.module.sms.integration.client.dto.SmsReceiveRespDTO;
import org.sophon.module.sms.integration.client.dto.SmsSendRespDTO;
import org.sophon.module.sms.integration.client.dto.SmsTemplateRespDTO;
/**
* 短信客户端，用于对接各短信平台的 SDK，实现短信发送等功能
* @author moushaokun
* @since time: 2023-03-13 10:53
*/
public interface SmsClient {
/**
* 发送消息
*
* @param bizNo 业务编号
* @param mobile 手机号
* @param apiTemplateId 短信 API 的模板编号
* @param templateParams 短信模板参数，参数顺序需要和短信平台上的参数配置顺序一致。通过 List 数组，保证参数的顺序
* @return 短信发送结果
*/
SmsInvokeResult sendSms(String bizNo, String mobile, String apiTemplateId,
List> templateParams);
/**
* 解析接收短信的接收结果
*
* @param text 结果
* @return 结果内容
*/
SmsInvokeResult> parseSmsReceiveStatus(String text);
/**
* 查询指定的短信模板
*
* @param apiTemplateId 短信 API 的模板编号
* @return 短信模板
*/
SmsInvokeResult getSmsTemplate(String apiTemplateId);
}