본문으로 건너뛰기

템플릿 목록 조회

목차

Request

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

템플릿의 목록을 조회합니다.


Authorization 인증 필요

Authorization 인증이란?

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

Query Params

NameTypeRequiredAllowed Operator [?]Description
namestringeq, ne, like알림톡 이름. 최대 100자
channelIdstringeq카카오톡 채널 고유 아이디
channelGroupIdstringeq카카오톡 채널 템플릿 그룹 고유 아이디
templateIdstringeq템플릿 고유 아이디
isHiddenbooleaneq숨김 템플릿 여부
statusstringeq템플릿 상태
  • PENDING: 검수 전
  • INSPECTING: 검수 중
  • APPROVED: 승인됨
  • REJECTED: 반려됨
isMinebooleaneq내 템플릿 여부. true로 설정할 경우 내가 수정할 수 있는 템플릿만 조회.
startKeystringeq현재 목록을 불러올 기준이 되는 키
limitnumbereq한 페이지에 불러옥 목록 개수
dateCreateddateeq, gte, lte, gt, lt최초 생성 날짜
dateUpdateddateeq, gte, lte, gt, lt최근 수정 날짜

Response

Response Structure

{
"templateList": [
{
"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"
}
]
}
],
"limit": "number",
"startKey": "string",
"nextKey": "string"
}

Response Description

Response /
NameTypeShould ReturnDescription
templateListarrayO템플릿 목록
limitnumberO한 페이지에 불러옥 목록 개수
startKeystring현재 목록을 불러올 기준이 되는 키
nextKeystring다음 목록을 불러올 수 있는 키
Response / templateList
NameTypeShould ReturnDescription
namestringO알림톡 이름. 최대 100자
templateIdstringO템플릿 고유 아이디
channelIdstring카카오톡 채널 고유 아이디
channelGroupIdstring카카오톡 채널 템플릿 그룹 고유 아이디
assignTypestringO채널, 그룹 템플릿 여부.
  • CHANNEL: 채널 템플릿
  • GROUP: 그룹 템플릿
accountIdstringO계정 고유 아이디
securityFlagbooleanO보안 템플릿 여부. true일 경우 해당 템플릿을 PC에서는 확인할 수 없습니다. 기본값: false
categoryCodestringO카카오톡 채널 카테고리 코드
isHiddenbooleanO숨김 템플릿 여부
isDeletedbooleanO삭제 템플릿 여부
contentstringO템플릿 내용
buttonsarrayO템플릿에 들어가는 버튼들
quickRepliesarrayO바로 연결. 최소 1개, 최대 10개.
highlightobjectO알림톡 하이라이트. 강조 유형이 아이템 리스트일 때만 사용 가능합니다.
itemobjectO알림톡 아이템. 목록과 요약이 있습니다. 강조 유형이 아이템 리스트일 때만 사용 가능합니다.
commentsarrayO관리자 검수 댓글 목록
codestring템플릿 관리용 코드
commentablebooleanO댓글 사용 가능한 템플릿 여부
statusstringO템플릿 상태
  • PENDING: 검수 전
  • INSPECTING: 검수 중
  • APPROVED: 승인됨
  • REJECTED: 반려됨
messageTypestringO메시지 유형. 기본값: BA
  • BA: 기본형
  • EX: 부가정보형
  • AD: 채널추가형
  • MI: 복합형
emphasizeTypestringO강조 유형. 기본값: NONE
  • NONE: 선택안함
  • TEXT: 강조표기형
  • IMAGE: 이미지형
  • ITEM_LIST: 아이템 리스트
extrastring부가정보. 변수 포함 불가능. 최대 500자
adstring채널 추가 문구. 문구는 채널 추가하고 이 채널의 광고와 마케팅 메시지를 카카오톡으로 받기 고정입니다.
emphasizeTitlestring강조 표기 문구. 변수가 들어갈 수 있습니다. 템플릿 강조유형이 강조표기형일 때만 사용할 수 있습니다. 최대 50자
emphasizeSubtitlestring강조 표기 보조 문구. 변수가 들어갈 수 없습니다. 템플릿 강조유형이 강조표기형일 때만 사용할 수 있습니다. 최대 50자
imageIdstring알림톡에 사용되는 이미지 고유 아이디
headerstring알림톡 헤더. 강조 유형이 아이템 리스트일 때만 사용 가능합니다. 변수 포함 가능. 최대 16자
dateCreateddateO최초 생성 날짜
dateUpdateddateO최근 수정 날짜
variablesarrayO템플릿의 치환문구(변수) 목록
Response / templateList / buttons
NameTypeShould ReturnDescription
buttonNamestringO버튼 이름. 변수 포함 불가능. 최대 14자.
buttonTypestringO버튼 유형(DS:배송조회, WL:웹링크, AL:앱링크, BK:봇키워드 MD: 메시지전달 BC: 상담톡 전환 BT: 봇전환 AC: 채널추가)
linkMostring모바일 링크(WL 웹링크)
linkPcstring웹 링크(WL 웹링크)
linkAndstring안드로이드 링크(AL 앱링크)
linkIosstringIOS 링크(AL 앱링크)
Response / templateList / quickReplies
NameTypeShould ReturnDescription
namestringO바로 연결 이름. 변수 포함 불가능
linkTypestringO링크 타입(WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달, BC: 상담톡 전환, BT: 봇전환)
linkMostring모바일 링크(WL 웹링크)
linkPcstring웹 링크(WL 웹링크)
linkAndstring안드로이드 링크(AL 앱링크)
linkIosstringIOS 링크(AL 앱링크)
Response / templateList / highlight
NameTypeShould ReturnDescription
titlestring알림톡 하이라이트 제목. 변수 포함 가능. 최대 30자
descriptionstring알림톡 하이라이트 내용. 변수 포함 불가능. 최대 16자
imageIdstring알림톡 하이라이트 썸네일에 사용되는 이미지 고유 아이디. 이미지 타입이 KAKAO_HIGHLIGHT일 경우에만 사용 가능합니다.
이미지 관리 페이지 (로그인 필요)
이미지 관리 API
Response / templateList / item
NameTypeShould ReturnDescription
summaryobject알림톡 아이템 리스트 요약.
listarray알림톡 아이템 리스트. 최소 2개, 최대 10개까지 등록할 수 있습니다.
Response / templateList / item / summary
NameTypeShould ReturnDescription
titlestring알림톡 아이템 리스트 요약 제목. 변수 포함 불가능. 최대 6자
descriptionstring알림톡 아이템 리스트 요약 내용. 변수 포함 가능. 화폐 단위, 숫자, 쉼표, 마침표만 사용 가능합니다. 최대 14자.
Response / templateList / item / list
NameTypeShould ReturnDescription
titlestringO알림톡 아이템 리스트 제목. 변수 포함 불가능. 최대 6자
descriptionstringO알림톡 아이템 리스트 제목. 변수 포함 가능. 최대 23자
Response / templateList / comments
NameTypeShould ReturnDescription
memberIdstring댓글을 남긴 사용자의 고유 아이디
contentstring댓글 내용
isAdminbooleanO관리자 댓글 여부
dateCreatedstringO댓글이 남겨진 날짜
Response / templateList / variables
NameTypeShould ReturnDescription
namestringO치환문구(변수) 이름

문서 생성일 : 2024-06-11