상담방 번호 검색

Endpoint

[POST] API URL 정보

개발 및 테스트용 API운영 API

https://patch-customer.happytalk.io/user/api/chat_data/format/json

https://customer.happytalk.io/user/api/chat_data/format/json

Request (Json)

None

Body

Field Name	Type (Length)	Required	Description	Default
token	String	Y	고객사 토큰
room_id	String	Y	상담방 번호

Example

REST API Sample

개발 및 테스트용 API운영 API

curl --location --request POST 'https://patch-customer.happytalk.io/user/api/chat_data/format/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token" : "고객사 토큰",
    "room_id" : "상담방 번호"
}'

curl --location --request POST 'https://customer.happytalk.io/user/api/chat_data/format/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token" : "고객사 토큰",
    "room_id" : "상담방 번호"
}'

Response (Json)

메시지 포맷 가이드

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

템플릿 V1/V2 적용 대상 안내

템플릿 V1 업체: Biz API, 아카이브, 상담내역 API, Happytalk Embedded 사용 고객사
→ Data Dictionary(V2)를 참고하여 대응 개발이 필요합니다.
템플릿 V2 업체: 위 조건에 해당하지 않는 고객사

템플릿 V2 유형 사용을 희망하실 경우, 대응 개발 완료 후 해피톡 고객센터로 문의해 주시기 바랍니다.

자세한 내용은 템플릿 타입 전환 안내(~26/06/30) 공지에서 확인하실 수 있습니다.

Parameter

Field Name			Type	Description
result			String	success : 성공 , fail : 실패
data			Object[]	상담 내역 객체
	chat		Object	상담방 정보
		id	String	상담방 ID
		title	String	상담방 제목
		counselor_name	String	상담사 이름
		counselor_nickname	String	상담사 별명
		customer_uuid	String	고객 식별 번호
		users_id	String	고객 ID
		category_id	String	대분류 ID
		division_id	String	중분류 ID
		tags	Array	태그
		cate_name1	String	대분류 명칭
		cate_name2	String	중분류 명칭
		etc_assign	String	소분류 명칭
		reg_date	datetime	상담방 등록 일시
		complate_date	datetime	상담방 종료 일시
		out_api	out_api	상담 환경 분류
		status	status	상담방 상태
		order_number	String	상품 주문 번호
		product_number	String	상품 번호
		parcel_number	String	운송장 번호
		parcel_companycode	parcel_companycode	택배사 코드
		app_ver	String	앱 버전
		phone_os	phone_os	휴대전화 OS
		phone_model	String	휴대전화 모델명
		phone_osver	String	휴대전화 OS 구분 값
		phone_telecomm	String	통신사 정보
		app_hash	String	앱 식별 번호
		parameter1	String	커스텀 파라미터
		parameter2	String	커스텀 파라미터
		parameter3	String	커스텀 파라미터
		parameter4	String	커스텀 파라미터
		parameter5	String	커스텀 파라미터
		parameter6	String	커스텀 파라미터
		parameter7	String	커스텀 파라미터
		parameter8	String	커스텀 파라미터
		parameter9	String	커스텀 파라미터
		parameter10	String	커스텀 파라미터
		user_parameter	String	사용자 변수
		vote_score	String	상담 평가 점수
		vote_comment	String	상담 평가 내용
	message		Array	메시지 목록
		id	String	메시지 ID
		from_id	String	메시지 발송 ID
		to_id	String	메시지 수신 ID
		type	type	메시지 타입
		user_type	user_type	발송자 구분 타입
		contents_type	contents_type	메시지 내용 타입
		contents	String	메시지 내용 (template 메시지 구조)
		send_date	datetime	메시지 발송 일시
		read_date	datetime	메시지 확인 일시

Example

Success

