튜토리얼

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

1. POPBiLL SDK 추가

팝빌 Python SDK를 추가하기 위해 pip install 명령어를 사용하여 패키지를 설치합니다.

$ pip install popbill

2. POPBiLL SDK 설정

Django 프로젝트의 settings.py 파일에 연동신청시 발급받은 API Key 와 연동환경 설정값을 선언합니다.

# -*- coding: utf-8 -*-
import os
import sys
import imp
imp.reload(sys)

try:
    sys.setdefaultencoding('UTF8')
except Exception as E:
    pass

#생략
#...
#...

# 링크아이디
LinkID = "TESTER"

# 비밀키
SecretKey = "SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3T="

# 연동환경 설정, 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 기능 구현

Django App에 생성된 views.py 파일에 카카오톡 서비스 클래스 객체 생성과 카카오톡 알림톡 전송 (SendATS) 함수 호출 코드를 추가합니다.

# -*- coding: utf-8 -*-
from django.shortcuts import render
from popbill import PopbillException, ContactInfo, CorpInfo, JoinForm, KakaoService, KakaoReceiver, KakaoButton

from config import settings

# settings.py 작성한 LinkID, SecretKey를 이용해 TaxinvoiceService 객체 생성
kakaoService = KakaoService(settings.LinkID, settings.SecretKey)

# 연동환경 설정값, 개발용(True), 상업용(False)
kakaoService.IsTest = settings.IsTest

# 인증토큰 IP제한기능 사용여부, 권장(True)
kakaoService.IPRestrictOnOff = settings.IPRestrictOnOff

# 팝빌 API 서비스 고정 IP 사용여부, true-사용, false-미사용, 기본값(false)
kakaoService.UseStaticIP = settings.UseStaticIP

#로컬시스템 시간 사용여부, 권장(True)
kakaoService.UseLocalTimeYN = settings.UseLocalTimeYN

def sendATS_one(request):
    try:
        # 팝빌회원 사업자번호
        CorpNum = "1234567890"

        # 팝빌회원 아이디
        UserID = "testkorea"

        # 알림톡 템플릿코드
        # 승인된 알림톡 템플릿 코드는 ListATStemplate API, GetATSTemplateMgtURL API, 혹은 팝빌사이트에서 확인이 가능합니다.
        templateCode = "019020000163"

        # 발신번호 (팝빌에 등록된 발신번호만 이용가능)
        snd = "07043042992"

        # 알림톡 내용 (최대 1000자)
        # 사전에 승인된 템플릿의 내용과 알림톡 전송내용(content)이 다를 경우 전송실패 처리됩니다.
        content = "[ 팝빌 ]\n"
        content += "신청하신 #{템플릿코드}에 대한 심사가 완료되어 승인 처리되었습니다.\n"
        content += "해당 템플릿으로 전송 가능합니다.\n\n"
        content += "문의사항 있으시면 파트너센터로 편하게 연락주시기 바랍니다.\n\n"
        content += "팝빌 파트너센터 : 1600-8536\n"
        content += "support@linkhubcorp.com"

        # 대체문자 내용 (최대 2000byte)
        altContent = "알림톡 대체 문자"

        # 대체문자 유형 [공백-미전송, C-알림톡내용, A-대체문자내용]
        altSendType = "A"

        # 예약전송시간, 작성형식:yyyyMMddHHmmss, 공백 기재시 즉시전송
        sndDT = ""

        # 수신번호
        receiver = "01011122"

        # 수신자 이름
        receiverName = "partner"

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

        # 알림톡 버튼정보를 템플릿 신청시 기재한 버튼정보와 동일하게 전송하는 경우 btns를 빈 배열로 처리.
        btns = []

        # 알림톡 버튼 URL에 #{템플릿변수}를 기재한경우 템플릿변수 값을 변경하여 버튼정보 구성
        #btns.append(
        #     KakaoButton(
        #         n="템플릿 안내",  # 버튼명
        #         t="WL",  # 버튼유형 [DS-배송조회, WL-웹링크, AL-앱링크, MD-메시지전달, BK-봇키워드]
        #         u1="https://www.popbill.com",  # [앱링크-Android, 웹링크-Mobile]
        #         u2="http://www.popbill.com"  # [앱링크-IOS, 웹링크-PC URL]
        #    )
        #)

        receiptNum = kakaoService.sendATS(CorpNum, templateCode, snd, content, altContent,
                                    altSendType, sndDT, receiver, receiverName, UserID, requestNum, btns)

        return render(request, 'response.html', {'receiptNum': receiptNum})
    except PopbillException as PE:
        return render(request, 'exception.html', {'code': PE.code, 'message': PE.message})

함수 호출결과 코드와 메시지를 출력하는 "/response.html" 파일을 추가합니다.

<html xmlns=" http://www.w3.org/1999/xhtml ">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  <title>Popbill API Test.</title>
</head>
<body>
  <div id="content">
      <fieldset class="fieldset1">
          <legend>알림톡 접수번호</legend>
          <ul>
              <li> receiptNum (접수번호) : {{ receiptNum }} </li>
          </ul>
      </fieldset>
  </div>
</body>
</html>

4. 결과 확인

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