알림메시지 API

알림메시지는 쇼핑몰에서 특정 업무를 수행한 후 처리 완료를 안내하거나 쇼핑몰의 정보를 고객에게 전달하는 기능을 지원합니다. 알림메시지 종류에는 알림톡/SMS/LMS/알림함 기능을 제공합니다.

주요 기능

알림메시지의 종류는 알림톡, SMS/LMS, 알림함이 존재합니다.
타 모듈에서 알림메시지를 전송할 때 유형에 구분없이 알림메시지 전송 api 를 호출하게 되면 템플릿ID를 통해 알림메시지 유형을 선택해 전송합니다.
관리자 페이지에서 알림메시지의 템플릿을 등록할 수 있습니다.
SMS 발송 시 템플릿 내용이 90byte 가 넘어가면 LMS 로 전송됩니다.

번호

구분

설명

1

알림메시지 다건 전송

알림메세지를 알림메세지 종류에 상관없이 다건 전송할 수 있습니다.

2

알림메시지 단건 전송

알림메세지를 전송합니다.

템플릿 정보 데이터베이스에서 템플릿을 조회합니다. 템플릿은 현재 사용 중인 상태여야 합니다.
템플릿 변수가 공통코드(ST010)의 코드와 맞는 게 있으면 매핑합니다.
템플릿의 기본알림방법코드가 공통코드(CH009)에 맞는 Sender 를 선택합니다.
알림메세지를 전송합니다.
- 템플릿 내용 변수에 넘어온 요청 파라미터로 템플릿 내용을 치환합니다.
- 템플릿 정보에 버튼 정보가 존재하면 버튼 내용을 치환합니다.
- 알림톡/SMS/LMS 전송 시 x2bee-common 을 호출하고, 알림함은 x2bee-member 를 호출합니다.

API	설명	Server	매소드	비고
알림메시지 다건 전송	알림메시지 유형 구분 없이 알림메시지를 다건 전송합니다.	Common	POST
알림메시지 단건 전송	알림메시지를 단건 전송합니다.	Common	POST

명칭	설명	비고
SMS(Short Message Service)	이동통신사에서 제공하는 문자 메시지 전송 서비스 중 하나입니다. 한글 기준 약 40자 정도 발송 가능합니다.
LMS(Long Message Service)	이동통신사에서 제공하는 문자 메시지 전송 서비스 중 하나입니다. 한글 기준 약 500자 정도 발송 가능합니다.
알림톡	기업 고객이 사용자에게 정보성 카카오톡 메시지를 발송하는 서비스입니다.

•타 모듈에서 알림메세지 전송 api 를 호출 시 x2bee-common 공통의 MessageCommonDto 를 상속받아 필수 값을 넣어서 호출해야 합니다.
- 알림톡 필수 값: 템플릿ID, 수신번호
- SMS/LMS 필수 값: 템플릿ID, 수신번호
- 알림함 필수 값: 템플릿ID, 회원번호
넘어온 템플릿ID에 맞는 사용 중인 템플릿이 존재해야 전송 가능합니다.
공통코드 ST010(사이트기타정보) 에 해당하는 코드 값이 템플릿 내용의 변수에 존재할 시 자동으로 매핑합니다. (요청 파라미터에 넣을 필요 X)
템플릿 정보의 기본알림방법코드와 맞는 공통코드 CH009(기본알림방법코드) 에 해당하는 방식으로 메시지를 전송합니다.
X2bee-common 프로젝트를 호출해 요청 파라미터 DTO 를 템플릿 내용에 매핑합니다.
알림톡, SMS/LMS 전송 시 x2bee-common 프로젝트를 호출하고, 알림함 등록 시 x2bee-member 프로젝트를 호출합니다.
알림톡, SMS/LMS 전송 시 전송 정보를 저장하고 싶으면 참조 값1~5 (ref1Val ~ ref5Val) 에 데이터를 넣으면 가능합니다.
알림톡, SMS/LMS 전송 후 각 ST_NAVER_TMS_SND_HIST, ST_NAVER_SMS_SND_HIST 테이블에서 이력을 확인할 수 있습니다.