튜토리얼
PHP 개발환경에서 팝빌 SDK를 추가하여 카카오톡 알림톡 전송 (SendATS) 함수를 구현하는 예시입니다.
1. POPBiLL SDK 추가 및 설정
① 팝빌 연동자료실에서 PHP SDK 예제코드 다운로드 후 압축을 해제합니다.
② 압축해제한 SDK 예제코드에 포함된 Popbill/ 폴더를 웹사이트 Root Directory 경로에 복사합니다.
③ 서비스 연동환경 설정을 위해 프로젝트 Root Directory에 common.php 파일을 생성하고 아래의 코드를 참고하여 API Key 를 설정합니다.
<?php
require_once './Popbill/PopbillKakao.php';
// 링크아이디
$LinkID = 'TESTER';
// 비밀키
$SecretKey = 'SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I=';
// 통신방식 기본은 CURL , curl 사용에 문제가 있을경우 STREAM 사용가능.
// STREAM 사용시에는 php.ini의 allow_url_fopen = on 으로 설정해야함.
define('LINKHUB_COMM_MODE','CURL');
// 서비스 객체 초기화
$KakaoService = new KakaoService($LinkID, $SecretKey);
// 연동환경 설정, true-테스트, false-운영(Production), (기본값:false)
$KakaoService->IsTest(true);
// 인증토큰 IP 검증 설정, true-사용, false-미사용, (기본값:true)
$KakaoService->IPRestrictOnOff(true);
// 통신 IP 고정, true-사용, false-미사용, (기본값:false)
$KakaoService->UseStaticIP(false);
// 로컬시스템 시간 사용여부, true-사용, false-미사용, (기본값:true)
$KakaoService->UseLocalTimeYN(true);
?>2. SendATS 기능 구현
프로젝트 Root Directory에 함수 호출을 처리하는 파일을 생성하고, 아래의 코드를 참조하여 코드를 추가합니다.
<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>
<?php
include 'common.php';
// 팝빌 회원 사업자번호, "-"제외 10자리
$testCorpNum = '1234567890';
// 승인된 알림톡 템플릿코드
// └ 알림톡 템플릿 관리 팝업 URL(GetATSTemplateMgtURL API) 함수, 알림톡 템플릿 목록 확인(ListATStemplate API) 함수를 호출하거나
// 팝빌사이트에서 승인된 알림톡 템플릿 코드를 확인 가능.
$templateCode = '019020000163';
// 팝빌에 사전 등록된 발신번호
// altSendType = 'C' / 'A' 일 경우, 대체문자를 전송할 발신번호
// altSendType = '' 일 경우, null 또는 공백 처리
// ※ 대체문자를 전송하는 경우에는 사전에 등록된 발신번호 입력 필수
$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;
// 대체문자 유형(altSendType)이 "A"일 경우, 대체문자로 전송할 내용 (최대 2000byte)
// └ 팝빌이 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송처리
$altContent = '대체문자 내용';
// 대체문자 유형 (null , "C" , "A" 중 택 1)
// null = 미전송, C = 알림톡과 동일 내용 전송 , A = 대체문자 내용(altContent)에 입력한 내용 전송
$altSendType = 'A';
// 수신자 정보
$messages[] = array(
// 수신번호
'rcv' => '010111222',
// 수신자명
'rcvnm' => '수신자명'
);
// 예약전송일시, yyyyMMddHHmmss
$reserveDT = null;
// 팝빌회원 아이디
$testUserID = 'testkorea';
// 요청번호
// 파트너가 전송 건에 대해 관리번호를 구성하여 관리하는 경우 사용.
// 1~36자리로 구성. 영문, 숫자, 하이픈(-), 언더바(_)를 조합하여 팝빌 회원별로 중복되지 않도록 할당.
$requestNum = null;
// 버튼정보를 수정하지 않고 템플릿 신청시 기재한 버튼내용을 전송하는 경우, null처리.
$btns = null;
// 버튼배열, 버튼링크URL에 #{템플릿변수}를 기재하여 승인받은 경우 URL 수정가능.
// $btns[] = 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',
// );
// 대체문자 제목
// - 메시지 길이(90byte)에 따라 장문(LMS)인 경우에만 적용.
$altSubject = '대체문자 제목';
try {
$receiptNum = $KakaoService->SendATS($testCorpNum, $templateCode, $sender, $content, $altContent, $altSendType, $messages, $reserveDT, $testUserID, $requestNum, $btns, $altSubject);
} catch(PopbillException $pe) {
$code = $pe->getCode();
$message = $pe->getMessage();
}
?>
<body>
<div id="content">
<p class="heading1">Response</p>
<br/>
<fieldset class="fieldset1">
<legend>알림톡 1건 전송</legend>
<ul>
<?php
if ( isset($receiptNum) ) {
?>
<li>receiptNum(접수번호) : <?php echo $receiptNum?></li>
<?php
} else {
?>
<li>Response.code : <?php echo $code ?> </li>
<li>Response.message : <?php echo $message ?></li>
<?php
}
?>
</ul>
</fieldset>
</div>
</body>
</html>3. 결과 확인
함수 호출 반환 결과는 아래와 같습니다.
- 성공 : ReceiptNum(접수번호) 18자리 문자열 반환
- 실패 : PopbillException 음의 정수 8자리 숫자값 오류코드와 오류메시지 반환 [오류코드]