튜토리얼

PHP 개발환경에서 팝빌 SDK를 추가하여 카카오톡 알림톡 전송 (SendATS) 함수를 구현하는 예시입니다.

1. POPBiLL SDK 추가

팝빌 PHP SDK를 추가하기 위해 Laravel 프로젝트의 composer.json 파일의 require 필드 오브젝트에 Popbill SDK 정보를 추가후 composer update 커멘드를 실행하여 popbill 패키지를 설치합니다.

 {
   "name" : "laravel/laravel" ,
   "type" : "project" ,
   "description" : "The Laravel Framework." ,
   "keywords" : [
     "framework" ,
     "laravel"
   ],
   "license" : "MIT" ,
   "require" : {
     "php" : "^7.1.3" ,
     "fideloper/proxy" : "^4.0" ,
     "laravel/framework" : "5.7.*" ,
     "laravel/tinker" : "^1.0" ,
     "linkhub/popbill" : "^1.63.3"
   },
   // 생략..

2. POPBiLL SDK 설정

팝빌 SDK의 환경설정을 위해 laravel 프로젝트 config 폴더에 popbill.php 파일을 추가합니다.

<?php
return [
  // 링크아이디
  'LinkID' => 'TESTER',

  // 비밀키
  'SecretKey' => 'SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I=',

  // 통신방식 기본은 CURL , PHP curl 모듈 사용에 문제가 있을 경우 STREAM 기재가능.
  // STREAM 사용시에는 php.ini의 allow_url_fopen = on 으로 설정해야함.
  'LINKHUB_COMM_MODE' => 'CURL',

  // 연동환경 설정, true-테스트, false-운영(Production), (기본값:false)
  'IsTest' => true,

  // 인증토큰 IP 검증 설정, true-사용, false-미사용, (기본값:true)
  'IPRestrictOnOff' => true,

  // 통신 IP 고정, true-사용, false-미사용, (기본값:false)
  'UseStaticIP' => false,

  // 로컬시스템 시간 사용여부, true-사용, false-미사용, (기본값:true)
  'UseLocalTimeYN' => true,
];

3. SendATS 기능 구현

Controller를 추가하고 클래스 생성자(__construct)에 팝빌 서비스 클래스 초기화 코드와 SendATS 함수를 추가합니다.

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use Linkhub\LinkhubException;
use Linkhub\Popbill\JoinForm;
use Linkhub\Popbill\CorpInfo;
use Linkhub\Popbill\ContactInfo;
use Linkhub\Popbill\ChargeInfo;
use Linkhub\Popbill\PopbillException;

use Linkhub\Popbill\PopbillKakao;
use Linkhub\Popbill\ENumKakaoType;


class TestController extends Controller
{
  public function __construct() {

    // 통신방식 설정
    define('LINKHUB_COMM_MODE', config('popbill.LINKHUB_COMM_MODE'));

    // 카카오톡 서비스 클래스 초기화
    $this->PopbillKakao = new PopbillKakao(config('popbill.LinkID'), config('popbill.SecretKey'));

    // 연동환경 설정값, 개발용(true), 상업용(false)
    $this->PopbillKakao->IsTest(config('popbill.IsTest'));

    // 인증토큰의 IP제한기능 사용여부, 권장(true)
    $this->PopbillKakao->IPRestrictOnOff(config('popbill.IPRestrictOnOff'));

    // 팝빌 API 서비스 고정 IP 사용여부, true-사용, false-미사용, 기본값(false)
    $this->PopbillKakao->UseStaticIP(config('popbill.UseStaticIP'));

    // 로컬시스템 시간 사용 여부 true(기본값) - 사용, false(미사용)
    $this->PopbillKakao->UseLocalTimeYN(config('popbill.UseLocalTimeYN'));
  }

  public function SendATS(){

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

    // 팝빌회원 아이디
    $testUserID = 'testkorea';

    // 템플릿 코드 - 템플릿 목록 조회 (ListATSTemplate) 함수의 반환항목 확인
    $templateCode = '019020000163';

    // 팝빌에 사전 등록된 발신번호
    $sender = '07043042991';

    // 알림톡 내용, 최대 1000자
    $content = '[ 팝빌 ]'.PHP_EOL;
    $content .= '신청하신 #{템플릿코드}에 대한 심사가 완료되어 승인 처리되었습니다.해당 템플릿으로 전송 가능합니다.'.PHP_EOL.PHP_EOL;
    $content .= '문의사항 있으시면 파트너센터로 편하게 연락주시기 바랍니다.'.PHP_EOL.PHP_EOL;
    $content .= '팝빌 파트너센터 : 1600-8536'.PHP_EOL;
    $content .= 'support@linkhubcorp.com'.PHP_EOL;

    // 대체문자 내용
    $altContent = '대체문자 내용';

    // 대체문자 전송유형 공백-미전송, A-대체문자내용 전송, C-알림톡내용 전송
    $altSendType = 'A';

    // 예약전송일시, yyyyMMddHHmmss
    $reserveDT = '';

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

    // 수신자 정보
    $receivers[] = array(
      // 수신번호
      'rcv' => '010111222',
      // 수신자명
      'rcvnm' => '수신자명'
    );

    // 버튼정보를 수정하지 않고 템플릿 신청시 기재한 버튼내용을 전송하는 경우, null처리.
    $buttons = null;

    // 버튼배열, 버튼링크URL에 #{템플릿변수}를 기재하여 승인받은 경우 URL 수정가능.
    // $buttons[] = array(
    //     // 버튼 표시명
    //     'n' => '템플릿 안내',
    //     // 버튼 유형, WL-웹링크, AL-앱링크, MD-메시지 전달, BK-봇키워드
    //     't' => 'WL',
    //     // 링크1, [앱링크] Android, [웹링크] Mobile
    //     'u1' => 'https://www.popbill.com',
    //     // 링크2, [앱링크] IOS, [웹링크] PC URL
    //     'u2' => 'http://www.popbill.com',
    // );

    try {
        $receiptNum = $this->PopbillKakao->SendATS($testCorpNum, $templateCode, $sender, $content,
          $altContent, $altSendType, $receivers, $reserveDT, $testUserID, $requestNum, $buttons);
    } catch(PopbillException $pe) {
        $code = $pe->getCode();
        $message = $pe->getMessage();
        return view('ReturnValue', ['code' => $code, 'message' => $message, 'value' => 'error']);
    }
    return view('ReturnValue', ['value' => $receiptNum]);
  }
}

알림톡 접수번호를 출력하는 페이지(ReturnValue.blade.php)를 resources/views/에 추가합니다.

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
    <title>Popbill Kakao Response.</title>
  </head>
  <body>
    <div>
    <p>Response</p>
      <fieldset>
        <ul>
          @if ( $value != "error" )
              <li>접수번호(ReceiptNum) :  {{ $value }}</li>
          @else
              <li>오류 코드(code) :  {{ $code }}</li>
              <li>오류 메시지(message) :  {{ $message }}</li>
          @endif
        </ul>
      </fieldset>
    </div>
  </body>
</html>

아래 코드를 참고하여 routes/web.php 파일에 route 부분을 입력합니다.

<?php
// 생략..

Route::get('/SendATS ', 'TestController@SendATS');

// 생략..

4. 결과 확인

함수 호출 반환 결과는 아래와 같습니다.
- 성공 : Response code 로 숫자 1 반환
- 실패 : PopbillException 으로 음의 정수 8자리 숫자값 오류코드와 오류메시지 반환 [오류코드]