템플릿 정보 조회

목차

• Request
  • Authorization 인증 필요
  • Path Parameters
• Response
  • Response Structure
  • Response Description

Request

[GET] https://api.solapi.com/kakao/v2/templates/:templateId

템플릿의 아이디로 템플릿 정보를 조회합니다.

---

Authorization 인증 필요

Authorization 인증이란?

계정 권한	회원 권한	계정 상태	회원 상태	계정 인증
kakao:read	role-kakao:read

Path Parameters

Name	Description
:templateId	템플릿 고유 아이디

---

Response

Response Structure

{
    "name": "string",
    "templateId": "string",
    "channelId": "string",
    "channelGroupId": "string",
    "assignType": "string",
    "accountId": "string",
    "securityFlag": "boolean",
    "categoryCode": "string",
    "isHidden": "boolean",
    "isDeleted": "boolean",
    "content": "string",
    "buttons": [
        {
            "buttonName": "string",
            "buttonType": "string",
            "linkMo": "string",
            "linkPc": "string",
            "linkAnd": "string",
            "linkIos": "string"
        }
    ],
    "quickReplies": [
        {
            "name": "string",
            "linkType": "string",
            "linkMo": "string",
            "linkPc": "string",
            "linkAnd": "string",
            "linkIos": "string"
        }
    ],
    "highlight": {
        "title": "string",
        "description": "string",
        "imageId": "string"
    },
    "item": {
        "summary": {
            "title": "string",
            "description": "string"
        },
        "list": [
            {
                "title": "string",
                "description": "string"
            }
        ]
    },
    "comments": [
        {
            "memberId": "string",
            "content": "string",
            "isAdmin": "boolean",
            "dateCreated": "string"
        }
    ],
    "code": "string",
    "commentable": "boolean",
    "status": "string",
    "messageType": "string",
    "emphasizeType": "string",
    "extra": "string",
    "ad": "string",
    "emphasizeTitle": "string",
    "emphasizeSubtitle": "string",
    "imageId": "string",
    "header": "string",
    "dateCreated": "date",
    "dateUpdated": "date",
    "variables": [
        {
            "name": "string"
        }
    ]
}

Response Description

Response /

Name	Type	Should Return	Description
name	string	O	알림톡 이름. 최대 100자
templateId	string	O	템플릿 고유 아이디
channelId	string		카카오톡 채널 고유 아이디
channelGroupId	string		카카오톡 채널 템플릿 그룹 고유 아이디
assignType	string	O	채널, 그룹 템플릿 여부. CHANNEL: 채널 템플릿 GROUP: 그룹 템플릿
accountId	string	O	계정 고유 아이디
securityFlag	boolean	O	보안 템플릿 여부. true일 경우 해당 템플릿을 PC에서는 확인할 수 없습니다. 기본값: false
categoryCode	string	O	카카오톡 채널 카테고리 코드
isHidden	boolean	O	숨김 템플릿 여부
isDeleted	boolean	O	삭제 템플릿 여부
content	string	O	템플릿 내용
buttons	array	O	템플릿에 들어가는 버튼들
quickReplies	array	O	바로 연결. 최소 1개, 최대 10개.
highlight	object	O	알림톡 하이라이트. 강조 유형이 아이템 리스트일 때만 사용 가능합니다.
item	object	O	알림톡 아이템. 목록과 요약이 있습니다. 강조 유형이 아이템 리스트일 때만 사용 가능합니다.
comments	array	O	관리자 검수 댓글 목록
code	string		템플릿 관리용 코드
commentable	boolean	O	댓글 사용 가능한 템플릿 여부
status	string	O	템플릿 상태 PENDING: 검수 전 INSPECTING: 검수 중 APPROVED: 승인됨 REJECTED: 반려됨
messageType	string	O	메시지 유형. 기본값: BA BA: 기본형 EX: 부가정보형 AD: 채널추가형 MI: 복합형
emphasizeType	string	O	강조 유형. 기본값: NONE NONE: 선택안함 TEXT: 강조표기형 IMAGE: 이미지형 ITEM_LIST: 아이템 리스트
extra	string		부가정보. 변수 포함 불가능. 최대 500자
ad	string		채널 추가 문구. 문구는 채널 추가하고 이 채널의 광고와 마케팅 메시지를 카카오톡으로 받기 고정입니다.
emphasizeTitle	string		강조 표기 문구. 변수가 들어갈 수 있습니다. 템플릿 강조유형이 강조표기형일 때만 사용할 수 있습니다. 최대 50자
emphasizeSubtitle	string		강조 표기 보조 문구. 변수가 들어갈 수 없습니다. 템플릿 강조유형이 강조표기형일 때만 사용할 수 있습니다. 최대 50자
imageId	string		알림톡에 사용되는 이미지 고유 아이디
header	string		알림톡 헤더. 강조 유형이 아이템 리스트일 때만 사용 가능합니다. 변수 포함 가능. 최대 16자
dateCreated	date	O	최초 생성 날짜
dateUpdated	date	O	최근 수정 날짜
variables	array	O	템플릿의 치환문구(변수) 목록

