챗봇 대화 내역 조회

Endpoint

[POST] API URL 정보

개발 및 테스트용 API운영 API

https://patch-kakao-api.happytalk.io/kakaoWebhook/v3/bzc/chatbot/messages

https://kakao-api.happytalk.io/kakaoWebhook/v3/bzc/chatbot/messages

Introduce

Introduce

사용자 키와 발신프로필 키를 기준으로, 챗봇과의 대화 내역을 조회하는 API입니다.

Request (Json)

Header

Field Name	Type	Required	Description
Content-Type	Text	Y	application/json
HT-Client-Id	Text	Y	고객센터에서 발급 받은 key
HT-Client-Secret	Text	Y	고객센터에서 발급 받은 token

Body

Field Name	Type (Length)	Required	Description
user_key	Text(20)	Y	사용자 키
sender_key	Text(40)	Y	발신프로필 키

Example

REST API Sample

개발 및 테스트용 API운영 API

curl -L -X POST 'https://patch-kakao-api.happytalk.io/kakaoWebhook/v3/bzc/chatbot/messages' \
-H 'Content-Type: application/json' \
-H 'HT-Client-Id: example-id' \
-H 'HT-Client-Secret: example-secret' \
-d '{"user_key":"example-user_key","sender_key":"example-sender_key"}'

curl -L -X POST 'https://kakao-api.happytalk.io/kakaoWebhook/v3/bzc/chatbot/messages' \
-H 'Content-Type: application/json' \
-H 'HT-Client-Id: example-id' \
-H 'HT-Client-Secret: example-secret' \
-d '{"user_key":"example-user_key","sender_key":"example-sender_key"}'

Response (Json)

Parameter

Field Name	Type	Description
code	Text	처리 결과 코드 (0: 정상 / 나머지: 오류)
chatbot_messages	array	챗봇 대화내역

Example

Success

발화된 챗봇 대화가 없을 때발화된 챗봇 대화가 있을 때

{
    "chatbot_messages": [],
    "code": "0"
}

{
    "chatbot_messages": [
        {
            "timestamp": 1748499650966,
            "userKey": "example-userKey",
            "messages": {
                "version": "2.0",
                "template": {
                    "outputs": [
                        {
                            "textCard": {
                                "title": "테스트",
                                "description": "테스트",
                                "buttons": [
                                    {
                                        "label": "테스트 시나리오",
                                        "highlight": false,
                                        "action": "message",
                                        "extra": {
                                            "btnName": "테스트 시나리오",
                                            "nextBlockId": "abc1112231",
                                            "nextType": "next_scenario"
                                        },
                                        "messageText": "테스트 시나리오"
                                    }
                                ],
                                "lock": false,
                                "forwardable": false
                            }
                        }
                    ],
                    "quickReplies": []
                }
            },
            "utterance": "챗봇 시작하기",
            "speech": "최초 블록",
            "appUserId": "",
            "footprint": "chp-34e8df80c85e44c098e78b0c64ef543d",
            "blockId": "63a543b5230acb40fad2dc69",
            "blockName": "해피봇 new-처음으로 이벤트 블록",
            "trigger": "LISTMENU_BLOCK",
            "extra": {
                "service": "KakaoTalkChannel"
            }
        }
    ],
    "code": "0"
}

Failure

{
    "code": "-509",
    "message": "InvalidParameterException(parameterKey: example-user_key)"
}

Data Dictionary

Data Dictionary

Request DictionaryResponse Dictionary

None

None

Reference

코드 정의