coolsms로 예약 신청 결과 문자로 전송하기

 

 

 

ㅁ coolsms란?

- 기업 및 개발자를 위한 메시지 발송 플랫폼으로, SMS, LMS, MMS, 카카오 알림톡 등의 메시지를 안정적이고 빠르게 발송할 수 있는 API 서비스입니다. 이 API를 쉽게 사용할 수 있도록 다양한 프로그래밍 언어용 SDK(라이브러리)도 함께 제공합니다.

 

 

 

ㅁ coolsms 홈페이지

- https://coolsms.co.kr/

세상에서 가장 안정적이고 빠른 메시지 발송 플랫폼 - 쿨에스엠에스

 

 

 

 

ㅁ 순서

 

(1) 홈페이지에서 회원가입을 하고 본인 인증을 한다.

 

(2) API Key 메뉴에서 "API KEY"와 "API SECRET KEY"를 복사해놓는다. (절대 유출 조심)

 

(3) SDK 다운로드 메뉴에서 Java용 SDK를 다운로드한다.

 

 

 

 

(4) 압축을 풀고 README를 열어서 의존성을 추가한다.

 

 

- Maven을 사용하는 경우 pom.xml에 저 dependency 구문을 추가하면 된다.

 

 

 

(5) maven-spring-demo 폴더 내의 src/main/java/net/nurigo/mavenspringdemo 폴더로 가면 예제가 있다.

 

 

 

 

(6) ExampleController.java를 열어본다.

 

 

package net.nurigo.mavenspringdemo;

import net.nurigo.sdk.NurigoApp;

import net.nurigo.sdk.message.exception.NurigoMessageNotReceivedException;

import net.nurigo.sdk.message.model.Balance;

import net.nurigo.sdk.message.model.Message;

import net.nurigo.sdk.message.model.StorageType;

import net.nurigo.sdk.message.request.MessageListRequest;

import net.nurigo.sdk.message.request.SingleMessageSendingRequest;

import net.nurigo.sdk.message.response.MessageListResponse;

import net.nurigo.sdk.message.response.MultipleDetailMessageSentResponse;

import net.nurigo.sdk.message.response.SingleMessageSentResponse;

import net.nurigo.sdk.message.service.DefaultMessageService;

import org.springframework.core.io.ClassPathResource;

import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.PostMapping;

import org.springframework.web.bind.annotation.RestController;

import java.io.File;

import java.io.IOException;

import java.time.Instant;

import java.time.LocalDateTime;

import java.time.ZoneId;

import java.time.ZoneOffset;

import java.time.format.DateTimeFormatter;

import java.util.ArrayList;

@RestController

public class ExampleController {

    final DefaultMessageService messageService;

    public ExampleController() {

        // 반드시 계정 내 등록된 유효한 API 키, API Secret Key를 입력해주셔야 합니다!

        this.messageService = NurigoApp.INSTANCE.initialize("INSERT_API_KEY", "INSERT_API_SECRET_KEY", "https://api.coolsms.co.kr");

    }

    /**

     * 메시지 조회 예제

     */

    @GetMapping("/get-message-list")

    public MessageListResponse getMessageList() {

        // 검색 조건이 있는 경우에 MessagListRequest를 초기화 하여 getMessageList 함수에 파라미터로 넣어서 검색할 수 있습니다!.

        // 수신번호와 발신번호는 반드시 -,* 등의 특수문자를 제거한 01012345678 형식으로 입력해주셔야 합니다!

        MessageListRequest request = new MessageListRequest();

        // 검색할 건 수, 값 미지정 시 20건 조회, 최대 500건 까지 설정 가능

        // request.setLimit(1);

        // 조회 후 다음 페이지로 넘어가려면 조회 당시 마지막의 messageId를 입력해주셔야 합니다!

        // request.setStartKey("메시지 ID");

        // request.setTo("검색할 수신번호");

        // request.setFrom("검색할 발신번호");

        // 메시지 상태 검색, PENDING은 대기 건, SENDING은 발송 중,COMPLETE는 발송완료, FAILED는 발송에 실패한 모든 건입니다.

        /*

        request.setStatus(MessageStatusType.PENDING);

        request.setStatus(MessageStatusType.SENDING);

        request.setStatus(MessageStatusType.COMPLETE);

        request.setStatus(MessageStatusType.FAILED);

        */

        // request.setMessageId("검색할 메시지 ID");

        // 검색할 메시지 목록

        /*

        ArrayList<String> messageIds = new ArrayList<>();

        messageIds.add("검색할 메시지 ID");

        request.setMessageIds(messageIds);

         */

        // 조회 할 메시지 유형 검색, 유형에 대한 값은 아래 내용을 참고해주세요!

        // SMS: 단문

        // LMS: 장문

        // MMS: 사진문자

        // ATA: 알림톡

        // CTA: 친구톡

        // CTI: 이미지 친구톡

        // NSA: 네이버 스마트알림

        // RCS_SMS: RCS 단문

        // RCS_LMS: RCS 장문

        // RCS_MMS: RCS 사진문자

        // RCS_TPL: RCS 템플릿문자

        // request.setType("조회 할 메시지 유형");

        return this.messageService.getMessageList(request);

    }