Response / buttons

Name	Type	Should Return	Description
buttonName	string	O	버튼 이름. 변수 포함 불가능. 최대 14자.
buttonType	string	O	버튼 유형(DS:배송조회, WL:웹링크, AL:앱링크, BK:봇키워드 MD: 메시지전달 BC: 상담톡 전환 BT: 봇전환 AC: 채널추가)
linkMo	string		모바일 링크(WL 웹링크)
linkPc	string		웹 링크(WL 웹링크)
linkAnd	string		안드로이드 링크(AL 앱링크)
linkIos	string		IOS 링크(AL 앱링크)

Response / quickReplies

Name	Type	Should Return	Description
name	string	O	바로 연결 이름. 변수 포함 불가능
linkType	string	O	링크 타입(WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달, BC: 상담톡 전환, BT: 봇전환)
linkMo	string		모바일 링크(WL 웹링크)
linkPc	string		웹 링크(WL 웹링크)
linkAnd	string		안드로이드 링크(AL 앱링크)
linkIos	string		IOS 링크(AL 앱링크)

Response / highlight

Name	Type	Should Return	Description
title	string		알림톡 하이라이트 제목. 변수 포함 가능. 최대 30자
description	string		알림톡 하이라이트 내용. 변수 포함 불가능. 최대 16자
imageId	string		알림톡 하이라이트 썸네일에 사용되는 이미지 고유 아이디. 이미지 타입이 KAKAO_HIGHLIGHT일 경우에만 사용 가능합니다. 이미지 관리 페이지 (로그인 필요) 이미지 관리 API

Response / item

Name	Type	Should Return	Description
summary	object		알림톡 아이템 리스트 요약.
list	array		알림톡 아이템 리스트. 최소 2개, 최대 10개까지 등록할 수 있습니다.

Response / item / summary

Name	Type	Should Return	Description
title	string		알림톡 아이템 리스트 요약 제목. 변수 포함 불가능. 최대 6자
description	string		알림톡 아이템 리스트 요약 내용. 변수 포함 가능. 화폐 단위, 숫자, 쉼표, 마침표만 사용 가능합니다. 최대 14자.

Response / item / list

Name	Type	Should Return	Description
title	string	O	알림톡 아이템 리스트 제목. 변수 포함 불가능. 최대 6자
description	string	O	알림톡 아이템 리스트 제목. 변수 포함 가능. 최대 23자

Response / comments

Name	Type	Should Return	Description
memberId	string		댓글을 남긴 사용자의 고유 아이디
content	string		댓글 내용
isAdmin	boolean	O	관리자 댓글 여부
dateCreated	string	O	댓글이 남겨진 날짜

Response / variables

Name	Type	Should Return	Description
name	string	O	치환문구(변수) 이름

---

문서 생성일 : 2024-10-29