💬

채팅

HappyTalk Developer Center / 해피톡 / 아카이브 / 채팅

메뉴

공지사항

메시지 포맷

Biz API

해피톡

카카오 상담톡 웹훅

Open API

채팅 버튼 연동 (SDK)

Description

Data Structure

Data Structure Example (Json)

Data Dictionary

Request Dictionary

Response Dictionary

Description

본 문서는 백업된 데이터에 대한 구조 설명 문서입니다.

•

데이터 이관 파라미터는 언제든지 신규로 추가될 수 있습니다.

고객사에서는 추가 파라미터들을 감안하고 연동하시기 바랍니다.

•

Json 데이터를 Json Viewer로 사용하여 한글로 확인이 가능합니다.

메시지 포맷 가이드

템플릿 메시지(template) 포맷에 대한 자세한 설명은 신규 메시지 포맷 가이드 문서를 참고하세요.

Data Structure

Field Name	Type	Length	Description
id	Bigint	20	AUTO_INCREMENT
chat_list_id	Char	30	채팅방 ID
socket_room_id	Char	30	해피톡 사용 값
from_id	Int	11	보낸 사람 ID
to_id	Int	11	받은 사람 ID
type	Char	1	채팅 타입
user_type	Char	1	보낸 사람 유저 타입
contents	Text		상담 메시지
contents_type	Varchar	15	상담 메시지 타입
status	Char	2	상담 메시지 상태 (해피톡 내부 사용 값)
counterpart_status	Char	2	상담 메시지 상태 (해피톡 내부 사용 값)
send_date	Datetime		전송일자
receive_date	Datetime		메시지 받은 일시
read_date	Datetime		메시지 읽은 일시
fail_date	Datetime		메시지 전송 실패 일시
msg_id	Varchar	50	메시지 ID (랜덤 문자열의 유니크 값)
seq	Int	11	해피톡 사용 값 (해피톡 내부 사용 값)
is_today_first_counsel	Tinyint	4	상담원 최초 상담 여부 (해피톡 내부 사용 값)

Data Structure Example (Json)

Data Structure Example

text / image / normal 예시

{
  "id": "304185866",
  "chat_list_id": "a78AbccD4abcdeFGH5i4j03k429l9m",
  "socket_room_id": "a78AbccD4abcdeFGH5i4j03k429l9m",
  "from_id": "robot1234567890",
  "to_id": "1222333444_ABCD520",
  "type": "C",
  "user_type": "B",
  "contents": "안녕하세요. 신세계면세점봇 입니다. 무엇을 도와드릴까요?\n☞ 현재 신세계면세점 온라인몰 주문가능시간 및 오프라인 매장 이용 시간이 한시적으로 변경되었습니다.\n자세한 사항은 홈페이지 공지사항 및 고객센터(1661-8778)로 연락 부탁드립니다.",
  "contents_type": "text",
  "status": "1",
  "counterpart_status": "1",
  "send_date": "2020-08-30 10:41:08",
  "receive_date": null,
  "read_date": "2020-08-30 10:41:09",
  "fail_date": null,
  "msg_id": "c5dac4d7-1b66-4bc3-a257-7284e57b9318",
  "seq": null,
  "is_today_first_counsel": "0"
}
JavaScript
복사

{
  "id": "35749047",
  "chat_list_id": "jQwGXWjCrrNFChCGl623d2c39bad92",
  "socket_room_id": "jQwGXWjCrrNFChCGl623d2c39bad92",
  "from_id": "48322362",
  "to_id": "52588",
  "type": "C",
  "user_type": "C",
  "contents": "https:\/\/patch.happytalk.io\/data\/chat_data\/2022_03_25\/4ba20d6a5a7a72133aeabfb80eab604b_w.png",
  "contents_type": "image",
  "status": "1",
  "counterpart_status": "1",
  "send_date": "2022-03-25 11:43:36",
  "receive_date": null,
  "read_date": "2022-03-25 11:43:57",
  "fail_date": null,
  "msg_id": "d93724f4-74b7-4d69-90fb-531f33cc6dcb",
  "seq": null,
  "is_today_first_counsel": "0"
}
JavaScript
복사

