플러스친구 자동응답 API
Switch branches/tags
Nothing to show
Clone or download
Latest commit c661c7c Sep 14, 2018
Permalink
Failed to load latest commit information.
README.md Update README.md Sep 14, 2018

README.md

[공지] 2018년 11월 30일, API형 스마트채팅 신규 등록 중단 안내

안녕하세요. 플러스친구팀입니다.

2018년 11월 30일, 카카오톡 플러스친구 챗봇을 제작 할 수 있는 플랫폼인 카카오 i 오픈빌더(이하 오픈빌더)의 OBT가 시작됨에 따라 기존 API형 스마트채팅의 신규 등록이 중단될 예정입니다. 기존 사용 중이던 API형 스마트채팅의 설정 및 수정은 가능하오나 19년 12월에는 API형 스마트채팅이 완전 종료될 예정이오니 아래 내용을 꼭 참고해주시길 바랍니다.

2018년 11월 30일 API형 스마트채팅 신규 등록 중단
2019년 12월 2일 API형 스마트채팅 완전 종료

참고1. 아래와 같은 경우 설정 및 수정만 가능

  • 현재 API형 스마트채팅을 사용 중인 경우
  • 사용 중은 아니지만 등록해 놓은 앱정보가 있는 경우
  • 2018년 11월 30일 이전 신규 등록하여 사용하는 경우

