상담방 목록 검색

Endpoint

[POST] API URL 정보

개발 및 테스트용 API운영 API

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

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

Auth Description

인증 방법

Body에 해피톡 고객센터를 통하여 발급받은 고객사 토큰 값을 삽입하여 API 통신 시도
고객사 토큰은 설정 > 회사 정보 관리 > 상단 시스템 정보 > TOKEN 에서 확인하실 수 있습니다.

Request (Json)

None

Body

Field Name	Type (Length)	Required	Description	Default
token	String	Y	고객사 토큰
ndate	String	N	조회 일자 (Y-m-d)	당일 일자
sdate	String	N	검색 시작일 (Y-m-d)
edate	String	N	검색 종료일 (Y-m-d)
status	int	N	상담방 상태	99
sort_key	String	N	정렬 기준 (reg_date, complate_date))	reg_date
sort_value	String	N	정렬 방식 (asc, desc)	desc
limit	int	N	한 페이지당 상담방 출력 수	기본 : 10 최대 : 50
page	int	N	페이지 번호	1

참고 사항

- 조회 일자 우선순위
  1순위 : sdate, edate
  2순위 : ndate
  3순위 : null (null로 넘길경우 당일날짜를 조회합니다.)

Example

REST API Sample

개발 및 테스트용 API운영 API

curl --location --request POST 'https://patch-customer.happytalk.io/user/api/chat_room_lists/format/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token" : "고객사 토큰",
    "ndate" : "조회 일자",
    "status" : "상담방 상태"
}'

curl --location --request POST 'https://customer.happytalk.io/user/api/chat_room_lists/format/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token" : "고객사 토큰",
    "ndate" : "조회 일자",
    "status" : "상담방 상태"
}'

Response (Json)

Parameter

Field Name	Type	Description
result	String	success : 성공 , fail : 실패
data	object	상담 내역

참고 사항

data는 세부 내용에 대한 Depth가 있는 관계로 Data Dictionary에 정의하였습니다.
"상담 내역" 링크를 클릭하시면 이동됩니다.

Example

Success

{
    "result": "success",
    "data": {
        "page": 1,
        "limit": 10,
        "total_count": 2,
        "chat_list": [
              {
                "id": "fi9LcAh16utMZEVpe5UYFvrkQgnBJT",
                "title": "1:1 채팅 상담 문의 드립니다.",
                "counselor_name": "test-lc",
                "counselor_nickname": "test-lc",
                "customer_uuid": "1000225570_lc_test1",
                "users_id": null,
                "category_id": "75345",
                "division_id": "75346",
                "tags" : [
                    "#태그1",
                    "#태그2"
                ],
                "cate_name1": "상품문의(샘플)",
                "cate_name2": "일반상담(샘플)",
                "etc_assign": "",
                "reg_date": "2022-05-26 12:38:32",
                "complate_date": "0000-00-00 00:00:00",
                "out_api": "0",
                "status": "0",
                "order_number": "",
                "product_number": "",
                "parcel_number": "",
                "parcel_companycode": "W",
                "app_ver": "",
                "phone_os": "",
                "phone_model": "",
                "phone_osver": "",
                "phone_telecomm": "",
                "app_hash": "",
                "parameter1": "",
                "parameter2": "",
                "parameter3": "",
                "parameter4": "",
                "parameter5": "",
                "parameter6": "",
                "parameter7": "",
                "parameter8": "",
                "parameter9": "",
                "parameter10": "",
                "user_parameter": "",
                "last_message": "상담원이 종료하였습니다."
            },
            {
                "id": "uvR3XrI8jtybTq6ZfploAOxJcKNLCG",
                "title": "1:1 채팅 상담 문의 드립니다.",
                "counselor_name": "test-lc",
                "counselor_nickname": "test-lc",
                "customer_uuid": "1000225570_testuser",
                "users_id": "testuser",
                "category_id": "75345",
                "division_id": "75346",
                "cate_name1": "상품문의(샘플)",
                "cate_name2": "일반상담(샘플)",
                "etc_assign": "",
                "reg_date": "2022-05-26 10:26:31",
                "complate_date": "2022-05-26 10:31:06",
                "out_api": "0",
                "status": "2",
                "order_number": "",
                "product_number": "",
                "parcel_number": "",
                "parcel_companycode": "W",
                "app_ver": "",
                "phone_os": "",
                "phone_model": "",
                "phone_osver": "",
                "phone_telecomm": "",
                "app_hash": "",
                "parameter1": "",
                "parameter2": "",
                "parameter3": "",
                "parameter4": "",
                "parameter5": "",
                "parameter6": "",
                "parameter7": "",
                "parameter8": "",
                "parameter9": "",
                "parameter10": "",
                "user_parameter": "",
                "last_message": "고객님이 종료하였습니다."
            }
        ]
    }
}

Failure

Fail Code 정보

Data Dictionary

Request DictionaryResponse Dictionary

status

Type	Description
99	전체
-2	상담 대기
-1	챗봇 진행중
0	접수 대기
1	진행중
2	완료
3	삭제

datachat_listout_apistatusparcel_companycodephone_os

Field Name	Type	Description
page	String	페이지 번호
limit	String	한 페이지당 상담방 출력 수
total_count	String	상담방 개수
chat_list	object	상담방 리스트

Field Name	Type	Description
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	String	상담 환경 분류
status	String	상담방 상태
order_number	String	상품 주문 번호
product_number	String	상품 번호
parcel_number	String	운송장 번호
parcel_companycode	String	택배사 코드
app_ver	String	앱 버전
phone_os	String	휴대전화 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	사용자 변수
last_message	String	마지막 메시지

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	웹

상담방 목록 검색

Endpoint

Auth Description

Request (Json)

Header

Body

Example

Response (Json)

Parameter

Example

Data Dictionary