콘텐츠로 이동

해피톡 API 소개 및 사용법

Introduce

해피톡 API는 자체 구축한 시스템에서 필요한 정보를 수정 및 호출 할 수 있도록 해피톡에서 제공하는 API 입니다.
고객 정보 관리, 상담 내역 조회, 고객 정보 연동, 아카이브 등의 기능이 있습니다.

API HOST

참고 사항

해피톡 API는 문서에 따라 발송되는 도메인이 다르게 적용되어 자세한 API HOST는 API 문서를 확인해주시기 바랍니다.

Auth Key Description

인증키 발급 방법

디벨로퍼 센터에서 제공하는 API 이용을 위해서는 인증키 등의 정보가 필요하며, 해당 인증 정보는 사용 목적 확인 및 조건 협의 후 제공됩니다. 자세한 내용은 고객센터로 문의해주세요.

API List

Change History

History

2022
2022.08.20 
최초 작성
2022.09.26 
1. 전 페이지 내용 수정 및 구조 수정
    - API 문서 기준 규격 적용
    - 잘못된 내용 수정
    - UI 디자인 미반영 페이지 반영
2022.11.16 
1. 해피톡 API 내용 수정 
    - 인증 관리 API 스펙 변경에 따른 문서 내용 수정
    - 고객 정보 수정 API 내부 정책에 따른 내용 수정
2. 메뉴 구성 변경
    - 계정&시스템 관리 중분류 추가
    - 서비스 이용내역 중분류 값 변경 (고급 설정 -> 계정&시스템 관리)
2022.12.21 
1. 해피톡 API 문서 버그 및 내용 추가 
    - 인증 관리 API fail code 문서 경로가 제대로 파일을 찾지 못하는 이슈 수정
    - 인증 관리 API > 고객 정보 요청 연동 문서에 API 스펙에 따른 문구 추가
2024
2024.01.31 
1. 해피톡 문서 수정
   - 아카이브 > 상담방 내용 추가
     - 상담사 연결 요청 시간, 상담사 최초 응대 시간 필드 추가
2024.04.03 
1. 해피톡 문서 수정
   - 고객 정보 관리 > 고객 정보 수정
     - user_parameter(사용자 변수) 필드 추가
2024.04.10 
1. 해피톡 문서 수정
   - 상담 내역 조회 > 고객 ID 검색, 고객 UUID 검색, 상담방 번호 검색, 상담방 목록 검색 수정
     - user_parameter(사용자 변수) 필드 추가
2024.05.08 
1. 해피톡 문서 수정
    - 상담 내역 조회 > 고객 ID 검색, 고객 UUID 검색, 상담방 번호 검색, 상담방 목록 검색 수정
      - 상담방 tags(태그 변수) 필드 추가
2024.05.16 
1. 해피톡 문서 수정
    - 고객 정보 관리 > 고객 정보 수정
     - product_number(상품번호) 필드 추가
2024.10.23 
1. 해피톡 문서 수정
    - 상담 내역 조회 > 상담방 목록 검색
     - Data Dictionary > Response Dictionary > status 수정
    - 상담 내역 조회 > 고객 ID 검색, 고객 UUID 검색, 상담방 번호 검색
     - Data Dictionary > Response Dictionary > status 수정
     - Data Dictionary > Response Dictionary > user_type 수정
2025
2025.12.09 
1. 신규 템플릿 추가, normal 메시지 필드 추가 관련 문서 수정
    - 2025-12-09 공지사항 페이지 추가 (V1/V2 템플릿 정책 안내)
    - 해피톡 > 상담 내역 조회 > 고객 ID, 고객 UUID, 상담방 번호 검색 문서 수정
        - template 타입 지원 메시지 예시 추가
        - Response Body 구성 변경
    - 해피톡 > 아카이브 > 채팅 문서 수정
        - template 타입 지원 메시지 예시 추가
2. 카카오 상담톡 웹훅 -> 상담톡 웹훅(신규) -> 메시지 전송 -> rich, plain 문서 수정
    - Data Dictionary 상단으로 위치 변경
3. 카카오 상담톡 웹훅 -> 상담톡 웹훅(신규) -> 메시지 전송에 rich 버튼 타입 수정 
    - Data Dictionary > Response Dictionary > PA button_type 필드 제거
4. 카카오 상담톡 웹훅(종료예정) -> 상담 정보 수신 -> 사용자 메타 정보 수신 수정 
    - text, lastText, lastTextDate 필드 제거
5. 카카오 상담톡 웹훅(종료예정) -> 상담 정보 수신 -> 상담 메시지 수신 수정
    - content 필드 2025-12-31 이후 제거예정
2026
2026.01.06 
1. 카카오 상담톡 웹훅(신규) -> 메시지 수신 -> 사용자 메시지 수신 문서 수정
    - 사용자 메시지 수신 문서에서 content 필드 카카오 정책으로 종료되었으므로 제거
2026.01.26 
1. 해피톡 > 기본 정보 Auth Key Description 교체