View Template::API 레퍼런스::View Template API

페이지 이동경로

시작하기

사용자의 디스플레이 디바이스와 연동하는 Bot에서 데이터 화면을 보여주기 위해 View Template 화면을 그리고(Render), 화면을 닫는 데(Close) 사용하는 Instruction과 파라미터를 설명합니다. 인스트럭션(Instruction)은 카카오 i에서 클라이언트로 보내지는 일련의 명령들을 의미합니다.

View Template 생성/닫기 API
구분 설명
Template.Render Template.Render Instruction을 설정하여, View Template 화면을 디스플레이 디바이스와 연동하는 Bot에 표시
Template.Close Template.Close Instruction을 설정하여, View Template 화면을 디스플레이 디바이스와 연동하는 Bot에서 닫음
안내
디스플레이 기기와 SDK 등에서 결과 화면을 노출할 때에는 화면 구성이 동일해야 합니다. View Template은 음성 인터랙션을 보조하는 형태로서 가능한 한 단순하게 구성하는 것이 좋습니다.

Template.Render

View Template 화면을 디스플레이 디바이스와 연동하는 Bot에 보여줄 경우에는 Template.Render를 사용하여 먼저 화면을 그립니다.

Request

Request Syntax

코드예제Template.Render Request Syntax

{
    "type":"Template.Render",
    "body":{
        "type":"{{STRING}}",
        "token":"{{STRING}}",
        "url":"http://sandbox-vt.i.kakao.com/v/XX?token={{STRING}}&ttl=20000&width=300&height=350"
    }
}

Request Parameters

Template.Render Request Parameters
파라미터 타입 필수 여부 설명
type String 필수 Instruction 타입
- View Template의 경우, Template.Render 값으로 고정
Object 필수 Instruction 타입별로 약속된 JSON Object 값
type String 필수 View Template의 타입(타입을 선택하여 화면 구성)
단일형
- KEYWORD_TEXT
- IMAGE_TEXT
- FULL_TEXT
- IMAGE
목록형
- LIST_HORIZONTAL
- LIST_VERTICAL
- CAROUSEL
기타
- CHAT_BUBBLE
token String 필수 각 Instruction을 식별하기 위한 고유의 Token 값
url String 필수 View Template의 URL
- URL의 Query-string에서 ttl, width, height 값을 파싱하여 재사용 가능
- URL이 아닌 Data 형식으로 들어가는 경우에는 View Template별 Code 예시 참고 

Template.Close

View Template 화면을 디스플레이 디바이스와 연동하는 Bot에서 닫을 경우에는 Template.Close Instruction이 사용됩니다.

Request

Request Syntax

코드예제Template.Close Request Syntax

{
    "type":"Template.Close",
    "body": {
        "token":"{{STRING}}"
    }
}

Request Parameters

Template.Close Request Parameters
파라미터 타입 필수 여부 설명
type String 필수 Instruction 타입
- View Template의 경우, Template.Close 값으로 고정
Object 필수 Instruction 타입별로 약속된 JSON Object 값
token String 필수 각 Instruction을 식별하기 위한 고유의 Token 값
- Close의 경우에 닫아야할 Template.Render Instruction의 Token 값
이 문서가 만족스러운 이유를 알려주세요.
이 문서에 아쉬운 점을 알려주세요.
평가해주셔서 감사합니다.

더 자세한 의견은 documentation@kakaoenterprise.com 으로 제보해주세요.