본문으로 건너뛰기

템플릿 정보 조회

GET
/kakao/v2/templates/:templateId
:templateId템플릿 고유 아이디


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

Response

NameTypeShould ReturnDescription
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<Object>
O
템플릿에 들어가는 버튼들
quickReplies
Array<Object>
O
바로 연결. 최소 1개, 최대 10개.
highlight
Object
O
알림톡 하이라이트. 강조 유형이 아이템 리스트일 때만 사용 가능합니다.
item
Object
O
알림톡 아이템. 목록과 요약이 있습니다. 강조 유형이 아이템 리스트일 때만 사용 가능합니다.
comments
Array<Object>
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<Object>
O
템플릿의 치환문구(변수) 목록

Structures

{30 properties
"name": "string",
"templateId": "string",
"channelId": "string",
"channelGroupId": "string",
"assignType": "string",
"accountId": "string",
"securityFlag": "boolean",
"categoryCode": "string",
"isHidden": "boolean",
"isDeleted": "boolean",
"content": "string",
"buttons":
[1 items...]
{8 properties...}
"buttonName": "string",
"buttonType": "string",
"linkMo": "string",
"linkPc": "string",
"linkAnd": "string",
"linkIos": "string",
"chatExtra": "string",
"targetOut": "boolean"
}
]
,
"quickReplies":
[1 items...]
{8 properties...}
"name": "string",
"linkType": "string",
"linkMo": "string",
"linkPc": "string",
"linkAnd": "string",
"linkIos": "string",
"chatExtra": "string",
"targetOut": "boolean"
}
]
,
"highlight":
{3 properties...}
"title": "string",
"description": "string",
"imageId": "string"
}
,
"item":
{2 properties...}
"summary":
{2 properties...}
"title": "string",
"description": "string"
}
,
"list":
[1 items...]
{2 properties...}
"title": "string",
"description": "string"
}
]
}
,
"comments":
[1 items...]
{4 properties...}
"memberId": "string",
"content": "string",
"isAdmin": "boolean",
"dateCreated": "date"
}
]
,
"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":
[1 items...]
{1 properties...}
"name": "string"
}
]
}