短信接入中心

短信服务的创建，删除，修改，查询等功能，主要用于对短信服务的管理

Maven坐标

<dependency>
    <groupId>com.ikingtech.platform</groupId>
    <artifactId>sdk-sms-api</artifactId>
</dependency>

主要方法说明

1. 添加短信服务

在使用此接口之前，需要先确认新增的短信服务名称和AppId是否已经存在，如果存在，将会抛出一个FrameworkException异常。同时，需要通过Tools.Bean.copy() 方法将输入的SmsDTO转化为SmsDO对象，并且生成一个唯一的Id。

2. 删除短信服务

通过输入的短信服务Id，调用service的removeById()方法来进行删除。

3. 更新短信服务

在更新短信服务之前，同样需要检查更新后的名称和AppId是否已经存在。然后使用Tools.Bean.copy()方法将输入的SmsDTO转化为SmsDO对象，并执行更新操作。

4. 分页查询短信服务

根据输入的短信查询参数（SmsQueryParamDTO），调用service的listPage()方法，获取分页后的短信服务列表。

5. 查询所有短信服务

调用all(SmsQueryParamDTO queryParam)方法，返回所有的短信服务列表。

6. 查看短信服务详细信息

通过输入的短信服务Id，获取对应的短信服务详情。如果该服务不存在，则抛出FrameworkException异常。

7. 发送短信

根据输入的发送参数（SmsSendMessageParamDTO），构建请求并发送短信。

8. 获取短信模板列表

通过输入的短信Id，获取该Id所属的所有短信模板。

使用说明

🙅注意

下面的仅是使用示例，不代表所有用法。

import com.yourproject.sms.dto.SmsSendMessageParamDTO;
import com.yourproject.sms.service.SmsService;

public class SmsSenderExample {

    private final SmsService smsService;

    public SmsSenderExample(SmsService smsService) {
        this.smsService = smsService;
    }

    public void sendSms() {
        // 创建发送参数对象
        SmsSendMessageParamDTO smsSendMessageParamDTO = new SmsSendMessageParamDTO();

        // 设置短信服务ID
        smsSendMessageParamDTO.setSmsServiceId("your_sms_service_id");

        // 设置要发送的手机号
        smsSendMessageParamDTO.setPhoneNumber("1234567890");

        // 设置短信内容或模板ID
        smsSendMessageParamDTO.setMessage("This is a test message.");
        // 如果使用模板，需要设置模板ID及对应的参数
        // smsSendMessageParamDTO.setTemplateId("your_template_id");
        // smsSendMessageParamDTO.setTemplateParams(new HashMap<String, String>() {{
        //     put("param1", "value1");
        //     put("param2", "value2");
        // }});

        try {
            // 调用短信服务的发送方法
            smsService.send(smsSendMessageParamDTO);
            System.out.println("短信发送成功!");
        } catch (FrameworkException e) {
            System.err.println("短信发送失败，原因：" + e.getMessage());
        }
    }
}

注意事项

1.在使用此服务之前，请确保已正确配置了相关的依赖和参数。

2.配置短信模板，以及数据库表的准备工作。