{
  "id": "35749044",
  "chat_list_id": "jQwGXWjCrrNFChCGl623d2c39bad92",
  "socket_room_id": "jQwGXWjCrrNFChCGl623d2c39bad92",
  "from_id": "52589",
  "to_id": "48322362",
  "type": "C",
  "user_type": "H",
  "contents": "{\"text\":\"빠르고 정확한 상담을 위해 고객님의 프로필을 입력해 주세요333:)\",\"link\":{\"name\":[\"고객 프로필 입력\"],\"url\":[\"http:\\\/\\\/local-customer.happytalk.io\\\/bot\\\/profilebot?token=Q1RtJL1TRVeA%2Bua34dzNzTlnjx91SxBFLruugrebEeDk46k%2FY6DGKlPUKml49JQ9NgJWpT4hpOsXJBDdsJedO%2BHLA4vQa%2BTdl0M1DJJN1pflUgq2Whzkxvgn7sAr%2BYi2gycO1BODj6HwJseoa5RiOBgfGOF5sKzB0tcjExshv2Q%3D\"]},\"image_url\":\"https:\\\/\\\/local.happytalk.io\\\/data2\\\/profile_bot\\\/5000100210\\\/fde2bfede744fe9f42780ea401213fd3.png\"}",
  "contents_type": "normal",
  "status": "1",
  "counterpart_status": "1",
  "send_date": "2022-03-25 11:43:09",
  "receive_date": null,
  "read_date": "2022-03-25 11:43:09",
  "fail_date": null,
  "msg_id": "c84328d7-ac4c-47fe-bf1b-c831a048a93a",
  "seq": null,
  "is_today_first_counsel": "0"
}
JavaScript
복사

template 예시 (TEXT / IMAGE / CAROUSEL)

{
  "id": "35749044",
  "chat_list_id": "jQwGXWjCrrNFChCGl623d2c39bad92",
  "socket_room_id": "jQwGXWjCrrNFChCGl623d2c39bad92",
  "from_id": "52589",
  "to_id": "48322362",
  "type": "C",
  "user_type": "H",
  "contents": "{\"type\":\"TEXT\",\"message\":\"test 신규test 신규test 신규test 신규\",\"isLocked\":false,\"buttonList\":[{\"type\":\"TEXT\",\"name\":\"!종료\"}],\"quickReplyList\":[{\"type\":\"TEXT\",\"name\":\"!종료\"}]}",
  "contents_type": "template",
  "status": "1",
  "counterpart_status": "1",
  "send_date": "2025-10-25 11:43:09",
  "receive_date": null,
  "read_date": "2025-10-25 11:43:09",
  "fail_date": null,
  "msg_id": "c84328d7-ac4c-47fe-bf1b-c831a048a93a",
  "seq": null,
  "is_today_first_counsel": "0"
}
JavaScript
복사

{
  "id": "35749044",
  "chat_list_id": "jQwGXWjCrrNFChCGl623d2c39bad92",
  "socket_room_id": "jQwGXWjCrrNFChCGl623d2c39bad92",
  "from_id": "52589",
  "to_id": "48322362",
  "type": "C",
  "user_type": "H",
  "contents": "{\"type\":\"IMAGE\",\"message\":\"이미지 혼합형 테스트 입니다\\n1\",\"isLocked\":false,\"image\":{\"imageUrl\":\"https:\\/\\/patch.happytalk.io\\/data\\/template\\/1000225100\\/1000225100_a8533563f0b5a28bae97055849958062_w.jpg\"},\"buttonList\":[{\"type\":\"WEB_LINK\",\"name\":\"해피톡\",\"pcUrl\":\"https:\\/\\/www.happytalk.io\",\"mobileUrl\":\"https:\\/\\/www.happytalk.io\"},{\"type\":\"TEXT\",\"name\":\"봇 키워드\"}],\"quickReplyList\":[{\"type\":\"WEB_LINK\",\"name\":\"해피톡\",\"pcUrl\":\"https:\\/\\/www.happytalk.io\",\"mobileUrl\":\"https:\\/\\/www.happytalk.io\"},{\"type\":\"TEXT\",\"name\":\"봇 키워드\"}]}",
  "contents_type": "template",
  "status": "1",
  "counterpart_status": "1",
  "send_date": "2025-10-25 11:43:09",
  "receive_date": null,
  "read_date": "2025-10-25 11:43:09",
  "fail_date": null,
  "msg_id": "c84328d7-ac4c-47fe-bf1b-c831a048a93a",
  "seq": null,
  "is_today_first_counsel": "0"
}
JavaScript
복사

