튜토리얼

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

1. POPBiLL SDK 추가

[프로젝트 > NuGet 패키지 관리] 메뉴에서 popbill을 검색하여 최신 버전의 패키지를 설치합니다.

2. POPBiLL SDK 설정

① 프로젝트의 Startup.cs 파일에 koreanName 서비스 인스턴스 클래스를 생성하고, Startup클래스의 ConfigureServices() 함수에 의존성 주입 패턴으로 Singleton 서비스 인스턴스를 추가합니다.

② koreanName 서비스명으로 컨트롤러를 생성하고 생성한 컨트롤러의 생성자 함수에서 koreanName 인스턴스 객체를 할당합니다.

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Popbill.moduleName;

public class serviceNameInstance
{
  // 링크아이디
  private string linkID = "TESTER";
  // 비밀키
  private string secretKey = "SwWxqU+0TErBXy/9TVjIPEnI0VTUMMSQZtJf3Ed8q3I=";

  // koreanName  서비스 객체 선언
  public serviceNameService classNameService;

  public serviceNameInstance()
  {
    // koreanName  서비스 객체 초기화
    kakaoService = new Kakao(linkID, seretKey);

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

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

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

    // 로컬시스템 시간 사용여부, true-사용, false-미사용, (기본값: false)
    kakaoService.UseLocalTimeYN = true
  }
}

namespace serviceNameExample
{
  public class Startup
  {
    public Startup(IConfiguration configuration)
    {
      Configuration = configuration;
    }

    public IConfiguration Configuration { get; }

    // This method gets called by the runtime. Use this method to add services to the container.
    public void ConfigureServices(IServiceCollection services)
    {
      services.AddMvc();

      services.AddSingleton<serviceNameInstance>();
    }

    // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
      if (env.IsDevelopment())
      {
        app.UseDeveloperExceptionPage();
      }
      else
      {
        app.UseExceptionHandler("/Home/Error");
      }

      app.UseStaticFiles();

      app.UseMvc(routes =>
      {
        routes.MapRoute(
          name: "default",
          template: "{controller=serviceName}/{action=Index}");
      });
    }
  }
}

3. SendATS 기능 구현

카카오톡 서비스명으로 생성한 컨트롤러의 생성자 함수에 인스턴스 객체를 할당하고, 카카오톡 알림톡 전송 함수(SendATS) 호출 코드를 추가합니다.

// Controllers/KakaoController.cs
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;

using Popbill;
using Popbill.Kakao;

namespace Tutorial_Example.Controllers
{
    public class KakaoController : Controller
    {
        private readonly KakaoService _kakaoService;

        public KakaoController(KakaoInstance KKOinstance)
        {
            // 카카오 서비스 객체 주입
            _kakaoService = KKOinstance.kakaoService;
        }

        // GET: /<controller>/
        public IActionResult Index()
        {
            return View();
        }

        /*
         * 알림톡 전송을 요청합니다.
         * - 사전에 승인된 템플릿의 내용과 알림톡 전송내용(content)이 다를 경우 전송실패 처리됩니다.
         * - https://developers.popbill.com/reference/kakaotalk/dotnet/api/send#SendATSOne
         */
        public IActionResult SendATS()
        {
            // 팝빌 회원 사업자번호
            String corpNum = "1234567890";

            // 팝빌 회원 아이디
            String userID = "testkorea";

            // 알림톡 템플릿 코드, ListATSTemplate API의 templateCode 확인
            string templateCode = "019020000163";

            // 발신번호
            string senderNum = "07043042991";

            // 수신번호
            string receiverNum = "010111222";

            // 수신자명
            string receiverName = "수신자명";

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

            // 대체문자 메시지 내용 (최대 2000byte)
            string altContent = "대체문자 메시지 내용";

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

            // 예약전송일시(yyyyMMddHHmmss), null인 경우 즉시전송
            // ex) DateTime sndDT = new DateTime(20220130120000);
            DateTime? sndDT = null;

            // 요청번호, 파트너가 전송요청에 대한 관리번호를 직접 할당하여 관리하는 경우 기재
            // 최대 36자리, 영문, 숫자, 언더바('_'), 하이픈('-')을 조합하여 사업자별로 중복되지 않도록 구성
            string requestNum = "";

            // 알림톡 버튼정보를 템플릿 신청시 기재한 버튼정보와 동일하게 전송하는 경우 null 처리.
            List<KakaoButton> buttons = null;


            // 알림톡 버튼 URL에 #{템플릿변수}를 기재한경우 템플릿변수 영역을 변경하여 버튼정보 구성
            /*
            List<KakaoButton> buttons = new List<KakaoButton>();

            KakaoButton btnInfo = new KakaoButton();
            // 버튼명
            btnInfo.n = "템플릿 안내";
            // 버튼유형 DS(-배송조회 / WL - 웹링크 / AL - 앱링크 / MD - 메시지전달 / BK - 봇키워드)
            btnInfo.t = "WL";
            // 버튼링크1 [앱링크] iOS / [웹링크] Mobile
            btnInfo.u1 = "https://www.popbill.com";
            // 버튼링크2 [앱링크] Android / [웹링크] PC URL
            btnInfo.u2 = "http://test.popbill.com";
            buttons.Add(btnInfo);
            */

            try
            {
                var receiptNum = _kakaoService.SendATS(corpNum, templateCode, senderNum, receiverNum, receiverName,
                    content, altContent, altSendType, sndDT, requestNum, userID, buttons);
                return View("Result", receiptNum);
            }
            catch (PopbillException pe)
            {
                return View("PopbillError", pe);
            }
        }
    }
}

4. 결과 확인

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