튜토리얼
Java 개발환경에서 팝빌 SDK를 추가하여 카카오톡 알림톡 전송 (SendATS) 함수를 구현하는 예시입니다.
1. POPBiLL SDK 추가
① 팝빌 연동자료실에서 Java - JSP SDK 예제코드 다운로드 후 압축을 해제합니다.
② SDK 예제코드의 WEB-INF/lib/ 폴더의 3개 jar파일 구현할 프로젝트의 라이브러리 폴더에 복사합니다.
2. POPBiLL SDK 설정
프로젝트 경로에 카카오톡 서비스 연동환경 설정을 위한 "$CATALINA_HOME/webapps/ROOT/common.jsp" 파일을 생성하고 아래의 코드를 참고하여 API Key 를 설정합니다.
<%-- 카카오톡 서비스 객체 초기화 --%>
<jsp:useBean id="kakaoService" scope="application" class="com.popbill.api.kakao.KakaoServiceImp"/>
<%-- 링크아이디 --%>
<jsp:setProperty name="kakaoService" property="linkID" value="TESTER"/>
<%-- 비밀키 --%>
<jsp:setProperty name="kakaoService" property="secretKey" value="SwWxqU+0TExEXy/9TVjKPExI2VTUMMSLZtJf3Ed8q3I="/>
<%-- 연동환경 설정, true-테스트, false-운영(Production), (기본값:false) --%>
<jsp:setProperty name="kakaoService" property="test" value="true"/>
<%-- 인증토큰 IP 검증 설정, true-사용, false-미사용, (기본값:true) --%>
<jsp:setProperty name="kakaoService" property="IPRestrictOnOff" value="true"/>
<%-- 통신 IP 고정, true-사용, false-미사용, (기본값:false) --%>
<jsp:setProperty name="kakaoService" property="useStaticIP" value="false"/>
<%-- 로컬시스템 시간 사용여부, true-사용, false-미사용, (기본값:true) --%<
<jsp:setProperty name="kakaoService" property="useLocalTimeYN" value="true"/>3. SendATS 기능 구현
"$CATALINA_HOME/webapps/ROOT/SendATS.jsp" 파일을 생성하고, 아래의 코드를 참조하여 함수 호출 코드를 추가합니다.
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8" />
<title>Popbill Kakao Example</title>
</head>
<%@ include file="common.jsp" %>
<%@page import="java.util.Date" %>
<%@page import="java.text.SimpleDateFormat" %>
<%@page import="com.popbill.api.PopbillException" %>
<%@page import="com.popbill.api.kakao.KakaoButton" %>
<%
/*
* 알림톡 전송을 요청합니다.
* 사전에 승인된 템플릿의 내용과 알림톡 전송내용(content)이 다를 경우 전송실패 처리됩니다.
*/
// 팝빌회원 사업자번호
String testCorpNum = "1234567890";
// 알림톡 템플릿코드
// 승인된 알림톡 템플릿 코드는 ListATStemplate API, GetATSTemplateMgtURL API, 또는 팝빌사이트에서 확인 가능합니다.
String templateCode = "019020000163";
//발신번호 (팝빌에 등록된 발신번호만 이용가능)
String senderNum = "07043042991";
// 알림톡 내용 (최대 1000자)
String content = "[ 팝빌 ]\n";
content += "신청하신 #{템플릿코드}에 대한 심사가 완료되어 승인 처리되었습니다.\n";
content += "해당 템플릿으로 전송 가능합니다.\n\n";
content += "문의사항 있으시면 파트너센터로 편하게 연락주시기 바랍니다.\n\n";
content += "팝빌 파트너센터 : 1600-8536\n";
content += "support@linkhubcorp.com";
// 대체문자 내용 (최대 2000byte)
String altContent = "대체문자 내용";
// 대체문자 유형 [공백-미전송, C-알림톡내용, A-대체문자내용]
String altSendType = "A";
// 수신번호
String receiverNum = "010111222";
// 수신자 이름
String receiverName = "수신자명";
// 예약일시 (작성형식 : yyyyMMddHHmmss)
String sndDT = "";
// 팝빌회원 아이디
String testUserID = "testkorea";
// 요청번호
// 파트너가 전송 건에 대해 관리번호를 구성하여 관리하는 경우 사용.
// 1~36자리로 구성. 영문, 숫자, 하이픈(-), 언더바(_)를 조합하여 팝빌 회원별로 중복되지 않도록 할당.
String requestNum = "";
// 접수번호
String receiptNum = null;
// 알림톡 버튼정보를 템플릿 신청시 기재한 버튼정보와 동일하게 전송하는 경우 null 처리.
KakaoButton[] btns = null;
// 알림톡 버튼 URL에 #{템플릿변수}를 기재한경우 템플릿변수 영역을 변경하여 버튼정보 구성
// KakaoButton[] btns = new KakaoButton[1];
//
// KakaoButton button = new KakaoButton();
// button.setN("버튼명"); // 버튼명
// button.setT("WL"); // 버튼타입
// button.setU1("https://www.popbill.com"); // 버튼링크1
// button.setU2("http://test.popbill.com"); // 버튼링크2
// btns[0] = button;
try {
receiptNum = kakaoService.sendATS(testCorpNum, templateCode, senderNum, content, altContent, altSendType,
receiverNum, receiverName, sndDT, testUserID, requestNum, btns);
} catch (PopbillException pe) {
//적절한 오류 처리를 합니다. pe.getCode() 로 오류코드를 확인하고, pe.getMessage()로 관련 오류메시지를 확인합니다.
System.out.println("오류코드 " + pe.getCode());
System.out.println("오류메시지 " + pe.getMessage());
throw pe;
}
%>
<body>
<p>Response</p>
<br>
<fieldset>
<legend>알림톡 전송</legend>
<ul>
<li>receiptNum (접수번호) : <%=receiptNum%></li>
</ul>
</fieldset>
</body>
</html>4. 결과 확인
함수 호출 반환 결과는 아래와 같습니다.
- 성공 : ReceiptNum(접수번호) 18자리 문자열 반환
- 실패 : PopbillException 음의 정수 8자리 숫자값 오류코드와 오류메시지 반환 [오류코드]