알림 API는 외부 웹 서비스와 연동하여 네이버 톡톡의 알림 메시지를 전송하는 기능으로, 고객 상담 요청 등을 효율적으로 처리할 수 있습니다. 본 글에서는 알림 API의 정의, 사용 방법, 설정 방법, 문제 해결 및 기술 사양에 대해 자세히 설명합니다.
알림 API란 무엇인가요?
알림 API의 개념
알림 API는 네이버 톡톡의 알림 메시지를 외부 웹 서비스에 전송하는 기능으로, 파트너가 설정한 특정 주소로 메시지를 보내는 방식입니다. 이를 통해 고객의 상담 요청이 발생했을 때 신속하게 외부 서비스에 알림을 보낼 수 있습니다.
사용 대상
독립적인 서비스 운영자나 호스팅사에 입점한 파트너들은 개발자의 도움을 받아 알림 API를 수신하는 서버를 구축한 후 이 기능을 활용할 수 있습니다.
알림 API는 어떻게 사용되나요?
데이터 전송 방식
알림 API는 네이버 톡톡에서 정의한 메시지 형식으로 데이터를 지정된 URL에 전송합니다. 파트너가 운영하는 서버가 알림 API 수신을 지원하면, 네이버 톡톡 파트너 센터에 로그인하지 않고도 알림 메시지를 수신할 수 있습니다.
활용 사례
수신된 알림 메시지는 다양한 형태로 파트너에게 제공될 수 있습니다. 예를 들어, POS 시스템에 연동하여 고객 예약 알림을 수신하거나, 업체에서 개발한 앱으로 알림 메시지를 전송하는 방법이 있습니다.
알림 API 설정 방법
- 알림 API URL을 생성합니다.
- 네이버 톡톡 파트너 센터에 로그인 후 ‘기본 설정 > 알림 API’ 메뉴로 이동합니다.
- ‘정보변경’ 버튼을 클릭하여 입력창을 활성화합니다.
- 알림 URL을 입력한 후 ‘등록’ 버튼을 클릭하여 테스트 메시지를 수신합니다.
- 수신 성공 시, 수신설정을 ‘ON’으로 변경하고 저장합니다.
알림 API 수신 서버가 HTTP STATUS 200을 반환하면 정상으로 판단됩니다. 테스트 메시지의 예시는 아래와 같습니다.
TEST MESSAGE
{
"username": "파트너테스트",
"icon_url": "https://phinf.pstatic.net/contact/27/2015/9/14/naver_talk_1442235844278.png?type=s160",
"text": "{파트너계정ID} 대화요청 테스트입니다. <https://partner.talk.naver.com/ct/partner/{파트너계정ID}|톡톡가기>"
}
알림 API 수신 문제 해결
수신 설정 변경 원인
알림 API 수신 서버에서 에러가 발생할 경우, 수신 설정이 OFF로 변경될 수 있습니다. 이는 에러 발생 횟수가 10건을 초과할 때 자동으로 발생합니다. 이 상태에서는 알림 메시지를 받을 수 없습니다.
수신 설정 복구 방법
수신 설정이 OFF로 변경된 경우, 네이버 톡톡 파트너 센터에서 수신 설정을 다시 ON으로 변경하면 알림 메시지를 다시 받을 수 있습니다.
알림 API의 JSON 포맷
알림 API는 JSON 포맷으로 알림 메시지를 제공합니다. 아래는 JSON 포맷의 예시입니다.
json
{
"username": "홍길동",
"icon_url": "https://phinf.pstatic.net/contact/84/2014/9/24/홍길동.jpg?type=s160",
"text": "대화요청 합니다. <https://partner.talk.naver.com/ct/partner/{파트너계정ID}/chat/{회원문자열}|톡톡가기>"
}
속성 설명
- username: 상담 요청한 고객의 프로필명
- icon_url: 고객의 프로필 이미지 링크
- text: 채팅창으로 이동 가능한 알림 문구
자주 묻는 질문
알림 API를 사용하기 위해 개발자가 필요한가요?
네, 알림 API를 사용하는 데는 개발자의 도움이 필요합니다. 알림 수신 서버를 구축해야 하므로 기술적인 지원이 필요합니다.
알림 메시지를 수신하지 못하는 이유는 무엇인가요?
알림 메시지를 수신하지 못하는 이유는 여러 가지가 있을 수 있습니다. 에러 발생 횟수가 많거나, 고객과 대화 중인 경우에는 알림 메시지가 발송되지 않을 수 있습니다.
알림 API의 설정을 잘못했을 경우 어떻게 하나요?
설정이 잘못된 경우, 네이버 톡톡 파트너 센터에서 설정을 다시 확인하고 수정하면 됩니다.
테스트 메시지를 어떻게 확인하나요?
테스트 메시지는 알림 URL을 등록한 후, 해당 URL로 전송된 메시지를 통해 확인할 수 있습니다.
알림 API 사용 시 주의사항은 무엇인가요?
알림 API 수신 서버의 에러 발생 횟수를 주의 깊게 관리해야 하며, 고객과 대화 중일 때는 알림 메시지가 발송되지 않음을 유의해야 합니다.