C# - 카카오톡 챗봇 스킬 (API) 서버 구현

1. Introduction

• 카카오톡 채널 챗봇은 카카오톡 채널을 통해 운영할 수 있다.
• 사용자의 발화에 반응하여 응답하는 블록 및 블록이 모여 하나의 서비스를 이루는 시나리오의 개념으로 구성되어 있다.
• 채널 운영자는 웹 UI를 통해 챗봇을 개발할 수 있으며, 사용자에게 필요한 정보를 신속히 전달할 수 있다.
• 여기서는 챗봇의 기능 중 스킬이라고 명명된 챗봇 API의 C# 서버 구현을 간략히 소개한다.

2. 스킬 서버

• 스킬 서버의 운용 시나리오는 아래와 같다.
  1. 챗봇이 스킬 서버에 HTTP POST로 payload 전달
  2. 스킬 서버가 payload에 대한 적절한 response를 반환
  3. 이 때, content type은 application/json을 사용한다.
• 아래에서는 ASP.NET을 이용한 서버 구현을 소개하며, API 클래스는 C# - 카카오톡 챗봇 스킬 (API) 구현 문서에 정의된 내용을 활용한다.

3. 공통 - Main

• 여기서는 application entry point 구성을 소개한다.

namespace KakaoChatBotStudy;

public class Program
{
    public static void Main(string[] args)
    {
        var builder = WebApplication.CreateBuilder(args);

        // Add services to the container.

        builder.Services.AddControllers();

        var app = builder.Build();

        // Configure the HTTP request pipeline.

        app.UseHttpsRedirection();

        app.UseAuthorization();

        app.MapControllers();

        app.Run();
    }
}

4. SimpleText

• 여기서는 SimpleText를 반환하는 서버 구현의 예시를 소개한다.
• 챗봇 블록 설정에는 사용자 입력을 받을 text 항목을 추가하였다.

// Data class

namespace KakaoChatBotStudy.Data;

public class SimpleTextData
{
    public string? Text { get; set; }
}

// Server

using KakaoChatBotStudy.Extension;
using KakaoChatBotStudy.KakaoAPI;
using Microsoft.AspNetCore.Mvc;

namespace KakaoChatBotStudy.Controllers;

[ApiController]
[Route("[controller]")]
public class SimpleTextTest : ControllerBase
{
    [HttpPost]
    public SkillResponse Post([FromBody] SkillPayload payload)
    {
        Console.WriteLine($"[{DateTime.Now.ToString("yyyy-MM-dd HH.mm.ss")}] Simple text requested - Request user id: {payload.UserRequest!.User!.Id}");

        SkillResponse response = new();

        try
        {
            var data = payload.Action!.Params!.ToSimpleTextData();
            var skillTemplate = new SkillTemplate
            {
                Outputs = []
            };

            SimpleText text = new() { Text = data.Text };

            skillTemplate.Outputs.AddComponent(text);
            response.Template = skillTemplate;
        }
        catch (Exception e)
        {
            Console.WriteLine(e);
        }

        return response;
    }
}

// Extension methods

using KakaoChatBotStudy.Data;
using KakaoChatBotStudy.KakaoAPI;

namespace KakaoChatBotStudy.Extension;

public static class UserInputDataExtension
{
    public static SimpleTextData ToSimpleTextData(this Dictionary<string, string> dic)
    {
        return new()
        {
            Text = dic[nameof(SimpleTextData.Text).ToFirstLetterLower()]
        };
    }
}

public static class SkillTemplateExtension
{
    public static void AddComponent(this List<Dictionary<string, Component>> outputs, Component component)
    {
        outputs?.Add(new() { { component.GetType().Name.ToFirstLetterLower(), component } });
    }
}

• 이를 이용하여 챗봇 및 서버를 실행하면 다음과 같은 결과를 얻을 수 있다.
  

  

5. TextCard

• 여기서는 TextCard를 반환하는 서버 구현의 예시를 소개한다.
• 챗봇 블록에는 다음 항목을 설정하여 서버에서 사용할 수 있게끔 하였다.
  1. title : TextCard의 title에 입력
  2. description : TextCard의 description에 입력
  3. buttonLabel : TextCard에 Button 추가하여 label에 입력
  4. buttonWebLink : Button의 webLinkUrl에 입력

// Data class

namespace KakaoChatBotStudy.Data;

public class TextCardData
{
    public string? Title { get; set; }
    public string? Description { get; set; }
    public string? ButtonLabel { get; set; }
    public string? ButtonWebLink { get; set; }
}

// Server

using KakaoChatBotStudy.Extension;
using KakaoChatBotStudy.KakaoAPI;
using Microsoft.AspNetCore.Mvc;

namespace KakaoChatBotStudy.Controllers;

[ApiController]
[Route("[controller]")]
public class TextCardTest : ControllerBase
{
    [HttpPost]
    public SkillResponse Post([FromBody] SkillPayload payload)
    {
        Console.WriteLine($"[{DateTime.Now.ToString("yyyy-MM-dd HH.mm.ss")}] Text card requested - Request user id: {payload.UserRequest!.User!.Id}");

        SkillResponse response = new();

        try
        {
            var data = payload.Action!.Params!.ToTextCardData();
            var skillTemplate = new SkillTemplate
            {
                Outputs = new()
            };

            TextCard card = new()
            {
                Title = data.Title,
                Description = data.Description,
                Buttons =
                [
                    new ButtonWithWebLink()
                    {
                        Label = data.ButtonLabel,
                        WebLinkUrl = data.ButtonWebLink
                    }
                ]
            };

            skillTemplate.Outputs.AddComponent(card);
            response.Template = skillTemplate;
        }
        catch (Exception e)
        {
            Console.WriteLine(e);
        }

        return response;
    }
}

// Extension methods

using KakaoChatBotStudy.Data;
using KakaoChatBotStudy.KakaoAPI;

namespace KakaoChatBotStudy.Extension;

public static class UserInputDataExtension
{
    public static TextCardData ToTextCardData(this Dictionary<string, string> dic)
    {
        return new()
        {
            Title = dic[nameof(TextCardData.Title).ToFirstLetterLower()],
            Description = dic[nameof(TextCardData.Description).ToFirstLetterLower()],
            ButtonLabel = dic[nameof(TextCardData.ButtonLabel).ToFirstLetterLower()],
            ButtonWebLink = dic[nameof(TextCardData.ButtonWebLink).ToFirstLetterLower()]
        };
    }
}

public static class SkillTemplateExtension
{
    public static void AddComponent(this List<Dictionary<string, Component>> outputs, Component component)
    {
        outputs?.Add(new() { { component.GetType().Name.ToFirstLetterLower(), component } });
    }
}

• 이를 이용하여 챗봇 및 서버를 실행하면 다음과 같은 결과를 얻을 수 있다.
  

  

6. 참조 자료

• 챗봇 관리자센터 개요
• 블록
• 시나리오
• 스킬 만들기
• 응답 타입별 JSON 포맷
• 블록에 스킬 적용하기
• 예제 전체 코드(Github) : KakaoChatBotStudy
• C# - 카카오톡 챗봇 스킬 (API) 구현