튜토리얼

Node.js 개발환경에서 팝빌 SDK를 추가하고, 단문 문자 메시지 전송 (SendSMS) API를 호출하는 기본 과정을 단계별로 따라 해볼 수 있도록 구성된 가이드 입니다.

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.63.0"
  }
}

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 messageService = popbill.MessageService();

// 생략..

3. SendSMS 기능 구현

index.js 파일에 단문 문자 메시지 전송 (SendSMS) 함수 호출 코드를 추가합니다.

router.get('/sendSMS', function (req, res, next) {

    // 팝빌회원 사업자번호, '-' 제외 10자리
    var testCorpNum = '1234567890';

    // 발신번호
    var sendNum = '07043042991';

    // 발신자명
    var sendName = '발신자명';

    // 수신번호
    var receiveNum = '000111222';

    // 수신자명
    var receiveName = '수신자명';

    // 메시지 내용, 90Byte 초과시 길이가 조정되어 전송
    var contents = 'SMS 단건전송 메시지 테스트';

    // 예약전송일시(yyyyMMddHHmmss), 미기재시 즉시전송
    var reserveDT = '';

    // 광고문자 전송여부
    var adsYN = false;

    // 요청번호
    // 파트너가 전송 건에 대해 관리번호를 구성하여 관리하는 경우 사용.
    // 1~36자리로 구성. 영문, 숫자, 하이픈(-), 언더바(_)를 조합하여 팝빌 회원별로 중복되지 않도록 할당.
    var requestNum = "";

    messageService.sendSMS(testCorpNum, sendNum, receiveNum, receiveName, contents,
        reserveDT, adsYN, sendName, requestNum,
        function (receiptNum) {
            res.render('result', {path: req.path, result: receiptNum});
        }, function (Error) {
            res.render('response', {path: req.path, code: Error.code, message: Error.message});
        });
});

함수 호출결과 문자전송 접수번호(ReceiptNum)를 출력하는 "/views/result.ejs" 파일을 추가합니다.

<!DOCTYPE html>
<html>
<head>
    <title>Response</title>
</head>
<body>
<div>
    <p>Response</p>
    <br/>
    <fieldset>
        <legend><%= path %></legend>
        <ul>
            <li>ReceiptNum(접수번호) : <%= result %></li>
        </ul>
    </fieldset>
</div>
</body>
</html>

4. API 응답결과 확인

API 호출 응답결과는 다음과 같습니다.

구분	응답
성공	ReceiptNum(접수번호) : 18자리 문자열
실패	code : 오류코드 (8자리 음의 정수) [오류코드] message : 오류메시지