Node

Node.JS로 카카오봇 만들기

Posted by Yun on 2017-02-16

전체소스는 GitHub branch develop-base에서 확인할 수 있습니다.

옐로우 아이디 등록

옐로우아이디 등록

옐로우아이디 경고

해당 프로필은 하번 설정하면 변경이 불가능합니다. 이 작업이 완료되면 2 ~ 3일 이후에 옐로우아이디가 발급됩니다. 발급되기 전까지 Node API 서버를 구성합니다. 자세한 설명은 아래에 있습니다.

API형 자동읍답 선택

API형 자동읍답 설정하기 선택

앱 등록 절차를 진행합니다.

앱등록시 반드시 keyboard API가 동작해야합니다. 아래의 노드 서버 설정을 완료하고 API TEST를 진행합니다.

API TEST

카카오 봇 API 간단설명

용어 설명

수신 API

  • 카카오톡 이용자가 플러스친구, 옐로아이디에게 보낸 메시지를 전달 받은 후 응답을 할 수 있는 API 입니다. http(s) restful api를 통하여 카카오 API 서버 -> 파트너 서버를 호출합니다.

app_key

  • 플러스친구/옐로아이디에서 자동응답을 위한 앱 등록시 프로필별로 발급되는 고유 키 값입니다. 자동응답 기능만 이용하시는 경우 사용되지 않으며, 일부 app_secret을 통한 별도 인증이 필요한 일부 프로필에만 사용됩니다.

app_secret

  • 인증을 위해 app_key와 조합하여 사용되는 키 값입니다. 자동응답 기능만 이용하시는 경우 사용되지 않으며, 일부 app_secret을 통한 별도 인증이 필요한 일부 프로필에만 사용됩니다.

user_key

  • 특정 카카오톡 이용자를 구분하기 위한 key 입니다. 카카오에서는 이용자의 개인정보를 외부에 제공하지 않으므로, 외부 파트너사에서 카카오톡 이용자를 구분하기 위해서는 카카오로부터 API를 통해 user_key를 response로 받아야 합니다. user_key는 특정 카카오톡 이용자에 대해 프로필별로 각기 다르게 발급됩니다. 따라서 user_key는 해당 프로필에 대해서만 유효합니다. 카카오톡 이용자가 프로필을 차단했다가 다시 추가한 경우에는 user_key가 갱신되지 않으며, 이용자가 카카오톡 탈퇴 후 재가입한 경우 갱신됩니다.

API 설정

URL method 설명
/keyboard GET 키보드 영역에 표현될 버튼에 대한 정보. 생략시 text 타입이 선택된다
/message POST 자동응답 명령어에 대한 응답 메시지의 내용
/friend POST 특정 카카오톡 이용자가 플러스친구/옐로아이디를 친구로 추가하거나 차단하는 경우 해당 정보를 파트너사 서버로 전달하는 API입니다.
/friend DELETE 특정 카카오톡 이용자가 플러스친구/옐로아이디를 친구로 추가하거나 차단하는 경우 해당 정보를 파트너사 서버로 전달하는 API입니다.
/chat_room/:user_key DELETE 사용자가 채팅방 나가기를 해서 채팅방을 목록에서 삭제했을 경우 해당 정보를 파트

출저 : 카카오톡 플러스친구/옐로아이디 API v. 2.0 개요

Node API 설정

Node keyboard API

1
2
3
4
5
6
7
8
9
10
router.get('/keyboard', (req, res) => {
  const menu = {
      type: 'buttons',
      buttons: ["메뉴1", "메뉴2", "메뉴3"]
  };

  res.set({
      'content-type': 'application/json'
  }).send(JSON.stringify(menu));
});

Response

1
2
3
4
5
6
7
8
{
  "type": "buttons",
  "buttons": [
    "메뉴1",
    "메뉴2",
    "메뉴3"
  ]
}

스크린샷

Node Message API

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
router.post('/message', (req, res) => {
    const _obj = {
        user_key: req.body.user_key,
        type: req.body.type,
        content: req.body.content
    };
    let massage = {
        "message": {
            "text": '응답 메세지...'
        },
        "keyboard": {
            "type": "buttons",
            "buttons": [
                "메뉴1",
                "메뉴2",
                "메뉴3"
            ]
        }
    };
    res.set({
        'content-type': 'application/json'
    }).send(JSON.stringify(massage));
});

let massage ={…}에 따라서 메세지 형태가 결정됩니다

  • 기본
  • 라벨
  • 포토라벨

기본

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "message": {
    "text": "메뉴1를 선택했습니다."
  },
  "keyboard": {
    "type": "buttons",
    "buttons": [
      "메뉴1",
      "메뉴2",
      "메뉴3",
    ]
  }
}

라벨형

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "message": {
    "text": "메뉴2를 선택했습니다.",
    "message_button": {
      "label": "라벨입니다.",
      "url": "https://cheese10yun.github.io/"
    }
  },
  "keyboard": {
    "type": "buttons",
    "buttons": [
      "메뉴1",
      "메뉴2",
      "메뉴3",
      "메뉴4",
      "메뉴5"
    ]
  }
}

기본 & 라벨형 스크린샷

  • 메뉴1 기본
  • 메뉴2 라벨

포토형

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "message": {
    "text": "메뉴3를 선택했습니다.",
    "photo": {
      "url": "http://i.imgur.com/tvuH0ZJ.png",
      "width": 640,
      "height": 480
    },
    "message_button": {
      "label": "라벨입니다",
      "url": "https://cheese10yun.github.io/"
    }
  },
  "keyboard": {
    "type": "buttons",
    "buttons": [
      "메뉴1",
      "메뉴2",
      "메뉴3",
    ]
  }
}

포토형 메세지 스크린샷

라벨을 터치하면 등록된 URL 주소로 이동합니다.

Node friend API

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
router.post('/friend', (req, res) => {
    const user_key = req.body.user_key;
    console.log(`${user_key}님이 쳇팅방에 참가했습니다.`);
    
    res.set({
        'content-type': 'application/json'
    }).send(JSON.stringify({success:true}));
});

router.delete('/friend', (req, res) => {
    const user_key = req.body.user_key;
    console.log(`${user_key}님이 쳇팅방을 차단했습니다.`);
    
    res.set({
        'content-type': 'application/json'
    }).send(JSON.stringify({success:true}));
});

Node chat_room API

1
2
3
4
5
6
7
8
router.delete('/chat_room/:user_key', (req, res) => {
    const user_key = req.params.user_key;
    console.log(`${user_key}님이 쳇팅방에서 나갔습니다.`);

    res.set({
        'content-type': 'application/json'
    }).send(JSON.stringify({success:true}));
});

나머지 API들은 간단하게 작성합니다.

마무리

학교 식단 및 통학 버스 알림 봇을 만들다가 기본 구조를 갖는 소스코드를 올리는 것도 좋을 거 같아서 기존 프로젝트에서 불필요 소스코드를 제거하고 올린 거라 좀 어색한 부분이 있네요. 비슷한 프로젝트를 진행하실 분들은 다른 master branch를 참조하세요.

FEATURED TAGS
Node