{
  "result": "success",
  "data": [
    {
      "chat": {
        "id": "68dd2893cbfbfTSDc66M6MvVeYpG2a",
        "title": "1:1 채팅 상담 문의 드립니다.",
        "counselor_name": "lc_biz_api",
        "counselor_nickname": "lc_biz_api",
        "customer_uuid": "1000227669_lc251001-1",
        "users_id": "lc251001-1",
        "category_id": "75725",
        "division_id": "75726",
        "tags": [],
        "cate_name1": "상품문의(샘플)",
        "cate_name2": "일반상담(샘플)",
        "etc_assign": "",
        "reg_date": "2025-10-01 22:11:47",
        "complate_date": "0000-00-00 00:00:00",
        "out_api": "0",
        "status": "1",
        "order_number": "",
        "product_number": "",
        "parcel_number": "",
        "parcel_companycode": "",
        "app_ver": "",
        "phone_os": "",
        "phone_model": "",
        "phone_osver": "",
        "phone_telecomm": "",
        "app_hash": "",
        "parameter1": "",
        "parameter2": "",
        "parameter3": "",
        "parameter4": "",
        "parameter5": "",
        "parameter6": "",
        "parameter7": "",
        "parameter8": "",
        "parameter9": "",
        "parameter10": "",
        "user_parameter": "",
        "vote_score": null,
        "vote_comment": null
      },
      "message": [
        {
          "id": "942984610",
          "from_id": "1000227669_lc251001-1",
          "to_id": "lc_biz_api",
          "type": "C",
          "user_type": "C",
          "contents_type": "text",
          "contents": "1:1 채팅 상담 문의 드립니다.",
          "send_date": "2025-10-01 22:11:47",
          "read_date": "2025-10-01 22:12:29"
        },
        {
          "id": "942984613",
          "from_id": "lc_biz_api",
          "to_id": "1000227669_lc251001-1",
          "type": "C",
          "user_type": "H",
          "contents_type": "template",
          "contents": "{\"type\":\"TEXT\",\"message\":\"텍스트 + 버튼에 텍스트\",\"isLocked\":false,\"buttonList\":[{\"type\":\"WEB_LINK\",\"name\":\"링크\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://example.com\"},{\"type\":\"TEXT\",\"name\":\"봇키워드\"}]}",
          "send_date": "2025-10-01 22:12:41",
          "read_date": "2025-10-01 22:18:01"
        },
        {
          "id": "942984618",
          "from_id": "lc_biz_api",
          "to_id": "1000227669_lc251001-1",
          "type": "C",
          "user_type": "H",
          "contents_type": "template",
          "contents": "{\"type\":\"TEXT\",\"message\":\"텍스트 + 버튼에 텍스트\",\"isLocked\":true,\"buttonList\":[{\"type\":\"WEB_LINK\",\"name\":\"링크\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://example.com\"},{\"type\":\"TEXT\",\"name\":\"봇키워드\"},{\"type\":\"COUPON\",\"name\":\"10% 할인 쿠폰\",\"description\":\"신규 고객 한정\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://m.example.com\",\"schemaAOS\":\"https://example.com\",\"schemaIOS\":\"https://example.com\"}],\"quickReplyList\":[{\"type\":\"WEB_LINK\",\"name\":\"링크\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://example.com\"},{\"type\":\"TEXT\",\"name\":\"봇키워드\"}]}",
          "send_date": "2025-10-01 22:13:35",
          "read_date": "2025-10-01 22:18:01"
        },
        {
          "id": "942984619",
          "from_id": "lc_biz_api",
          "to_id": "1000227669_lc251001-1",
          "type": "C",
          "user_type": "H",
          "contents_type": "template",
          "contents": "{\"type\":\"IMAGE\",\"message\":\"이미지 + 텍스트에 텍스트\",\"isLocked\":false,\"image\":{\"imageUrl\":\"https://example.com/data/template/1000227669/1000227669_7601e3f04190e4030569884f44d4d34b_w.jpg\"}}",
          "send_date": "2025-10-01 22:13:42",
          "read_date": "2025-10-01 22:18:01"
        },
        {
          "id": "942984620",
          "from_id": "lc_biz_api",
          "to_id": "1000227669_lc251001-1",
          "type": "C",
          "user_type": "H",
          "contents_type": "template",
          "contents": "{\"type\":\"IMAGE\",\"message\":\"이미지+텍스트+버튼에 텍스트\",\"isLocked\":false,\"image\":{\"imageUrl\":\"https://example.com/data/template/1000227669/1000227669_617a9702bfdd26b8ea395ea465fede4b_w.jpg\"},\"buttonList\":[{\"type\":\"WEB_LINK\",\"name\":\"이링크\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://example.com\"},{\"type\":\"TEXT\",\"name\":\"이봇키워드\"}]}",
          "send_date": "2025-10-01 22:13:52",
          "read_date": "2025-10-01 22:18:01"
        },
        {
          "id": "942984621",
          "from_id": "lc_biz_api",
          "to_id": "1000227669_lc251001-1",
          "type": "C",
          "user_type": "H",
          "contents_type": "template",
          "contents": "{\"type\":\"IMAGE\",\"message\":\"이미지+텍스트+버튼에 텍스트\",\"isLocked\":true,\"image\":{\"imageUrl\":\"https://example.com/data/template/1000227669/1000227669_617a9702bfdd26b8ea395ea465fede4b_w.jpg\"},\"buttonList\":[{\"type\":\"WEB_LINK\",\"name\":\"이링크\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://example.com\"},{\"type\":\"TEXT\",\"name\":\"이봇키워드\"},{\"type\":\"COUPON\",\"name\":\"10% 할인 쿠폰\",\"description\":\"신규 고객 한정\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://m.example.com\",\"schemaAOS\":\"https://example.com\",\"schemaIOS\":\"https://example.com\"}],\"quickReplyList\":[{\"type\":\"WEB_LINK\",\"name\":\"이링크\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://example.com\"},{\"type\":\"TEXT\",\"name\":\"이봇키워드\"}]}",
          "send_date": "2025-10-01 22:13:55",
          "read_date": "2025-10-01 22:18:01"
        },
        {
          "id": "942984622",
          "from_id": "lc_biz_api",
          "to_id": "1000227669_lc251001-1",
          "type": "C",
          "user_type": "H",
          "contents_type": "template",
          "contents": "{\"type\":\"CAROUSEL\",\"message\":\"캐러셀 + 바로 연결\",\"isLocked\":true,\"quickReplyList\":[{\"type\":\"TEXT\",\"name\":\"챗봇 발화 버튼\"},{\"type\":\"WEB_LINK\",\"name\":\"링크 버튼\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://m.example.com\"}],\"carouselBlocks\":[{\"header\":\"캐러셀 1번 헤더\",\"message\":\"캐러셀 1번 메시지\",\"image\":{\"imageUrl\":\"https://example.com/data/template/1000225100/1000225100_a8533563f0b5a28bae97055849958062_w.jpg\"},\"buttonList\":[{\"type\":\"TEXT\",\"name\":\"챗봇 발화 버튼\"},{\"type\":\"WEB_LINK\",\"name\":\"링크 버튼\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://m.example.com\"}],\"coupon\":{\"name\":\"10% 할인 쿠폰\",\"description\":\"신규 고객 한정\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://m.example.com\",\"schemaAOS\":\"https://example.com\",\"schemaIOS\":\"https://example.com\"}},{\"header\":\"캐러셀 2번 헤더\",\"message\":\"캐러셀 2번 메시지\",\"image\":{\"imageUrl\":\"https://example.com/data/template/1000225100/1000225100_a8533563f0b5a28bae97055849958062_w.jpg\"},\"buttonList\":[{\"type\":\"TEXT\",\"name\":\"챗봇 발화 버튼\"},{\"type\":\"WEB_LINK\",\"name\":\"링크 버튼\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://m.example.com\"}],\"coupon\":{\"name\":\"10% 할인 쿠폰\",\"description\":\"신규 고객 한정\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://m.example.com\",\"schemaAOS\":\"https://example.com\",\"schemaIOS\":\"https://example.com\"}}]}",
          "send_date": "2025-10-01 22:13:59",
          "read_date": "2025-10-01 22:18:01"
        },
        {
          "id": "942984623",
          "from_id": "lc_biz_api",
          "to_id": "1000227669_lc251001-1",
          "type": "C",
          "user_type": "H",
          "contents_type": "template",
          "contents": "{\"type\":\"CAROUSEL\",\"message\":\"캐러셀 + 바로 연결\",\"isLocked\":false,\"quickReplyList\":[{\"type\":\"TEXT\",\"name\":\"챗봇 발화 버튼\"},{\"type\":\"WEB_LINK\",\"name\":\"링크 버튼\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://m.example.com\"}],\"carouselBlocks\":[{\"header\":\"캐러셀 1번 헤더\",\"message\":\"캐러셀 1번 메시지\",\"image\":{\"imageUrl\":\"https://example.com/data/template/1000225100/1000225100_a8533563f0b5a28bae97055849958062_w.jpg\"},\"buttonList\":[{\"type\":\"TEXT\",\"name\":\"챗봇 발화 버튼\"},{\"type\":\"WEB_LINK\",\"name\":\"링크 버튼\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://m.example.com\"}],\"coupon\":{\"name\":\"10% 할인 쿠폰\",\"description\":\"신규 고객 한정\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://m.example.com\",\"schemaAOS\":\"https://example.com\",\"schemaIOS\":\"https://example.com\"}},{\"header\":\"캐러셀 2번 헤더\",\"message\":\"캐러셀 2번 메시지\",\"image\":{\"imageUrl\":\"https://example.com/data/template/1000225100/1000225100_a8533563f0b5a28bae97055849958062_w.jpg\"},\"buttonList\":[{\"type\":\"TEXT\",\"name\":\"챗봇 발화 버튼\"},{\"type\":\"WEB_LINK\",\"name\":\"링크 버튼\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://m.example.com\"}],\"coupon\":{\"name\":\"10% 할인 쿠폰\",\"description\":\"신규 고객 한정\",\"pcUrl\":\"https://example.com\",\"mobileUrl\":\"https://m.example.com\",\"schemaAOS\":\"https://example.com\",\"schemaIOS\":\"https://example.com\"}}]}",
          "send_date": "2025-10-01 22:14:08",
          "read_date": "2025-10-01 22:18:01"
        }
      ]
    }
  ]
}

