AIID 발급

AI Instance ID(이하 AIID)는 카카오 AI 음성 서비스를 사용하는 입/출력 장치의 Endpoint ID로서 각각의 Instance를 구별하는 식별자입니다. AIID 발급은 Curl 또는 Postman과 같은 다양한 프로그램에서 수행할 수 있으며, 진행하는 작업 순서는 동일합니다. 본 가이드에서는 Curl을 사용한 기준으로 설명합니다.

AIID 발급 시, 디바이스 또는 애플리케이션의 장치 식별자(유일한 값)가 존재하는 경우에는 한 명의 사용자가 하나의 계정으로 여러 디바이스 또는 애플리케이션에 접근하기 위해 추가적으로 AIID를 생성할 수 있습니다.
각 디바이스 또는 애플리케이션 별로 추가 AIID를 발급 받고 사용할 수 있습니다. 반면에 장치 식별자(유일한 값)가 없는 경우에는 발급 요청 시마다 새로운 AIID 값이 반환되는 특성이 있기 때문에 인증 정보가 만료되지 않은 경우라면 AIID를 최대한 오래 사용하는 것을 원칙으로 합니다. 단, 2초 이내에 중복으로 반복 호출시에 동일 AIID값이 반환됩니다.

AIID가 변경되면 다른 디바이스 또는 애플리케이션으로 인식되므로 디바이스 또는 애플리케이션에 대한 설정값이 유지되지 않고, 연속된 대화도 진행할 수 없습니다.

주의
회원 탈퇴 또는 서비스 탈퇴 시에 관련된 AIID는 모두 파기됩니다.

발급 절차

1. 인증에서 획득한 Access Token(access_token)과 사용자 ID(app_user_id)를 사용하여 다음의 명령어를 완성합니다. 코드예제Curl 명령어

   BASH

   curl -X POST http://sandbox-app.i.kakao.com/api/client/auth/v0/addInstance?device_id=XXXXX \
       -H 'Authorization: XBearer 123abcdefghijklmnopqrstuvwxyz1116' \
       -H 'Content-Type: application/json' \
       -H 'KakaoI-Agent: KVS/1.0 (Linux; Android 24 7.0; Redmi Note 4/NRD90M; AIID -)
       com.cryyull.sancha_tm1k.dev/1.0/1 SDK/1.1.1' \
       -H 'KakaoI-User: AU 1116'
   

2. AIID 발급 Curl 명령어에 대한 응답에서 AIID(id_string)를 확인합니다. 코드예제AIID 정보 확인

   JSON

   {
           "id_string": "1s2gMunt",
           "id_number": "KAI12864546678681191116",
           "application_type": {
                   "package_name": "com.kep.agent_tm1k.dev",
                   "platform": 1
           },
           "status": 0,
           "created_at": 1550046233623,
           "_code": 200,
           "_message": "OK"
   }
   

AIID 발급 API

Request

Request Syntax

코드예제AIID 발급 Request Syntax

curl -X POST http://sandbox-app.i.kakao.com/api/client/auth/v0/addInstance?device_id=XXXXX \
    -H 'Authorization: XBearer 123abcdefghijklmnopqrstuvwxyz1116' \
    -H 'Content-Type: application/json' \
    -H 'KakaoI-Agent: KVS/1.0 (Linux; Android 24 7.0; Redmi Note 4/NRD90M; AIID -)
    com.cryyull.sancha_tm1k.dev/1.0/1 SDK/1.1.1' \
    -H 'KakaoI-User: AU 1116'

Path Parameters

Request Header

주의
Request Header 정보 중 Bearer(또는 XBearer)와 AU는 Prefix로서 절대 삭제하지 마시고, Prefix 뒤에는 반드시 한 칸 공백을 유지하시기 바랍니다.

Response

안내
_code에서 발생하는 오류 코드 값의 자세한 해결 방안은 Troubleshooting 문서를 참고하시기 바랍니다.