위젯 SDK
채팅 위젯
코드 한 조각으로 어느 웹사이트에나 채팅 위젯을 달고, 스크립트 옵션이나 직접 작성한 JavaScript로 조정할 수 있습니다.
삽입 코드
챗봇마다 삽입 코드가 따로 있습니다. 콘솔의 챗봇 상세 화면에서 복사하세요. 챗봇 식별자와 API 키가 이미 들어 있습니다. 코드는 다음과 같습니다.
삽입 코드
<!-- DeepFountain Widget -->
<script>
(function() {
const script = document.createElement('script');
script.src = 'https://saas.deep-fountain.com/widget-v3/YOUR_CHATBOT_IDENTIFIER/loader.js?api_key=YOUR_API_KEY';
script.setAttribute('data-api-key', 'YOUR_API_KEY');
script.async = true;
script.defer = true;
document.head.appendChild(script);
})();
</script>
<!-- End DeepFountain Widget -->
채팅을 띄울 모든 페이지의 </body> 태그 바로 앞에 붙여 넣으세요. <head>에 넣어도 됩니다. 스크립트는 백그라운드에서 불러오므로 페이지가 늦게 뜨지 않습니다.
YOUR_CHATBOT_IDENTIFIER와 YOUR_API_KEY는 자리 표시자입니다. 콘솔의 코드에는 실제 값이 들어 있습니다.
위젯 설정은 콘솔에서
위젯의 언어, 색상, 문구, 이미지, 환영 메시지, 퀵버튼은 챗봇 설정에서 가져옵니다. 콘솔에서 저장하면 다음에 페이지를 열 때부터 사이트에 반영되고, 삽입 코드는 바꿀 필요가 없습니다.
편집 화면에서 챗봇을 끄면 사이트에서 더 이상 답하지 않습니다.
스크립트 옵션
스크립트에 아래 속성을 더하면 채팅 버튼의 위치와 열린 채팅창의 크기를 바꿀 수 있습니다. 값의 단위는 픽셀입니다.
data-launcher-bottom- 화면 아래쪽 끝에서 채팅 버튼까지의 거리. 기본값 20.
data-launcher-right- 화면 오른쪽 끝에서 채팅 버튼까지의 거리. 기본값 20.
data-desktop-width- 데스크톱에서 열린 채팅창의 너비. 휴대폰에서는 채팅창이 화면을 가득 채웁니다.
data-desktop-height- 데스크톱에서 열린 채팅창의 높이.
방문자가 위젯을 옮기거나 크기를 바꾸면 그 브라우저가 기억하고, 이 옵션보다 먼저 적용합니다.
채팅 버튼을 아래에서 96px 띄우기
<!-- DeepFountain Widget -->
<script>
(function() {
const script = document.createElement('script');
script.src = 'https://saas.deep-fountain.com/widget-v3/YOUR_CHATBOT_IDENTIFIER/loader.js?api_key=YOUR_API_KEY';
script.setAttribute('data-api-key', 'YOUR_API_KEY');
script.setAttribute('data-launcher-bottom', '96');
script.setAttribute('data-launcher-right', '24');
script.async = true;
script.defer = true;
document.head.appendChild(script);
})();
</script>
<!-- End DeepFountain Widget -->
JavaScript API
스크립트를 불러온 뒤에는 페이지에서 window.dfWidget으로 위젯을 다룰 수 있습니다.
dfWidget.open()- 채팅창을 엽니다.
dfWidget.close()- 채팅창을 닫습니다.
dfWidget.sendMessage(text)- 방문자가 입력한 것처럼 메시지를 보냅니다.
dfWidget.setLauncherPosition(bottom, right)- 채팅 버튼을 옮깁니다. 화면 아래쪽과 오른쪽 끝에서의 거리를 픽셀로 받습니다.
dfWidget.setDesktopSize(width, height)- 데스크톱에서 열린 채팅창의 크기를 픽셀로 정합니다.
- 스크립트는 백그라운드에서 불러오므로, 다 불러오기 전에는 window.dfWidget이 없습니다. 직접 만든 버튼에서 부르거나, 있는지 먼저 확인하세요.
- 한 페이지에 챗봇을 여러 개 불러오면 window.dfWidget은 마지막에 불러온 챗봇을 다룹니다.
내 버튼으로 채팅 열기
<button type="button" id="chat-button">상담하기</button>
<script>
document.getElementById('chat-button').addEventListener('click', function () {
if (!window.dfWidget) return;
window.dfWidget.open();
window.dfWidget.sendMessage('영업시간이 어떻게 되나요?');
});
</script>
이벤트
위젯은 window에 아래 이벤트를 보냅니다. 채팅창이 열리거나 닫힐 때 페이지에서 원하는 동작을 붙일 수 있습니다.
deepfountain:widget:opened- 채팅창이 열렸습니다.
deepfountain:widget:closed- 채팅창이 닫혔습니다.
<script>
window.addEventListener('deepfountain:widget:opened', function () {
console.log('chat opened');
});
</script>
플랫폼별 설치 방법은 연동 가이드에 있습니다.