    /**

     * 단일 메시지 발송 예제

     */

    @PostMapping("/send-one")

    public SingleMessageSentResponse sendOne() {

        Message message = new Message();

        // 발신번호 및 수신번호는 반드시 01012345678 형태로 입력되어야 합니다.

        message.setFrom("발신번호 입력");

        message.setTo("수신번호 입력");

        message.setText("한글 45자, 영자 90자 이하 입력되면 자동으로 SMS타입의 메시지가 추가됩니다.");

        SingleMessageSentResponse response = this.messageService.sendOne(new SingleMessageSendingRequest(message));

        System.out.println(response);

        return response;

    }

    /**

     * MMS 발송 예제

     * 단일 발송, 여러 건 발송 상관없이 이용 가능

     */

    @PostMapping("/send-mms")

    public SingleMessageSentResponse sendMmsByResourcePath() throws IOException {

        ClassPathResource resource = new ClassPathResource("static/sample.jpg");

        File file = resource.getFile();

        String imageId = this.messageService.uploadFile(file, StorageType.MMS, null);

        Message message = new Message();

        // 발신번호 및 수신번호는 반드시 01012345678 형태로 입력되어야 합니다.

        message.setFrom("발신번호 입력");

        message.setTo("수신번호 입력");

        message.setText("한글 45자, 영자 90자 이하 입력되면 자동으로 SMS타입의 메시지가 추가됩니다.");

        message.setImageId(imageId);

        // 여러 건 메시지 발송일 경우 send many 예제와 동일하게 구성하여 발송할 수 있습니다.

        SingleMessageSentResponse response = this.messageService.sendOne(new SingleMessageSendingRequest(message));

        System.out.println(response);

        return response;

    }

    /**

     * 여러 메시지 발송 예제

     * 한 번 실행으로 최대 10,000건 까지의 메시지가 발송 가능합니다.

     */

    @PostMapping("/send-many")

    public MultipleDetailMessageSentResponse sendMany() {

        ArrayList<Message> messageList = new ArrayList<>();

        for (int i = 0; i < 3; i++) {

            Message message = new Message();

            // 발신번호 및 수신번호는 반드시 01012345678 형태로 입력되어야 합니다.

            message.setFrom("발신번호 입력");

            message.setTo("수신번호 입력");

            message.setText("한글 45자, 영자 90자 이하 입력되면 자동으로 SMS타입의 메시지가 추가됩니다." + i);

            // 메시지 건건 마다 사용자가 원하는 커스텀 값(특정 주문/결제 건의 ID를 넣는등)을 map 형태로 기입하여 전송 후 확인해볼 수 있습니다!

            /*HashMap<String, String> map = new HashMap<>();

            map.put("키 입력", "값 입력");

            message.setCustomFields(map);

            messageList.add(message);*/

        }

        try {

            // send 메소드로 단일 Message 객체를 넣어도 동작합니다!

            // 세 번째 파라미터인 showMessageList 값을 true로 설정할 경우 MultipleDetailMessageSentResponse에서 MessageList를 리턴하게 됩니다!

            MultipleDetailMessageSentResponse response = this.messageService.send(messageList, false, true);

            // 중복 수신번호를 허용하고 싶으실 경우 위 코드 대신 아래코드로 대체해 사용해보세요!

            //MultipleDetailMessageSentResponse response = this.messageService.send(messageList, true);

            System.out.println(response);

            return response;

        } catch (NurigoMessageNotReceivedException exception) {

            System.out.println(exception.getFailedMessageList());

            System.out.println(exception.getMessage());

        } catch (Exception exception) {

            System.out.println(exception.getMessage());

        }

        return null;

    }

