18.1공통
통계 데이터 처리를 위해 제공되는 API 문서입니다.
http/https 프로토콜을 사용하며, GET, POST method를 사용합니다.
response는 JSON형태 로 전달됩니다.
18.1.1RESPONSE SAMPLE
[성공]
{
"code": "0",
... // 요청한 데이터
}[잘못된 요청 또는 에러]
{
"code": "500",
"message": "상세 내용"
}18.1.2코드 정의
code | 설명 |
|---|---|
0 | 요청 성공 |
400 | 잘못된 요청 (예: 필수 필드 누락, 잘못된 데이터 형식) |
403 | 권한 없음 (예: 리소스 접근 불가) |
404 | 리소스 없음 (예: 데이터나 URL 없음) |
500 | 내부 서버 오류 (예: 예외 발생, 처리 실패) |
18.2챗봇 통계
SIP 메시지로 전달되던, 콜봇의 스팩(payload)과 동일하게 챗봇용으로 실시간 전송 가능한 API를 지원합니다.
18.2.1통계 설정
sentenceType 별로 통계 설정을 처리합니다.
"SHORT_HEAD"
"DATAHUB"
"FALLBACK"
"BUILT_IN"
- [Request]
항목 | 내용 |
|---|---|
Method | POST |
URL | /v1/stats/chatbot/set |
Header | Content-Type: application/json; charset=UTF-8 |
- [Parameter]
키 | 타입 | 필수 | 설명 |
|---|---|---|---|
tenant_id | string | Y | tenant id |
chat_room_id | string | Y | 채팅방 id |
customer_ani | string | Y | 발신자 전화번호 ex) 01077778888 |
event_time | string | Y | 이벤트 일시 "YYYYMMDDHH24MISS" ex) "20230220173354" |
data | object(json) | Y | 데이터 |
- [Parameter] - data 상세
키 | 타입 | 필수 | 설명 | |
|---|---|---|---|---|
data | - | - | - | - |
key | string | Y | 고객이 상담센터로 전화해서 호를 종료할 때까지 관리하는 유일키. | |
intent | string | Y | intent 이름 | |
utterance | string | Y | 발신자 발화 (암호화됨) | |
sentence | string | N | 응답 TTS (암호화됨) | |
insts | array | N | 해당 요청에서 응답한 instruction 목록 | |
botflow | string | N | botflow 이름 | |
scenario | string | N | botflow 의 scenario 이름 | |
state | string | N | botflow state 이름 | |
sentenceScenario | string | N | 봇의 응답 sentence 가 만들어진 scenario. | |
sentenceType | string | N | 응답 TTS (sentence) 의 유형.
유형에 따라 추가되는 필드가 존재 | |
shortHead.inquireId | integer | N | SHORT_HEAD 추가필드 | |
shortHead.intentName | string | N | SHORT_HEAD 추가필드 | |
shortHead.inquiryType | string | N | SHORT_HEAD 추가필드 | |
datahub.sourceType | string | N | DATAHUB 추가필드 | |
datahub.contentId | string | N | DATAHUB 추가필드 | |
datahub.title | string | N | DATAHUB 추가필드 | |
fallback.postAction | string | N | FALLBACK 추가필드 |
{
"tenant_id": "1",
"chat_room_id": "12345",
"customer_ani": "01077778888",
"event_time": "20230220173354",
"data": {
"key": "00FA0800020015639153B0",
"intent": "connectAdvicetalk",
"utterance": "9sdfwieuhbf8ds7tcsdgbcischisd",
"sentence": "ds9f8sdhc8s7ysd8gbdsvdssd9fds98sdgh",
"insts": [
{
"type": "Vendor.Kep.Kicc.HangupCall"
},
{
"type": "Vendor.Kep.Kicc.SendInfo",
"actionType": "CALLBACK"
},
{
"type": "Vendor.Kep.Kicc.SendInfo",
"actionType": "SANGDAMTOG"
},
{
"type": "Vendor.Kep.Kicc.TransferCall",
"to": "700000"
}
],
"botflow": "FAQ_CALLBOT_BT",
"scenario": "FAQ_SC",
"sentenceType": "DATAHUB",
"datahub.contentId": "sdd09q3jsdhv",
"datahub.sourceType": "VECTOR",
"datahub.title": "타이틀입니다."
}
}- [Response]
키 | 타입 | 필수 | 설명 |
|---|---|---|---|
code | string | Y | 처리 결과 코드(0은 정상 / 나머지는 오류) |
message | string | N | 오류 메시지(오류시 존재하는 값) |