라이프 사이클 메서드

init

SDK를 초기화하여 소켓과 스트리밍을 연결합니다.

window.KlleonChat.init({
  sdk_key: "your sdk key",
  avatar_id: "your avatar id",
  subtitle_code: 'ko_kr',
  voice_code: 'ko_kr',
  voice_tts_speech_speed: 1.0,
  enable_microphone: true
  log_level: 'debug'
  user_key: 'your user key'
});

파라미터	타입	필수여부	기본값	설명
sdk_key	string	O	-
avatar_id	string	O	-
subtitle_code	string	X	ko_kr	아바타가 발화한 텍스트의 언어를 조절합니다 ko_kr: 한국어 en_us: 영어 ja_jp: 일본어 id_id: 인도네시아어
voice_code	string	X	ko_kr	아바타가 발화하는 음성의 언어를 조절합니다. ko_kr: 한국어 en_us: 영어 ja_jp: 일본어 id_id: 인도네시아어
voice_tts_speech_speed	number	X	1.0	아바타가 발화하는 속도를 조절합니다. range: (0.5 ~ 2.0)
enable_microphone	boolean	X	true	브라우저 마이크 permission없이 연결
log_level	string	x	debug	sdk의 로그를 출력하는 레벨을 설정합니다. debug: debug 레벨 이상의 로그를 출력합니다. info : info 레벨 이상의 로그를 출력합니다. warn: warn 레벨 이상의 로그를 출력합니다. error: error 레벨 로그를 출력합니다. silent: 로그를 출력하지 않습니다.
user_key	string	x	-	endUser 생성 API를 통해 만들어진 키값을 맵핑합니다. 해당 key값은 endUser 키와 만료 타임스탬프가 포함됩니다.

user_key 발급

API 정보

request url	method	description
https://saas.klleon.io/api/v1/app/end-user	POST	엔드 유저 생성 API

설명

엔드 유저 생성 API는 애플리케이션의 apiKey를 사용하여 endUser를 생성하는 API입니다.

디지털 휴먼에 접근하는 엔드 유저를 WAS가 인증한 후, WAS가 엔드 유저 생성 API를 호출합니다. WAS는 만료 시간을 초 단위로 지정하며, 응답에는 endUser 키와 만료 타임스탬프가 포함됩니다.

요청

1. Headers

해당 애플리케이션의 apiKey는 요청 헤더에서 x-api-key라는 키로 제공되어야 합니다.

apiKey는 서비스 클라이언트에 공개되지 않도록 비밀로 유지해야 합니다.

x-api-key 발급은 별도 문의([e-mail])를 통해서 발급 가능합니다.

이름	타입	필수여부	설명
x-api-key	string	O	애플리케이션의 apiKey를 사용한 인증 방식

1. Request Body

필드	타입	필수여부	설명
duration	number	O	만료 기간(초 단위)

1. 예시

// 요청
curl --location 'https://saas.klleon.io/api/v1/app/end-user' \
--header 'x-api-key: d/LMMMThvOxszvfWZxdXDweXz2TsefaegggBI8=' \
--header 'Content-Type: application/json' \
--data '{
    "duration" : 120
}'

// 응답
{
    "data": {
        "userKey": "USER-FebxNRyFi1BSZDnXCDwa",
        "expiredAt": "2024-12-09T02:16:37.778977274"
    },
    "success": true
}

destroy

SDK를 destroy합니다. 등록된 이벤트 리스너를 모두 제거하고 연결된 세션을 끊습니다.

window.KlleonChat.destroy();