API 호출하기 단계를 사용하면 대화 봇이 REST API 요청을 통해 Shopify나 Salesforce와 같은 외부 시스템에서 데이터를 가져올 수 있습니다.
이 사용법에서는 최종 사용자가 입력한 위치의 날씨 데이터를 검색하는 봇 답변을 만듭니다. 답변은 OpenWeather API에서 데이터를 가져옵니다. 이 사용법에서 만든 답변 플로우를 자체 API로 제공되는 답변을 구축하는 시작점으로 사용할 수 있습니다.
작업 1: 설정 확인하기
이 사용법을 완료하려면 다음이 필요합니다.
- 게시된 대화 봇이 있는 Zendesk 계정: 원한다면 샌드박스 테스트 환경을 사용하여 대화 봇을 프로덕션 환경에 투입하기 전에 테스트할 수 있습니다.
웹 및 모바일 메시징 채널에서 대화 봇을 설정하려면 웹 및 모바일 채널용 대화 봇 만들기를 참조하세요. 샌드박스 환경에서 메시징을 사용하는 데 대한 내용은 샌드박스에서 메시징 사용하기를 참조하세요.
-
OpenWeather 계정을 위한 API 키: 이 사용법에 사용된 API는 OpenWeather의 무료 플랜에서 사용할 수 있습니다.
무료 OpenWeather 계정에 가입하려면 openweathermap.org에서 새 계정 만들기(Create New Account) 페이지를 참조하세요. 로그인 후 OpenWeather 계정 페이지에서 API 키를 받을 수 있습니다.
OpenWeather API 키를 활성화하려면 계정 이메일 주소를 확인해야 합니다. 확인 후 API 키가 활성화되는 데 최대 2시간이 걸릴 수 있습니다. 자세한 내용은 openweathermap.org에서 FAQ를 참조하세요.
작업 2: API 연결 만들기
시작하려면 API 연결을 만들어 OpenWeather API 키를 저장하세요. 대화 봇은 이 연결을 사용하여 OpenWeather API에 대한 호출을 인증할 수 있습니다.
- 관리 센터의 사이드바에서 앱 및 연동 서비스를 클릭한 다음 연결 > 연결을 선택합니다.
- 연결 만들기를 클릭합니다.
- API 키 인증 유형을 선택합니다.
- 연결 이름으로 openweather_api_key를 입력합니다.
- 헤더 이름으로 x-api-key를 입력합니다.
- 값으로 OpenWeather API 키를 입력합니다.
- 허용되는 도메인으로 api.openweathermap.org를 입력합니다.
- 저장을 클릭하여 연결을 만듭니다.
작업 3: 사용자 지정 티켓 필드 만들기
이제 최종 사용자가 입력한 위치를 캡처하는 사용자 지정 티켓 필드를 만듭니다.
- 관리 센터의 사이드바에서 개체 및 규칙을 클릭한 다음 티켓 > 필드를 선택합니다.
- 필드 추가를 클릭합니다.
- 텍스트 필드 유형을 선택합니다.
- 표시 이름으로 Location을 입력합니다.
- 권한 아래에서 고객이 편집할 수 있음을 선택합니다.
- 고객 아래에서 고객에게 표시되는 제목으로 Location을 입력합니다.
- 저장을 클릭합니다.
계정에서 단일 티켓 양식을 사용하는 경우에는 티켓 양식에 자동으로 새 필드가 나타납니다. 필드를 제거하려면 티켓 양식 편집하기를 참조하세요.
작업 4: 봇 답변 구축하기
이 섹션에서는 봇 빌더에서 답변을 만들고, 의도를 설정하고, 답변을 위한 단계를 추가하는 과정을 자세히 안내해 줍니다. 여기에는 다음 단계가 포함됩니다.
1단계: 답변 만들기
봇 빌더를 사용하여 대화 봇의 답변을 만듭니다.
- 관리 센터의 사이드바에서 채널을 클릭한 다음 AI 상담사 및 자동화 > AI 상담사를 선택합니다.
- 대화 봇 관리를 클릭합니다.
- 작업하려는 대화 봇을 클릭합니다.
- 답변 탭에서 답변 만들기를 클릭합니다.
2단계: 답변의 의도 설정하기
답변의 의도와 훈련 문구를 설정합니다. 여기에는 대화에서 답변을 트리거하는 데 사용되는 문구와 단어가 포함됩니다.
- 봇 편집 페이지의 답변 탭에서 답변 만들기를 클릭합니다.
- 답변 직접 작성을 클릭한 후 다음을 클릭합니다.
- 답변의 의도로 Get weather를 입력합니다.
- 훈련 문구 아래에 Get weather forecast 및 Get current temperature를 입력합니다.
-
다음을 클릭합니다.
응답을 구축할 수 있는 봇 빌더에 답변이 열립니다.
3단계: 초기 메시지 단계 추가하기
사용자에게 위치를 묻기 위한 메시지 보내기 단계를 추가합니다. 이는 답변 플로우의 첫 번째 단계입니다.
- 봇 빌더에서 단계 추가를 클릭합니다.
- 단계 선택 아래에서 메시지 보내기를 선택합니다.
-
봇 메시지에 다음 텍스트를 입력합니다.
What location would you like to get the weather for? Include the country code. For example: "Melbourne, AU" or "San Francisco, US"
4단계: 최종 사용자에게 위치 묻기
초기 메시지 다음에 세부 정보 묻기 단계를 추가하여 최종 사용자에게 기본 양식을 제시합니다. 양식에는 Location 티켓 필드의 값에 대한 텍스트 상자가 포함되어 있습니다.
- 봇 빌더에서 단계 추가 아이콘()을 클릭합니다.
- 단계 선택 아래에서 세부 정보 묻기를 선택합니다.
- 이름으로 Get location을 입력합니다.
- 필드에 Location 티켓 필드를 입력하고 선택합니다.
5단계: 위치에 대한 날씨 데이터 검색하기
OpenWeather API의 Current weather data 엔드포인트에서 해당 위치의 날씨 데이터를 가져오는 API 호출하기 단계를 추가합니다.
- 봇 빌더에서 단계 추가를 클릭합니다.
- 단계 선택 아래에서 API 호출하기를 선택합니다.
- 이름으로 Get weather을 입력합니다.
-
API 세부 정보 아래에서 엔드포인트 URL로
https://api.openweathermap.org/data/2.5/weather?units=metric&q=
을 입력합니다. -
변수 추가 아이콘()을 사용하여 Location 필드 변수를 엔드포인트 URL 값에 첨부합니다.
완료된 엔드포인트 URL 값은 다음과 같습니다.
- 인증에서 openweather_api 연결을 선택합니다.
- API 요청을 테스트하려면 API 호출하기를 클릭합니다.
- 데이터 테스트 아래에서 Location으로 Melbourne, AU를 입력합니다.
- API 호출하기를 클릭합니다.
- 기본 이름을 사용하여 다음 변수를 저장합니다.
- main > temp
- weather > item 1 > description
6단계: 최종 사용자에게 날씨 메시지 보내기
날씨 데이터를 검색한 후 메시지 보내기 단계를 사용하여 날씨 데이터를 포함한 메시지로 응답합니다.
- 봇 빌더에서 Get weather 단계의 API 호출 성공 브랜치 아래에 있는 단계 추가를 클릭합니다.
- 단계 선택 아래에서 메시지 보내기를 선택합니다.
-
봇 메시지에 다음 텍스트를 입력합니다.
It's {{temp}}° C with {{description}} in
-
변수 추가 아이콘()을 사용하여 Location 필드 변수를 봇 메시지 값에 첨부합니다. 그런 다음 마침표(.)를 추가합니다.
완료된 봇 메시지 값은 다음과 같습니다.
7단계: 실패 메시지 추가하기
API 호출하기 단계 중 만든 요청이 실패할 수도 있습니다. 예를 들어 요청에 존재하지 않는 위치가 포함될 수 있습니다. API 호출 실패 브랜치에 메시지 보내기 단계를 추가합니다. OpenWeather API 호출이 실패하는 경우 이 단계가 메시지를 리턴합니다.
- 봇 빌더에서 Get weather 단계의 API 호출 실패 브랜치 아래에 있는 단계 추가를 클릭합니다.
- 단계 선택 아래에서 메시지 보내기를 선택합니다.
- 봇 메시지에 다음 텍스트를 입력합니다.
I'm sorry. I wasn't able to get weather data for
-
변수 추가 아이콘()을 사용하여 Location 필드 변수를 봇 메시지 값에 첨부합니다. 그런 다음 마침표(.)를 추가합니다.
완료된 봇 메시지 값은 다음과 같습니다.
8단계: 업데이트된 봇 게시하기
답변을 라이브 상태로 푸시하려면 업데이트된 봇을 게시하세요.
- 봇 빌더의 오른쪽 위에 있는 완료를 클릭합니다.
- 봇 페이지에서 봇 게시를 클릭합니다.
- 게시를 클릭합니다.
작업 5: 변경 내용 테스트하기
변경 내용을 게시한 후 업데이트된 봇과의 대화에서 “How’s the weather?”라고 물어 새 답변을 테스트할 수 있습니다. 대화 봇 테스트에 대한 자세한 내용은 최종 사용자의 메시징 환경 테스트하기를 참조하세요.