{
  "id": "35749044",
  "chat_list_id": "jQwGXWjCrrNFChCGl623d2c39bad92",
  "socket_room_id": "jQwGXWjCrrNFChCGl623d2c39bad92",
  "from_id": "52589",
  "to_id": "48322362",
  "type": "C",
  "user_type": "H",
  "contents": "{\"type\":\"CAROUSEL\",\"message\":\"캐러셀 + 바로 연결\",\"isLocked\":false,\"quickReplyList\":[{\"type\":\"TEXT\",\"name\":\"챗봇 발화 버튼\"},{\"type\":\"WEB_LINK\",\"name\":\"링크 버튼\",\"pcUrl\":\"https:\\/\\/www.happytalk.io\",\"mobileUrl\":\"https:\\/\\/www.happytalk.io\"}],\"carouselBlocks\":[{\"header\":\"케러셀 1번 헤더\",\"message\":\"케러셀 1번 메시지\",\"image\":{\"imageUrl\":\"https:\\/\\/patch.happytalk.io\\/data\\/template\\/1000225100\\/1000225100_a8533563f0b5a28bae97055849958062_w.jpg\"},\"buttonList\":[{\"type\":\"TEXT\",\"name\":\"챗봇 발화 버튼\"},{\"type\":\"WEB_LINK\",\"name\":\"링크 버튼\",\"pcUrl\":\"https:\\/\\/www.happytalk.io\",\"mobileUrl\":\"https:\\/\\/www.happytalk.io\"}],\"coupon\":{\"name\":\"10% 할인 쿠폰\",\"description\":\"신규 고객 한정\",\"pcUrl\":\"https:\\/\\/www.happytalk.io\",\"mobileUrl\":\"https:\\/\\/www.happytalk.io\",\"schemaAOS\":\"https:\\/\\/www.happytalk.io\",\"schemaIOS\":\"https:\\/\\/www.happytalk.io\"}},{\"header\":\"케러셀 2번 헤더\",\"message\":\"케러셀 2번 메시지\",\"image\":{\"imageUrl\":\"https:\\/\\/dev.happytalk.io\\/data\\/template\\/1000225100\\/1000225100_a8533563f0b5a28bae97055849958062_w.jpg\"},\"buttonList\":[{\"type\":\"TEXT\",\"name\":\"챗봇 발화 버튼\"},{\"type\":\"WEB_LINK\",\"name\":\"링크 버튼\",\"pcUrl\":\"https:\\/\\/www.happytalk.io\",\"mobileUrl\":\"https:\\/\\/www.happytalk.io\"}],\"coupon\":{\"name\":\"10% 할인 쿠폰\",\"description\":\"신규 고객 한정\",\"pcUrl\":\"https:\\/\\/www.happytalk.io\",\"mobileUrl\":\"https:\\/\\/www.happytalk.io\",\"schemaAOS\":\"https:\\/\\/www.happytalk.io\",\"schemaIOS\":\"https:\\/\\/www.happytalk.io\"}}]}",
  "contents_type": "template",
  "status": "1",
  "counterpart_status": "1",
  "send_date": "2025-10-25 11:43:09",
  "receive_date": null,
  "read_date": "2025-10-25 11:43:09",
  "fail_date": null,
  "msg_id": "c84328d7-ac4c-47fe-bf1b-c831a048a93a",
  "seq": null,
  "is_today_first_counsel": "0"
}
JavaScript
복사

Data Dictionary

Request Dictionary

None

Response Dictionary

type

user_type

contents_type

Type	Description
C	채팅
M	메모