참고2. 오픈빌더로 챗봇 제작을 원하는 경우

  • 18년 11월 30일 전: 공식 에이전시를 통해 제작 가능 (에이전시 안내: https://brunch.co.kr/@openbuilder/7)
  • 18년 11월 30일 후: 오픈빌더 OBT 사이트 내에서 신청 접수 후 플랫폼 사용 가능

참고3. 자주묻는 질문

Q. API형 스마트채팅으로 제작한 챗봇을 오픈빌더 챗봇으로 바꿀 수 있나요?
A. API형 스마트채팅으로 제작한 챗봇이 오픈빌더로 자동 이전 되거나 카카오가 해당 과정을 지원해 드리지는 않습니다.
오픈빌더를 통해 챗봇을 제작하기 위해서는 공식 에이전시 등을 통해 별도로 챗봇을 제작해야합니다.

Q. API형 스마트채팅으로 제작한 챗봇과 오픈빌더로 제작한 챗봇은 어떤 차이가 있나요?
A. API형 스마트채팅은 카카오가 무료로 지원하는 단순한 형태의 open API입니다.
해당 API를 통해서 제작된 챗봇은 단순한 형태의 기능과 말풍선 형태만을 지원하여 고도화된 챗봇 제작은 불가능 합니다.
반면, 오픈빌더는 챗봇 제작을 위한 전문적인 도구로, 해당 플랫폼을 통해 제작된 챗봇은 다양한 형태의 말풍선과
채팅방 내에서 바로 사용할 수 있는 결제, 예약, FAQ 등의 기능을 제공합니다.

Q. API형 스마트채팅과 오픈빌더 챗봇을 동시에 사용할 수 있나요?
A. 동시에 사용할 수 없습니다.

Q. 공식 에이전시는 어디서 확인할 수 있나요?
A. 해당 링크에서 확인할 수 있습니다. 링크: https://brunch.co.kr/@openbuilder/7

Q. 11월 30일 오픈빌더 OBT가 시작되면 누구나 사용할 수 있나요?
A. 카카오 계정 이용자라면 누구나 오픈빌더 OBT 신청을 하실 수 있습니다.
OBT 신청이 접수되면 간단한 심사 단계를 거치게 되며,
1주일 이내에 개별적으로 카카오 계정의 이메일 주소로 심사/승인 결과를 안내해 드릴 예정입니다.

Q. 오픈빌더는 무료로 사용할 수 있나요?
A. CBT 기간 동안에 카카오는 오픈빌더 플랫폼 및 챗봇의 사용요금을 받지 않습니다.
다만, OBT 이후에는 유료화 될 수 있으며 이는 OBT이전에 공지사항 등을 통해 별도로 안내 될 예정입니다.

카카오톡 플러스친구 API v. 2.0 개요

이 문서는 플러스친구를 통하여 자동응답 기능을 이용하고자 할 때 사용되는 API에 대해 기술합니다.

1. 이용에 대한 참고사항

  1. 서버간 통신은 보안을 위하여 HTTPS를 쓰도록 권장합니다.
  2. HTTPS를 통하여 API를 이용하는 파트너사 서버는 유효한 공인인증서를 사용해야 합니다.
  3. user_key는 외부에 노출되지 않도록 주의해 주시기 바랍니다.
  4. 플러스친구 API 운영에 대한 정책 및 가이드라인은 플러스친구 이용약관의 API 플랫폼 운영정책을 참고해 주시기 바랍니다.

2. 개인정보 수집 및 이용에 대한 주의사항

  1. API 이용에 대한 주의사항은 서비스 이용약관 '제 26 조 API 플랫폼 서비스'를 따르며, 이를 준수하지 않을 경우 API 서비스 제공을 중단할 수 있습니다.
  2. 회원이 API 플랫폼 서비스를 이용하는 과정에서 이용자의 개인정보 수집이 필요한 경우, 이용자로부터 개인정보 수집 및 이용에 대한 명시적인 동의를 받아야 합니다.
  3. 카카오는 '개인정보 취급위탁 동의'에 따라 안전하게 개인정보 처리 업무를 진행합니다.

3. 이용 시작하기

3.1. 플러스친구 앱 생성

플러스친구에서 자동응답 기능을 사용하기 위해서는 먼저 운영툴을 통해 key 발급을 위한 앱을 등록해야 합니다.

  1. 플러스친구 운영툴의 좌측 '스마트채팅' 메뉴에서 'API형'을 선택합니다.
  2. 앱 정보와 모니터링 메시지를 수신할 전화번호를 입력하고, 개인정보 수집 및 이용에 동의한 뒤 정보를 저장하여 앱을 생성합니다.

3.2. 자동응답 서비스 시작

자동응답 서비스가 개발 완료되어 서비스 가능한 상태가 되면, 다음 단계에 따라 서비스를 시작할 수 있습니다.

  1. API TEST : 등록한 앱 url 우측의 API TEST 버튼을 클릭하여 서비스 시작 가능여부를 체크합니다. 필수 API인 Home Keyboard API가 정상적인 응답을 받지 못하는 경우 서비스 시작이 불가합니다.
  2. 서비스 시작 : API 테스트를 통과한 경우, 서비스 시작 버튼을 클릭하면 자동응답 서비스가 시작됩니다.
  • 기존에 (구) 플러스친구 API를 통해 사용중이던 봇이 있는 경우, 신규 API를 통해 자동응답 서비스를 시작하게 되면 (구)API를 이용한 봇은 자동으로 종료되며 다시 (구) 봇의 형태로 이용할 수 없습니다.
  • (구) 플러스친구에서 제공하던 테스트 플친은 더이상 제공되지 않습니다. 실서비스 적용 전 테스트를 원하시는 경우 테스트 전용으로 사용하실 별도의 플러스친구 계정을 생성하여 테스트를 진행해 주시기 바랍니다.
  • 신규 API 자동응답은 키워드형 자동응답과 동시에 사용할 수 없습니다. 다만 API 자동응답의 서비스 중지 후 키워드형 자동응답을 사용하는 것은 가능합니다.

3.3. 자동응답 서비스 중지

  • 직접 중지 : 더 이상 자동응답 서비스를 이용하지 않으시려면, 운영툴의 자동응답 > 자동응답 API 메뉴에서 '서비스 중지'를 통해 자동응답 기능을 중지할 수 있습니다.
  • 오류 횟수 초과에 따른 중지 : 자동응답 서비스에서 오류가 발생하는 경우, 카카오는 앱 정보에 등록된 전화번호를 통해 모니터링 메시지를 발송합니다. 만일 오류 횟수가 일 1000건을 초과하게 되면 카카오는 자동으로 해당 앱의 서비스를 중지합니다. 오류 횟수 초과로 인해 중지된 앱은 운영툴에서 오류 수정 후 직접 다시 서비스를 시작할 수 있습니다.
  • 관리자의 차단에 따른 중지 : 파트너사에서 플러스친구 API의 운영정책에 반하는 내용을 API를 통해 서비스하는 것이 확인된 경우, 카카오의 관리자는 해당 앱의 서비스를 중지할 수 있습니다. 관리자에 의해 차단된 앱은 직접 서비스를 다시 시작할 수 없으므로, 앱의 차단 사유를 확인하신 뒤 문제가 되는 내용을 수정하여 플러스친구 고객센터(1544-4293)를 통해 차단 해제를 요청해 주시기 바랍니다.

3.4. 클라이언트 테스트

자동응답 기능의 서비스가 시작되면 카카오톡 채팅방에서 직접 자동응답 기능을 실행할 수 있습니다. 신규 자동응답 API를 통한 자동응답 기능은 카카오톡 앱 안드로이드/iOS 5.4.0 버전부터 지원됩니다.

  • 수정된 내용의 반영은 최대 1분까지 소요될 수 있으며, 채팅방을 나갔다 들어오는 시점을 기준으로 정보를 새로고침합니다.
  • 1depth 이상의 자동응답을 구현하는 경우, 카카오톡에서는 자동응답 대화의 맥락을 유지하기 위해 이전 자동응답의 정보를 메시지 수신으로부터 10분간 보관합니다. 메시지를 받은 후 10분이 경과되면 자동으로 기존의 대화 맥락은 expire되며 Home keyboard 를 호출합니다.
  • 클라이언트를 통해 노출되는 안내문구 ('원하는 버튼을 선택하세요')는 고정 문구로, 커스터마이즈할 수 없습니다.
  • 실서비스 적용 전 테스트를 원하시는 경우 별도의 플러스친구를 생성하여 테스트를 진행해보실 수 있습니다.

4. 용어 설명

4.1. 수신 API

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

4.2. app_key

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

4.3. app_secret

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

4.4. user_key

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

5. API specifications

  • 카카오 플러스친구 API 서버에서 개발사 서버를 호출하는 API에 대한 명세서입니다.
  • 개발사는 아래 스펙에 맞춰서 http(s) 서버를 구축하셔야 합니다.
  • 응답 지연시간 : 최대 5초안에 응답이 오지 않는 경우 응답없음 메시지가 사용자에게 발송됩니다.
  • QoS : 만약 응답 실패가 10회 이상 발생하게 되면 자동적으로 해당 모듈은 지정된 장애 메시지를 리턴하게 됩니다. 더불어 앱 등록시 지정된 관리자에게 카카오톡으로 장애 메시지가 발송됩니다.
  • 플러스친구 운영도구를 통해 설정한 개발사 서버 URL을 호출하게 됩니다.
  • 개발사 서버가 방화벽으로 보호되고 있는경우 Server information 문서를 참고해주세요.

5.1. Home Keyboard API

  • 이용자가 최초로 채팅방에 들어올 때 기본으로 키보드 영역에 표시될 자동응답 명령어의 목록을 호출하는 API입니다.
  • 챗팅방을 지우고 다시 재 진입시에도 호출됩니다. 다만 카카오 서버에서도 1분동안 캐쉬가 저장되기 때문에 유저가 채팅방을 지우고 들어오는 행동을 반복하더라도 개발사 서버를 1분에 한번씩 호출하게 됩니다. 즉, 개발사 서버에서 정보가 변경되어도 최대 1분뒤에 유저들에게 반영이 됩니다.
  • 유저가 자동응답으로 메시지를 주고 받았을 경우는 마지막 메시지에 담겨있던 자동응답 명령어 목록이 표시됩니다. 다만 메시지에 저장된 자동응답 명령어는 10분간 유효합니다. 10분이 지난 다음에는 다시 keyboard api를 호출하여 자동응답 목록을 초기화하게 됩니다.
Specification
  • Method : GET
  • URL : http(s)://:your_server_url/keyboard
  • Content-Type : application/json; charset=utf-8
  • 예제
curl -XGET 'https://:your_server_url/keyboard'
  • Response
필드명 타입 필수여부 설명
keyboard Keyboard Required 키보드 영역에 표현될 버튼에 대한 정보. 생략시 text 타입이 선택된다.
  • 예제
{
    "type" : "buttons",
    "buttons" : ["선택 1", "선택 2", "선택 3"]
}

5.2. 메시지 수신 및 자동응답 API

  • 사용자가 선택한 명령어를 파트너사 서버로 전달하는 API입니다.
  • 자동응답 명령어에 대한 답변은 응답 메시지(Message)와 응답 메시지에 따른 키보드 영역의 답변 방식(Keyboard)의 조합으로 이루어집니다. 답변 방식은 주관식(text)과 객관식(buttons) 중 선택할 수 있습니다.
  • 자동응답을 통해 친구에게 미디어 타입(사진/동영상/오디오)을 받고자 하는 경우 주관식 키보드(text)를 선택하세요. 메시지를 통해 <‘+’버튼을 눌러 미디어를 전송하세요>와 같이 안내하는 것이 필요 할 수 있습니다.
  • 유저가 보낸 미디어 타입의 카카오 서버에서의 보존기간은 아래와 같습니다.
    • 음성파일 : 20일
    • 이미지파일 : 20일
    • 비디오 : 20일
  • 미디어 파일의 보존기간은 서버의 상황에 의하여 변동 될 수 있습니다.
Specification
  • Method : POST
  • URL : http(s)://:your_server_url/message
  • Content-Type : application/json; charset=utf-8
  • Parameters
필드명 타입 필수여부 설명
user_key String Required 메시지를 발송한 유저 식별 키
type String Required text, photo
content String Required 자동응답 명령어의 메시지 텍스트 혹은 미디어 파일 uri
  • 예제
curl -XPOST 'https://:your_server_url/message' -d '{
  "user_key": "encryptedUserKey",
  "type": "text",
  "content": "차량번호등록"
}'
curl -XPOST 'https://your_server_url/message' -d '{
  "user_key": "encryptedUserKey",
  "type": "photo",
  "content": "http://photo_url/number.jpg"
}'
  • Response
