튜토리얼
Node.js 개발환경에서 팝빌 SDK를 추가하여 카카오톡 알림톡 전송 (SendATS) 함수를 구현하는 예시입니다.
1. POPBiLL SDK 추가
팝빌 Node.js SDK를 추가하기 위해 Express 프로젝트 "package.json" 파일에 팝빌 Node.js SDK 정보를 추가하고 npm install 또는 npm update를 진행합니다.
{
"name": "Popbill TEST",
"version": "0.0.0",
"private": true,
"scripts": {
"start": "node ./bin/www"
},
"dependencies": {
"cookie-parser": "~1.4.3",
"debug": "~2.6.9",
"ejs": "~2.5.7",
"express": "~4.16.0",
"http-errors": "~1.6.2",
"morgan": "~1.9.0",
"popbill": "^1.60.4"
}
}2. POPBiLL SDK 설정
프로젝트 routes 폴더 하위의 index.js 파일에 연동신청시 발급받은 API Key 를 변수로 선언하고 아래의 코드를 참조하여 카카오톡 서비스 객체를 생성 합니다.
// 생략..
var popbill = require('popbill');
popbill.config( {
// 링크아이디
LinkID :'TESTER',
// 비밀키
SecretKey : 'SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3T=',
// 연동환경 설정, true-테스트, false-운영(Production), (기본값:false)
IsTest : true,
// 통신 IP 고정, true-사용, false-미사용, (기본값:true)
IPRestrictOnOff: true,
// 팝빌 API 서비스 고정 IP 사용여부, 기본값(false)
UseStaticIP: false,
// 로컬시스템 시간 사용여부, true-사용, false-미사용, (기본값:true)
UseLocalTimeYN: true,
defaultErrorHandler: function (Error) {
console.log('Error Occur : [' + Error.code + '] ' + Error.message);
}
});
// 카카오톡 서비스 객체 초기화
var kakaoService = popbill.KakaoService();
// 생략..
3. SendATS 기능 구현
index.js 파일에 카카오톡 알림톡 전송 (SendATS) 함수 호출 코드를 추가합니다.
router.get('/sendATS', function (req, res, next) {
// 팝빌회원 사업자번호, '-' 제외 10자리
var testCorpNum = '1234567890';
// 알림톡 템플릿코드
// 승인된 알림톡 템플릿 코드는 ListATStemplate API, GetATSTemplateMgtURL API, 혹은 팝빌사이트에서 확인이 가능합니다.
var templateCode = '019020000163';
// 발신번호 (팝빌에 등록된 발신번호만 이용가능)
var snd = '070-4304-2992';
// 알림톡 내용 (최대 1000자)
var content = '[ 팝빌 ]\n';
content += '신청하신 #{템플릿코드}에 대한 심사가 완료되어 승인 처리되었습니다.\n';
content += '해당 템플릿으로 전송 가능합니다.\n\n';
content += '문의사항 있으시면 파트너센터로 편하게 연락주시기 바랍니다.\n\n';
content += '팝빌 파트너센터 : 1600-8536\n';
content += 'support@linkhubcorp.com';
// 대체문자 내용 (최대 2000byte)
var altContent = '알림톡 대체 문자';
// 대체문자 유형 [공백-미전송, C-알림톡내용, A-대체문자내용]
var altSendType = 'A';
// 예약일시 (작성일시 : yyyyMMddHHmmss)
var sndDT = '';
// 수신번호
var receiver = '010111222';
// 수신자 이름
var receiverName = 'partner';
// 팝빌회원 아이디
var UserID = 'testkorea';
// 요청번호
// 파트너가 전송 건에 대해 관리번호를 구성하여 관리하는 경우 사용.
// 1~36자리로 구성. 영문, 숫자, 하이픈(-), 언더바(_)를 조합하여 팝빌 회원별로 중복되지 않도록 할당.
var requestNum = "";
// 알림톡 버튼정보를 템플릿 신청시 기재한 버튼정보와 동일하게 전송하는 경우 btns를 null 처리.
var btns = null;
// 알림톡 버튼 URL에 #{템플릿변수}를 기재한경우 템플릿변수 영역을 변경하여 버튼정보 구성
// var btns = [
// {
// n: '템플릿 안내', //버튼명
// t: 'WL', //버튼유형 [WL-웹링크, AL-앱링크, MD-메시지전달, BK-봇키워드]
// u1: 'https://www.popbill.com', //[앱링크-Android, 웹링크-Mobile]
// u2: 'http://www.popbill.com' //[앱링크-IOS, 웹링크-PC URL]
// }
// ];
kakaoService.sendATS_one(testCorpNum, templateCode, snd, content, altContent, altSendType, sndDT, receiver, receiverName, UserID, requestNum, btns,
function (receiptNum) {
res.render('result', {path: req.path, receiptNum: receiptNum});
}, function (Error) {
res.render('response', {path: req.path, code: Error.code, message: Error.message});
});
});함수 호출결과 코드와 메시지를 출력하는 "/views/result.ejs" 파일을 추가합니다.
<!DOCTYPE html>
<html>
<head>
<title>Popbill Kakao</title>
</head>
<body>
<div>
<p>Response</p>
<br/>
<fieldset>
<legend><%= path %></legend>
<ul>
<li>ReceiptNum(접수번호) : <%= result %></li>
</ul>
</fieldset>
</div>
</body>
</html>4. 결과 확인
함수 호출 반환 결과는 아래와 같습니다.
- 성공 : Response code 로 숫자 1 반환
- 실패 : PopbillException 으로 음의 정수 8자리 숫자값 오류코드와 오류메시지 반환 [오류코드]