Fail

Failure

Fail Code 정보

Data Dictionary(V1)

Data Dictionary

Request DictionaryResponse Dictionary

None

chatmessage

out_apistatusparcel_companycodephone_os

Type	Description
0	해피톡
1	네이버 톡톡
2	카카오톡
7	인스타그램

Type	Description
-2	봇 상담 대기
-1	봇 상담
0	접수 대기
1	진행중
2	완료
3	삭제
4	봇 상담 종료

Code	택배사명
1	우체국택배
4	대한통운
5	한진택배
6	로젠택배
8	롯데택배
11	일양로지스
12	EMS
13	DHL
18	건영택배
21	Fedex
22	대신택배
23	경동택배
24	CVSnet 편의점택배
25	TNT Express
42	CJ대한통운 국제특송
45	호남택배
53	농협택배
99	롯데글로벌 로지스

Type	Description
A	안드로이드
I	아이폰
W	웹

typeuser_typecontents_typecontentLink

Type	Description
C	메시지
M	메모

Type	Description
H	상담원
C	고객
B	상담원 봇

Type	Description
text	단순 텍스트 메시지
image	이미지 파일
normal	혼합형 메시지 (텍스트 + 링크 버튼)

필드명	데이터 타입	필수여부	설명
text	String	Y	메시지 텍스트
image_url	String	N	이미지 URL
link	Link	N	링크 버튼 정보

