🔢

상담방 번호 검색

HappyTalk Developer Center / 해피톡 / 상담 내역 조회 / 상담방 번호 검색

메뉴

공지사항

메시지 포맷

Biz API

해피톡

카카오 상담톡 웹훅

Open API

채팅 버튼 연동 (SDK)

Endpoint

[POST] API URL 정보

개발 및 테스트용 API

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

운영 API

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

Request (Json)

Header

Body

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

Example

REST API Sample

개발 및 테스트용 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" : "상담방 번호"
}'
JavaScript
복사

운영 API

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

Response (Json)

메시지 포맷 가이드

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

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~10	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"
        }
      ]
    }
  ]
}
JavaScript
복사

Failure

Fail Code 정보

Data Dictionary

Request Dictionary

None

Response Dictionary

chat

out_api

status

parcel_companycode

phone_os

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

message

type

user_type

contents_type

content

Link

Type	Description
C	메시지
M	메모