튜토리얼

.NET Core 개발환경에서 팝빌 SDK를 추가하고, 카카오톡 알림톡 전송 (SendATS) API를 호출하는 기본 과정을 단계별로 따라 해볼 수 있도록 구성된 가이드 입니다.

1. POPBiLL SDK 추가

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

2. POPBiLL SDK 설정

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

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

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

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

  // 카카오톡  서비스 객체 선언
  public KakaoService kakaoService;

  public KakaoInstance()
  {
    // 카카오톡  서비스 객체 초기화
    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 KakaoExample
{
  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<KakaoInstance>();
    }

    // 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=Kakao}/{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/dotnetcore/api/send#SendATSOne
         */
        public IActionResult SendATS()
        {
            // 승인된 알림톡 템플릿코드
            string templateCode = "019020000163";

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

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

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

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

            // 대체문자 제목
            string altSubject = "대체문자 제목";

            // 대체문자 내용
            string altContent = "대체문자 메시지 내용";

            // 대체문자 유형
            string altSendType = "A";

            // 전송 예약일시
            DateTime? sndDT = null;

            // 요청번호
            string requestNum = "";

            // 버튼 목록
            List<KakaoButton> buttons = null;

            // 강조표기 타이틀
            string emphasizeTitle = "";

            /*
            List<KakaoButton> buttons = new List<KakaoButton>();

            KakaoButton btnInfo = new KakaoButton();
            btnInfo.n = "전화 연결";
            btnInfo.t = "TN";
            btnInfo.u1 = "";
            btnInfo.u2 = "";
            btnInfo.tg = "";
            btnInfo.telNum = "1600-8536";
            buttons.Add(btnInfo);
            */

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

4. API 응답결과 확인

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