    @PostMapping("/send-scheduled-messages")

    public MultipleDetailMessageSentResponse sendScheduledMessages() {

        ArrayList<Message> messageList = new ArrayList<>();

        for (int i = 0; i < 3; i++) {

            Message message = new Message();

            // 발신번호 및 수신번호는 반드시 01012345678 형태로 입력되어야 합니다.

            message.setFrom("발신번호 입력");

            message.setTo("수신번호 입력");

            message.setText("한글 45자, 영자 90자 이하 입력되면 자동으로 SMS타입의 메시지가 추가됩니다." + i);

            messageList.add(message);

        }

        try {

            // 과거 시간으로 예약 발송을 진행할 경우 즉시 발송처리 됩니다.

            LocalDateTime localDateTime = LocalDateTime.parse("2022-11-26 00:00:00", DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));

            ZoneOffset zoneOffset = ZoneId.systemDefault().getRules().getOffset(localDateTime);

            Instant instant = localDateTime.toInstant(zoneOffset);

            // 단일 발송도 지원하여 ArrayList<Message> 객체가 아닌 Message 단일 객체만 넣어도 동작합니다!

            MultipleDetailMessageSentResponse response = this.messageService.send(messageList, instant);

            // 중복 수신번호를 허용하고 싶으실 경우 위 코드 대신 아래코드로 대체해 사용해보세요!

            //MultipleDetailMessageSentResponse response = this.messageService.send(messageList, instant, true);

            System.out.println(response);

            return response;

        } catch (NurigoMessageNotReceivedException exception) {

            System.out.println(exception.getFailedMessageList());

            System.out.println(exception.getMessage());

        } catch (Exception exception) {

            System.out.println(exception.getMessage());

        }

        return null;

    }

    /**

     * 잔액 조회 예제

     */

    @GetMapping("/get-balance")

    public Balance getBalance() {

        Balance balance = this.messageService.getBalance();

        System.out.println(balance);

        return balance;

    }

}

 

 

 

 

- 실제로 사용하기 위해 DefaultMessageService 타입의 messageService 필드를 선언한다.

 

- 그리고 컨트롤러의 생성자에 위와 같이 작성한다. 

API Key 메뉴에서 복사해온 "API KEY"와 "API SECRET KEY"를 매개변수 자리에 작성한다.

 

 

 

 

 

- 메세지 하나를 보내기 위해서는 컨트롤러 내에 위와 같이 작성하면 된다. 

 

 

 

 

 

ㅁ 실제 구현

 

 

 

 

 

- import시 README 파일에 적혀있던 nurigo 패키지의 클래스로 한다.

(패키지명은 나중에 바뀔수 있으니 README 파일을 확인해야 한다.) 

 

- sendOne 메소드를 만들고, updateReservation 메소드에서 호출하도록 구현했다.

이때 실제 문자로 전송할 메세지를 String 타입의 변수에 담아서 넘겼다.

 

- sendOne 메소드에서 setFrom에 발신자 번호를, setTo에 수신자 번호를 01012345678의 형태로 작성한다.

 

 

 

 

 

 

 

- 문자가 성공적으로 전송되었다. 발신자 번호는 setFrom 메소드에 매개변수로 전달한 번호가 보여진다.

- 번호도용 방지를 위해 임의의 번호를 발신번호로 설정할 수는 없다. 

 

 

 

 

 

 

ㅁ 생성자가 겹치는 경우

- @RequiredArgsConstructor는 Lombok에서 제공하는 어노테이션으로 final이 붙은 필드에 대해 생성자를 자동으로 생성하기 때문에 내가 생성자를 만들면 충돌된다.

- @RequiredArgsConstructor를 지우고 생성자에서 필드들을 주입한다.