필드명 타입 필수여부 설명
message Message Required 자동응답 명령어에 대한 응답 메시지의 내용. 6.2에서 상세 기술
keyboard Keyboard Optional 키보드 영역에 표현될 명령어 버튼에 대한 정보. 생략시 text 타입(주관식 답변 키보드)이 선택된다. 6.1에서 상세 기술
  • 예제
{
    "message":{
        "text" : "귀하의 차량이 성공적으로 등록되었습니다. 축하합니다!"
    }
}
{
  "message": {
    "text": "귀하의 차량이 성공적으로 등록되었습니다. 축하합니다!",
    "photo": {
      "url": "https://photo.src",
      "width": 640,
      "height": 480
    },
    "message_button": {
      "label": "주유 쿠폰받기",
      "url": "https://coupon/url"
    }
  },
  "keyboard": {
    "type": "buttons",
    "buttons": [
      "처음으로",
      "다시 등록하기",
      "취소하기"
    ]
  }
}

5.3. 친구 추가/차단 알림 API

  • 특정 카카오톡 이용자가 플러스친구를 친구로 추가하거나 차단하는 경우 해당 정보를 파트너사 서버로 전달하는 API입니다.
Specification
  • Method : POST / DELETE
  • URL : http(s)://:your_server_url/friend
  • Content-Type : application/json; charset=utf-8
  • Parameters
