Biz API 소개 및 사용법

Introduce

Biz API 는 자체 구축 챗봇을 가지고 있는 업체에서 채팅 상담을 사용하기 위하여 해피톡에서
제공하는 API 리스트 입니다. 방생성, 메세지 발신, 상담종료, 메세지 수신 등의 기능이 있습니다.

API HOST

Division	HOST URL
개발	https://patch-biz-api.happytalk.io
운영	https://biz-api.happytalk.io

Auth Key Description

인증키 발급 방법

Biz API는 인증 방식으로 Header에 HT-Client-Id, HT-Client-Secret 값을 통하여 인증을 하고 있습니다.
Header에 들어가는 인증 키 (HT-Client-Id, HT-Client-Secret)는 고객센터를 통해 외부 메신저 API에서
key (HT-Client-Id)와 Token (HT-Client-Secret)를 발급 받으실 수 있습니다.

API List

상담
상담 정보 수신
- 상담방 종료 정보 수신
- 메시지 수신

Change History

History

2022

2022.08.20

최초 작성

2022.09.26

1. 전 페이지 내용 수정 및 구조 수정
    - API 문서 기준 규격 적용
    - 잘못된 내용 수정

2023

2023.03.23

1. Biz-API API 스펙 변경에 따른 문서 내용 수정
    - 상담방 생성 파라미터 정보 변경
        - is_room_create_force 파라미터 정보 추가
    - 상담 종료 파라미터 정보 추가
        - end_type 파라미터 정보 추가
    - 메시지 수신 문서 생성
    - 방종료 수신 문서 생성
    - 상담 가능/불가 상담원 인원수 문서 생성
    - 상담 대기 상담방 개수 문서 생성

2023.06.01

1. Biz-API 메시지 수신 문서 Example 수정
    - 메시지 수신 Example 상황별 데이터 수정

2024

2024.07.03

1. Biz-API 문서 수정
    - 상담 정보 수신 > 메시지 수신
     - API URL 정보 수정
    - 상담 정보 수신 > 상담방 종료 정보 수신
     - API URL 정보 수정