필드명	데이터 타입	필수여부	설명
name	String[]	Y	링크 버튼 제목 리스트
url	String[]	Y	링크 버튼 URL 리스트

Data Dictionary(V2)

Data Dictionary

Request DictionaryResponse Dictionary

None

chatmessage

out_apistatusparcel_companycodephone_os

Type	Description
0	해피톡
1	네이버 톡톡
2	카카오톡
7	인스타그램

Type	Description
-2	봇 상담 대기
-1	봇 상담
0	접수 대기
1	진행중
2	완료
3	삭제
4	봇 상담 종료

Code	택배사명
1	우체국택배
4	대한통운
5	한진택배
6	로젠택배
8	롯데택배
11	일양로지스
12	EMS
13	DHL
18	건영택배
21	Fedex
22	대신택배
23	경동택배
24	CVSnet 편의점택배
25	TNT Express
42	CJ대한통운 국제특송
45	호남택배
53	농협택배
99	롯데글로벌 로지스

Type	Description
A	안드로이드
I	아이폰
W	웹

typeuser_typecontents_typecontents (template 타입)

Type	Description
C	메시지
M	메모

Type	Description
H	상담원
C	고객
B	상담원 봇

Type	Description
text	단순 텍스트 메시지
image	이미지 파일
normal	혼합형 메시지 (텍스트 + 링크 버튼)
template	템플릿 메시지