필드명 타입 필수여부 설명
user_key String Required 유저 식별키
  • Response
http status code code message comment
200 0 SUCCESS 정상 응답
  • 예제
  • 친구 추가
curl -XPOST 'https://:your_server_url/friend' -d '{"user_key" : "HASHED_USER_KEY" }'
  • 친구 삭제
curl -XDELETE 'https://:your_server_url/friend/:user_key'

5.4. 채팅방 나가기

  • 사용자가 채팅방 나가기를 해서 채팅방을 목록에서 삭제했을 경우 해당 정보를 파트너사 서버로 전달하는 API입니다.
Specification
  • Method : DELETE
  • URL : http(s)://:your_server_url/chat_room/:user_key
  • Content-Type : application/json; charset=utf-8
  • Response
http status code code message comment
200 0 SUCCESS 정상 응답
  • 예제
curl -XDELETE 'https://:your_server_url/chat_room/HASHED_USER_KEY'

6. Object

6.1. Keyboard
  • 응답 메시지에 따라 사용자의 키보드 영역에 표현될 메시지 입력방식에 대한 정보입니다.
  • 별도로 설정하지 않는 경우 text 타입이 기본으로 설정됩니다.
필드명 타입 필수여부 설명
type String Required buttons: 객관식 응답의 목록을 구성할 수 있음
text: 주관식 응답을 입력받을 수 있음
buttons Array[String] Optional 객관식 응답 내용의 목록
(최대 100개)
  • 직접 입력
{
  "type": "text"
}
  • 버튼 입력
{
  "type": "buttons",
  "buttons": [
    "선택 1",
    "선택 2",
    "선택 3"
  ]
}
6.2. Message
  • 카카오톡 이용자가 명령어를 선택 혹은 입력했을 때 이용자에게 전송하는 응답 메시지입니다.
  • String, photo, MessageButton의 조합으로 이루어집니다.
  • 3가지 타입 중 1개 이상이 반드시 들어가야 하며, 최대 3가지 타입 모두 포함될 수 있습니다.
