API

알림톡 템플릿

작성일 2026.03.07 | 수정일 2026.03.08

공통 응답 스키마

알림톡 템플릿 관련 API에서 공통으로 반환되는 탬플릿 객체의 스키마입니다. 개별 엔드포인트에서 별도 명시가 없으면 이 스키마를 따릅니다.

NameTypeRequiredDescription
templateIdstring*템플릿 고유 ID
namestring*템플릿 이름
channelIdstring카카오톡 채널 ID
channelGroupIdstring채널 그룹 ID
assignTypestring*할당 유형
accountIdstring*계정 ID
securityFlagboolean*보안 메시지 여부
categoryCodestring*카테고리 코드
isHiddenboolean*숨김 여부
isDeletedboolean*삭제 여부
contentstring*템플릿 내용
buttonsarray*버튼 목록
buttonTypestring*버튼 타입
buttonNamestring*버튼 이름
linkMostring모바일 링크
linkPcstringPC 링크
linkAndstring안드로이드 링크
linkIosstringiOS 링크
chatExtrastring상담톡/봇 전환 시 전달할 메타 정보
targetOutboolean아웃링크 사용 여부
quickRepliesarray*바로연결 목록
highlightobject*하이라이트 정보
titlestring하이라이트 제목
descriptionstring하이라이트 설명
imageIdstring하이라이트 이미지 ID
itemobject*아이템 리스트 정보
listarray아이템 목록
titlestring*아이템 제목
descriptionstring*아이템 설명
summaryobject아이템 요약 정보
titlestring*요약 제목
descriptionstring*요약 설명
commentsarray*검수 의견 목록
codestring템플릿 코드
commentableboolean*의견 작성 가능 여부
statusstring*템플릿 상태 (PENDING: 검수 전, INSPECTING: 검수 중, APPROVED: 승인됨, REJECTED: 반려됨)
messageTypestring*메시지 유형
emphasizeTypestring*강조 유형
extrastring부가정보
adstring광고 문구
emphasizeTitlestring강조표기 제목
emphasizeSubtitlestring강조표기 보조문구
imageIdstring이미지 ID
headerstring헤더
dateCreatedstring*생성 일시
dateUpdatedstring*수정 일시
variablesarray*변수 목록
namestring*변수 이름

Structure

{ "templateId": "TP01ABC", "name": "주문 알림", "channelId": "CH01ABC", "channelGroupId": null, "assignType": "CHANNEL", "accountId": "AC01ABC", "securityFlag": false, "categoryCode": "003001", "isHidden": false, "isDeleted": false, "content": "#{이름}님의 주문이 완료되었습니다.\n주문번호: #{주문번호}", "buttons": [ { "buttonType": "WL", "buttonName": "주문 확인", "linkMo": "https://example.com/orders", "linkPc": "https://example.com/orders", "linkAnd": "exampleapp://orders", "linkIos": "exampleapp://orders", "chatExtra": null, "targetOut": false } ], "quickReplies": [], "highlight": { "title": "주문 완료", "description": "결제가 완료되었습니다.", "imageId": "IMG01ABC" }, "item": { "list": [ { "title": "상품명", "description": "예시 상품 A" } ], "summary": { "title": "총 결제금액", "description": "10,000원" } }, "comments": [ { "content": "검수 부탁드립니다.", "dateCreated": "2024-01-02T00:00:00.000Z" } ], "code": "template_001", "commentable": true, "status": "APPROVED", "messageType": "MI", "emphasizeType": "ITEM_LIST", "extra": "본 메시지는 정보통신망법에 의거하여 발송되었습니다.", "ad": "채널 추가하고 소식을 받아보세요.", "emphasizeTitle": "주문 완료", "emphasizeSubtitle": "결제가 정상 처리되었습니다.", "imageId": "IMG02ABC", "header": "주문 내역", "dateCreated": "2024-01-01T00:00:00.000Z", "dateUpdated": "2024-01-05T00:00:00.000Z", "variables": [ { "name": "이름" }, { "name": "주문번호" } ] }