TypebuttonList[]ButtonTypequickReplyList[]QuickReplyTypeimagecarouselBlocks[]coupon

타입명	설명
TEXT	텍스트 메시지와 버튼, 바로연결 등 혼합형 메시지를 발화하는 타입
IMAGE	이미지 + 텍스트 메시지와 버튼, 바로연결 등 혼합형 메시지를 발화하는 타입
CAROUSEL	별도의 필드에 메시지를 정의하여 블록을 슬라이드 형태로 보여줄 수 있는 타입

Optional

필드명	데이터 타입	필수여부	설명
type	ButtonType	Y	버튼 타입을 정의하는 필드
name	text (30)	Y	버튼 이름
pcUrl	text(1000)	Y/N	PC 환경에서 지정된 URL로 연결 해주는 필드 (ButtonType이 WEB_LINK, COUPON 일때 필수)
mobileUrl	text(1000)	Y/N	MOBILE 환경에서 지정된 URL로 연결 해주는 필드 (ButtonType이 WEB_LINK, COUPON 일때 필수)
description	text(12)	Y/N	쿠폰 설명 (ButtonType이 COUPON 일때 필수)
schemaAOS	text(1000)	N	안드로이드 기기 환경에서 앱스키마를 호출할 수 있는 필드 (추후 지원 예정)
schemaIOS	text(1000)	N	IOS 기기 환경에서 앱스키마를 호출할 수 있는 필드 (추후 지원 예정)

타입명	설명
TEXT	버튼 이름을 발화하는 버튼
WEB_LINK	지정된 URL로 이동 시키는 버튼
COUPON	쿠폰 형태 버튼

Optional

필드명	데이터 타입	필수여부	설명
type	QuickReplyType	Y	바로 연결 버튼 타입을 정의하는 필드
name	text (14)	Y	바로 연결 버튼 이름
pcUrl	text(1000)	Y/N	PC 환경에서 지정된 URL로 연결 해주는 필드 (QuickReplyType이 WEB_LINK 일때 필수)
mobileUrl	text(1000)	Y/N	MOBILE 환경에서 지정된 URL로 연결 해주는 필드 (QuickReplyType이 WEB_LINK 일때 필수)

타입명	설명
TEXT	버튼 이름을 발화하는 버튼
WEB_LINK	지정된 URL로 이동 시키는 버튼

Optional

필드명	데이터 타입	필수여부	설명
imageUrl	text	Y	해피톡 서버에 업로드된 이미지 URL

Optional (Type이 CAROUSEL인 경우 필수)

필드명	데이터 타입	필수여부	설명
header	text(20)	Y	헤더 문구 필드
message	text(180)	Y	메시지 필드
image	Image	Y	이미지 정보 필드
buttonList	buttonList[]	N	버튼 필드 정의시 최소 1개, 최대 2개 (COUPON 타입 제외)
coupon	coupon	N	쿠폰 정보 필드

필드명	데이터 타입	필수여부	설명
name	text (30)	Y	쿠폰 이름
description	text (12)	Y	쿠폰 설명
pcUrl	text(1000)	Y	PC 환경에서 지정된 URL로 연결 해주는 필드
mobileUrl	text(1000)	Y	MOBILE 환경에서 지정된 URL로 연결 해주는 필드
schemaAOS	text(1000)	N	안드로이드 기기 환경에서 앱스키마를 호출할 수 있는 필드 (추후 지원 예정)
schemaIOS	text(1000)	N	IOS 기기 환경에서 앱스키마를 호출할 수 있는 필드 (추후 지원 예정)

상담방 번호 검색

Endpoint

Request (Json)

Header

Body

Example

Response (Json)

Parameter

Example

Fail

Data Dictionary(V1)

Data Dictionary(V2)