필드명 타입 필수여부 설명
text String Optional 사용자에게 발송될 메시지 텍스트(최대 1000자)
photo Photo Optional 말풍선에 들어갈 이미지 정보. 1장 제한, JPEG/PNG 포맷. 6.3에서 상세 기술
message_button MessageButton Optional 말풍선에 붙는 링크버튼 정보. 6.2.1에서 상세 기술
{
  "text": "안녕하세요.",
  "photo": {
    "url": "https://hello.photo.src",
    "width": 640,
    "height": 480
  },
  "message_button": {
    "label": "반갑습니다.",
    "url": "http://hello.world.com/example"
  }
}
6.2.1. MessageButton
  • 응답 메시지의 말풍선 하단에 보여지는 링크버튼 정보입니다.
필드명 타입 필수여부 설명
label String Required 링크버튼의 타이틀
url String Required 링크버튼의 연결 링크 주소
{
  "label": "쿠폰확인하기",
  "url": "http://coupon.coupon.com/~~"
}
6.3. Photo
  • 이미지 정보
필드명 타입 필수여부 설명
url String Required 이미지 url
width Int Required 이미지 width
height Int Required 이미지 height

이미지 권장 사이즈 : 720 x 630px
지원 파일형식 및 권장 용량 : jpg, png /500KB

{
  "url": "https://photo.src",
  "width": 640,
  "height": 480
}

7. Server information

host port comment
https://ybot.kakao.com 443 https api server

7.1. Proxy Server information

카카오에서 파트너사 서버를 호출하는 경우 아래 3대의 proxy서버를 통하게 됩니다. 파트너사 방화벽 설정을 하게 될 경우 아래 3개의 IP에 대한 ACL을 허용해주시기 바랍니다.

IP
110.76.143.234
110.76.143.235
110.76.143.236

8. Response Code

Success Response
http status code code message comment
200 0 SUCCESS 정상 응답
Error Response
http status code code comment
400 100 bad request
400 201 wrong api key
400 202 wrong bot url
503 203 wrong message format
408 204 request timeout
408 204 wrong keyboard initialization
400 301 profile not found
400 302 user not found
400 303 not user friend
400 400 unsupported media type

9. 질의응답

상단의 issue를 통해 자유롭게 질의응답을 나누실 수 있습니다.

그외 문의사항은 카카오 고객센터로 주시기 바랍니다.