--- title: "템플릿 상세 조회" method: GET path: "/v2/messages/kakao/send-profiles/{sendProfileId}/templates/{templateId}" tags: ["Kakao"] --- # 템플릿 상세 조회 `GET /v2/messages/kakao/send-profiles/{sendProfileId}/templates/{templateId}` ## Request - Base URL: `https://api.sendon.io` - URL: `https://api.sendon.io/v2/messages/kakao/send-profiles/{sendProfileId}/templates/{templateId}` - Auth: HTTP basic 알림톡 템플릿의 상세 정보를 조회합니다. 템플릿 내용, 검수 상태, 버튼 정보, 승인/반려 사유 등을 확인할 수 있습니다. ## Path parameters - `sendProfileId` string, required - `templateId` string, required ## Response `200` 템플릿 상세 조회 요청의 처리 결과입니다. 해당 템플릿의 모든 상세 정보가 포함됩니다. - GetTemplateResponseDto - `code` number, required: HTTP 상태 코드입니다. 200이면 성공, 400대는 클라이언트 오류, 500대는 서버 오류를 나타냅니다. - `message` string, required: API 호출 결과에 대한 사람이 읽을 수 있는 메시지입니다. 성공 시 "OK", 실패 시 구체적인 오류 사유가 포함됩니다. - `data` TemplateDetailDto, required - `profileId` string, required: 이 템플릿이 속한 채널의 ID입니다. 메시지 발송 시 사용되는 발신 주체입니다. - `id` string, required: 템플릿 ID입니다. 메시지 발송 시 이 ID를 사용하여 템플릿을 지정합니다. - `templateName` string, required: 템플릿의 이름입니다. 템플릿을 구분하고 관리하기 위한 사용자 정의 이름입니다. - `status` 'NEED_REVIEW' | 'IN_REVIEW' | 'APPROVED' | 'REJECTED' | 'DORMANT' | 'UNKNOWN' | 'DELETED', required: 템플릿의 현재 검수 상태입니다. 검수 필요, 진행중, 승인, 반려 등의 상태를 나타냅니다. - `templateMessageType` 'BA' | 'EX' | 'AD' | 'MI', required: 템플릿의 메시지 타입입니다. 기본형(BA), 부가정보형(EX), 채널추가형(AD), 복합형(MI) 중 하나입니다. - `templateEmphasizeType` 'NONE' | 'TEXT' | 'IMAGE' | 'ITEM_LIST', required: 템플릿의 강조 표시 타입입니다. 강조 없음, 텍스트 강조, 이미지 강조, 아이템 리스트 강조 중 하나입니다. - `templateContent` string, required: 알림톡 템플릿의 본문 내용입니다. 고객에게 반드시 전달되어야하는 정보를 발송할 수 있습니다. **글자수 제약:** - 한/영 구분없이 최대 1,000자까지 입력 가능 - 모든 템플릿 타입에서 본문은 1,000자 제한 **변수 사용:** - 개인화된 텍스트 영역은 #{변수명} 형식으로 작성 가능 - 예: #{고객명}, #{주문번호}, #{배송일자} 등 **템플릿 타입별 총 길이:** - 기본형(BA): 본문 1,000자 - 부가정보형(EX): 본문 1,000자 + 부가정보 500자 = 총 1,500자 - 채널추가형(AD): 본문 1,000자 + 채널추가 안내 80자 = 총 1,080자 - 복합형(MI): 본문 1,000자 + 부가정보 500자 + 채널추가 안내 80자 = 총 1,580자 - `buttons` union[]: 템플릿에 포함된 버튼들의 목록입니다. 사용자 액션을 유도하는 다양한 버튼이 설정되어 있습니다. - union - TemplateWebLinkButtonDto - `name` string, required: 버튼에 표시될 텍스트입니다. 사용자에게 보여지는 버튼명입니다. - `ordering` number: 템플릿 내에서 버튼이 표시될 순서입니다. 숫자가 작을수록 먼저 표시됩니다. - `type` 'WL', required - `urlMobile` string: 모바일 환경에서 웹링크 버튼 클릭 시 이동할 URL입니다. 모바일에 최적화된 페이지 링크를 설정합니다. - `urlPc` string: PC 환경에서 웹링크 버튼 클릭 시 이동할 URL입니다. 데스크톱 브라우저에서 열릴 링크를 설정합니다. - TemplateAppLinkButtonDto - `name` string, required: 버튼에 표시될 텍스트입니다. 사용자에게 보여지는 버튼명입니다. - `ordering` number: 템플릿 내에서 버튼이 표시될 순서입니다. 숫자가 작을수록 먼저 표시됩니다. - `type` 'AL', required - `urlMobile` string: 앱링크 버튼에서 모바일 환경 클릭 시 이동할 URL입니다. 앱이 미설치된 경우 대체 웹페이지로 이동합니다. - `urlPc` string: 앱링크 버튼에서 PC 환경 클릭 시 이동할 URL입니다. 데스크톱에서의 대체 웹페이지를 설정합니다. - `schemeAndroid` string: Android 앱으로 이동하기 위한 커스텀 URL 스킴입니다. 앱이 설치되어 있을 때 앱을 직접 실행합니다. - `schemeIos` string: iOS 앱으로 이동하기 위한 커스텀 URL 스킴입니다. 앱이 설치되어 있을 때 앱을 직접 실행합니다. - TemplateBasicButtonDto - `name` string, required: 버튼에 표시될 텍스트입니다. 사용자에게 보여지는 버튼명입니다. - `ordering` number: 템플릿 내에서 버튼이 표시될 순서입니다. 숫자가 작을수록 먼저 표시됩니다. - `type` 'BK' | 'MD' | 'DS' | 'AC', required - `fallback` TemplateFallbackDto, required - `senderNumber` string, required: 발신자 번호 - `type` 'SMS' | 'LMS' | 'MMS', required: 대체 발송 타입 - `message` string, nullable, required: 메시지 내용 - `title` string, nullable, required: 메시지 제목 - `images` string[], nullable, required: 이미지 URL 배열 - `isAd` boolean: 대체문자 광고 여부. true인 경우 광고성 메시지로 발송됩니다. - `groupId` string, nullable, required: 대체발송에 대한 그룹 ID입니다. 대체발송이 요청된 경우 그룹 ID가 할당됩니다. - `securityFlag` boolean, required: 템플릿의 보안 수준을 나타내는 플래그입니다. true인 경우 높은 보안이 적용된 템플릿입니다. - `templateComments` TemplateCommentDto[], nullable, required: 템플릿에 대한 검수자의 댓글 목록입니다. 검수 과정에서 작성된 피드백이나 수정 요청 사항이 포함됩니다. - `commentContent` string, required: 템플릿에 대한 검수자의 댓글 내용입니다. 승인, 반려 사유나 수정 요청 사항이 포함됩니다. - `commentCreateAt` string, required: 댓글이 작성된 날짜와 시간입니다. ISO 8601 형식으로 표시됩니다. - `commentSeqno` number, required: 댓글의 순서를 나타내는 시퀀스 번호입니다. 댓글이 작성된 순서대로 증가합니다. - `commentStatus` string, required: 댓글의 현재 상태입니다. ACTIVE, DELETED 등의 상태를 나타냅니다. - `commentUserName` string, required: 댓글을 작성한 검수자 또는 관리자의 이름입니다. - `regBy` string, required: 댓글을 등록한 사용자의 ID입니다. 시스템에서 댓글 작성자를 추적하기 위해 사용됩니다. - `regDate` string, date-time, nullable, required: 댓글이 시스템에 등록된 날짜와 시간입니다. ISO 8601 형식으로 표시됩니다. - `updateBy` string, nullable, required: 댓글을 마지막으로 수정한 사용자의 ID입니다. - `updateDate` string, date-time, nullable: 댓글이 마지막으로 수정된 날짜와 시간입니다. 수정되지 않은 경우 값이 없습니다. - `templateTitle` string, nullable, required: 강조표기형 템플릿의 제목입니다. **사용 목적:** - 중요한 정보를 강조하여 사용자의 주목을 끌기 위해 사용 - 본문 상단에 볼드체로 노출되어 시각적 강조 효과 제공 **글자수 제약:** - Android: 최대 23자 (24자부터 말줄임 처리) - iOS: 최대 28자 (29자부터 말줄임 처리) **변수 사용:** - 변수 등록 불가 **사용 조건:** - Subtitle과 함께 등록되어야 함 - 단독 노출 불가 - `templateSubtitle` string, nullable, required: 강조표기형 템플릿의 부제목입니다. **사용 목적:** - 제목과 함께 사용하여 추가적인 정보를 제공 - 제목보다 더 구체적인 내용을 담아 메시지의 명확성 향상 **글자수 제약:** - Android: 최대 18자 (19자부터 말줄임 처리) - iOS: 최대 21자 (22자부터 말줄임 처리) **변수 사용:** - 변수 등록 불가 **사용 조건:** - Title과 함께 등록되어야 함 - 단독 노출 불가 - `templateImageName` string, nullable, required: 템플릿에 포함된 이미지의 파일명입니다. 이미지 관리를 위해 사용됩니다. - `templateImageUrl` string, nullable, required: 템플릿에 포함된 이미지의 URL입니다. 업로드된 이미지에 접근하기 위한 웹 주소입니다. - `templateExtra` string, nullable, required: 부가정보는 알림톡 메시지의 본문 하단에 노출되는 보조적인 정보입니다. **사용 목적:** - 고객에게 고정적인 부가 정보에 대한 안내가 지속적으로 필요한 경우 - 이용안내 등 보조적인 정보메시지 안내 **글자수 제약:** - 최대 500자 입력 가능 - 광고성 요소와 동시 사용 시 부가정보 + 광고성 문구 총 500자 제한 - 본문과 합쳐 총 1,000자를 넘을 수 없음 **변수 및 URL:** - 변수 사용 불가능 - URL 포함 가능 **표시 위치:** - 본문과 버튼 사이 Description 영역에 노출 - 본문 대비 사이즈 -1pt, 컬러차 자동 적용 - `createdAt` string, date-time, nullable, required: 템플릿이 최초로 생성된 날짜와 시간입니다. ISO 8601 형식으로 표시됩니다. - `updatedAt` string, date-time, nullable, required: 템플릿이 마지막으로 수정된 날짜와 시간입니다. - `syncedAt` string, date-time, nullable, required: 템플릿이 카카오톡 서버와 마지막으로 동기화된 날짜와 시간입니다. - `lastUsedAt` string, date-time, nullable, required: 템플릿이 마지막으로 메시지 발송에 사용된 날짜와 시간입니다. ## Changes - **2026-11-03** `71dc377792d9`: 20 breaking, 1 warning, 7 info - the `data` response's property type changed from `object` to no type for status `200` - removed the required property `data/createdAt` from the response with the `200` status - removed the required property `data/fallback` from the response with the `200` status - removed the required property `data/id` from the response with the `200` status - …24 more [Operation history](https://skmtc.dev/sendon/apis/sendon-api/changes/v2/messages/kakao/send-profiles/:sendProfileId/templates/:templateId/get.md) --- [API](https://skmtc.dev/sendon/apis/sendon-api.md) - [All operations](https://skmtc.dev/sendon/apis/sendon-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sendon/apis/sendon-api/revisions/71dc377792d9?raw)