템플릿 추가
목차
Request
[POST] https://api.solapi.com/kakao/v2/templates
템플릿을 새롭게 등록합니다.
카카오톡 템플릿은 카카오톡에서 검수를 진행하고 있으며 보통 영업일 기준 1~3일 정도 소요됩니다. 카카오톡 템플릿 화이트리스트를 참고하시면 빠르고 확실하게 검수 승인을 받아보실 수 있습니다.
메시지 유형과 강조 유형에 따라 필수로 입력해야 하는 값들이 있습니다.
메시지 유형
메시지 유형은 BA
(기본형), EX
(부가정보형), AD
(채널추가형), MI
(복합형) 총 4개가 있습니다.
BA (기본형)
일반적인 템플릿으로 따로 추가할 수 있는 사항이 없습니다.
EX (부가정보형)
부가정보형의 경우 부가정보인 extra
값을 추가해야 합니다.
본문과 합쳐 총 1000자를 넘을 수 없습니다.
변수는 사용할 수 없으며 URL은 포함 가능합니다.
광고성 요소와 동시에 사용 가능하며 최대 80자 제한이 있습니다.
* 주차장이 혼잡할 수 있으니 도보나 대중교통을 이용 부탁드립니다.
* 신림역 1번 출구에서 5분 거리에 있습니다.
* 이벤트 참여하실 경우 20% 세일된 가격으로 상품 구매 가능하십니다.
* 문의 전화: 010-0000-0000
AD (채널추가형)
채널 추가를 유도할 수 있는 문구와 채널추가 버튼이 추가됩니다. 버튼의 경우 첫번째 버튼에 무조건 채널추가 버튼이 있어야 합니다. 채널 추가 문구의 경우 아래 문구로 고정입니다.
채널 추가하고 이 채널의 광고와 마케팅 메시지를 카카오톡으로 받기
MI (복합형)
부가정보형과 채널추가형의 기능을 모두 가지고 있는 유형입니다.
강조 유형
메시지 유형은 NONE
(선택안함), TEXT
(강조표기형), IMAGE
(이미지형), ITEM_LIST
(아이템 리스트형) 총 4개가 있습니다.
NONE (선택안함)
일반적인 템플릿으로 따로 추가할 수 있는 사항이 없습니다.
TEXT (강조표기형)
강조표기문구와 강조표기보조문구를 필수로 넣어야합니다.
강조표기문구
- 안드로이드: 최대 2줄 23자(24자부터 말줄임 처리)
- iOS: 최대 2줄 27자(28자부터 말줄임 처리)
강조표기보조문구
- 안드로이드: 최대 18자(19자부터 말줄임 처리)
- iOS: 최대 21자(22자부터 말줄임 처리)
IMAGE (이미지형)
이미지를 추가할 수 있습니다.
이미지의 겨우 아래의 조건이 있습니다.
- 카카오비지니스 알림톡 이미지 제작 가이드
- 이미지 타입:
ATA
- 권장 크기: 800px * 400px
- 크기 제한: 가로 500px 미만 또는 가로:세로 비율이 2:1 미만 또는 3:4 초과시 업로드 불가
- 용량 제한: 최대 500KB
- 파일 형식: JPG, PNG
이미지는 아래 링크에서 업로드 가능합니다.
ITEM_LIST (아이템 리스트형)
[이미지], [헤더], [하이라이트], [아이템 리스트] 중 하나를 꼭 입력해아합니다. 각 요소에 대한 자세한 설명은 아래 Body Params 참고 부탁드립니다.
Authorization 인증 필요
계정 권한 | 회원 권한 | 계정 상태 | 회원 상태 | 계정 인증 |
---|---|---|---|---|
kakao:write | role-kakao:write | ACTIVE | ACTIVE | O |
Request Structure
{
"channelId": "string",
"channelGroupId": "string",
"name": "string",
"content": "string",
"categoryCode": "string",
"buttons": [
{
"buttonType": "string",
"buttonName": "string",
"linkMo": "string",
"linkPc": "string",
"linkAnd": "string",
"linkIos": "string"
}
],
"quickReplies": [
{
"name": "string",
"linkType": "string",
"linkMo": "string",
"linkPc": "string",
"linkAnd": "string",
"linkIos": "string"
}
],
"messageType": "string",
"emphasizeType": "string",
"header": "string",
"highlight": {
"title": "string",
"description": "string",
"imageId": "string"
},
"item": {
"list": [
{
"title": "string",
"description": "string"
}
],
"summary": {
"title": "string",
"description": "string"
}
},
"extra": "string",
"ad": "string",
"emphasizeTitle": "string",
"emphasizeSubtitle": "string",
"securityFlag": "boolean",
"imageId": "string"
}
Body Params
Name | Type | Required | Description |
---|---|---|---|
channelId | string | 카카오톡 채널 고유 아이디. 채널에 템플릿을 등록하고 싶을 경우 필수입니다. | |
channelGroupId | string | 카카오톡 채널 템플릿 그룹 고유 아이디. 그룹에 템플릿을 등록하고 싶을 경우 필수입니다. | |
name | string | O | 템플릿 이름. 중복 가능합니다. |
content | string | O | 템플릿 내용. 변수 포함 가능합니다. 변수 치환 후 1000자를 넘을 수 없습니다. |
categoryCode | string | O | 템플릿 카테고리. 템플릿 카테고리 목록 조회 API |
buttons | array | 템플릿에 들어가는 버튼들 | |
quickReplies | array | 바로 연결. 최소 1개, 최대 10개. | |
messageType | string | 메시지 유형. 기본값: BA
| |
emphasizeType | string | 강조 유형. 기본값: NONE
| |
header | string | 알림톡 헤더. 강조 유형이 아이템 리스트일 때만 사용 가능합니다. 변수 포함 가능. 최대 16자 | |
highlight | object | 알림톡 하이라이트. 강조 유형이 아이템 리스트일 때만 사용 가능합니다. | |
item | object | 알림톡 아이템. 목록과 요약이 있습니다. 강조 유형이 아이템 리스트일 때만 사용 가능합니다. | |
extra | string | 부가정보. 변수 포함 불가능. 최대 500자 | |
ad | string | 채널 추가 문구. 문구는 채널 추가하고 이 채널의 광고와 마케팅 메시지를 카카오톡으로 받기 고정입니다. | |
emphasizeTitle | string | 강조 표기 문구. 변수가 들어갈 수 있습니다. 템플릿 강조유형이 강조표기형일 때만 사용할 수 있습니다. 최대 50자 | |
emphasizeSubtitle | string | 강조 표기 보조 문구. 변수가 들어갈 수 없습니다. 템플릿 강조유형이 강조표기형일 때만 사용할 수 있습니다. 최대 50자 | |
securityFlag | boolean | 보안 템플릿 여부. true 일 경우 해당 템플릿을 PC에서는 확인할 수 없습니다. 기본값: false | |
imageId | string | 알림톡에 사용되는 이미지 고유 아이디 |
Body / buttons
Name | Type | Required | Description |
---|---|---|---|
buttonType | string | O | 버튼 유형(DS:배송조회, WL:웹링크, AL:앱링크, BK:봇키워드 MD: 메시지전달 BC: 상담톡 전환 BT: 봇전환 AC: 채널추가) |
buttonName | string | O | 버튼 이름. 변수 포함 불가능. 최대 14자. |
linkMo | string | 모바일 링크(WL 웹링크) | |
linkPc | string | 웹 링크(WL 웹링크) | |
linkAnd | string | 안드로이드 링크(AL 앱링크) | |
linkIos | string | IOS 링크(AL 앱링크) |
Body / quickReplies
Name | Type | Required | 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 앱링크) |
Body / highlight
Name | Type | Required | Description |
---|---|---|---|
title | string | O | 알림톡 하이라이트 제목. 변수 포함 가능. 최대 30자 |
description | string | O | 알림톡 하이라이트 내용. 변수 포함 불가능. 최대 16자 |
imageId | string | 알림톡에 사용되는 이미지 고유 아이디. 이미지 타입이 ATA 일 경우에만 사용 가능합니다.이미지 관리 페이지 (로그인 필요) 이미지 관리 API |
Body / item
Name | Type | Required | Description |
---|---|---|---|
list | array | O | 알림톡 아이템 리스트. 최소 2개, 최대 10개까지 등록할 수 있습니다. |
summary | object | 알림톡 아이템 리스트 요약. |
Body / item / list
Name | Type | Required | Description |
---|---|---|---|
title | string | O | 알림톡 아이템 리스트 제목. 변수 포함 불가능. 최대 6자 |
description | string | O | 알림톡 아이템 리스트 제목. 변수 포함 가능. 최대 23자 |
Body / item / summary
Name | Type | Required | Description |
---|---|---|---|
title | string | O | 알림톡 아이템 리스트 요약 제목. 변수 포함 불가능. 최대 6자 |
description | string | O | 알림톡 아이템 리스트 요약 내용. 변수 포함 가능. 화폐 단위, 숫자, 쉼표, 마침표만 사용 가능합니다. 최대 14자. |
문서 생성일 : 2024-06-11