템플릿 조회

Classic/VPC 환경에서 이용 가능합니다.

알림톡의 템플릿 정보를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/alimtalk/v2/services/{serviceId}/templates

요청 헤더

Simple & Easy Notification Service API에서 공통으로 사용하는 헤더에 대한 정보는 Simple & Easy Notification Service 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`serviceId`	String	Required	Biz Message 서비스 아이디 프로젝트 목록 조회 참조

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`channelId`	String	Required	채널 아이디 채널 조회 참조
`templateCode`	String	Optional	템플릿 코드 입력 시 템플릿 상세 정보 (검수 내용, 부가 정보 등) 반환
`templateName`	String	Optional	템플릿 이름 전체 또는 부분 일치하는 값 필터링
`pageSize`	Integer	Optional	페이지당 항목 수 1~100 (기본값: 100)
`pageIndex`	Integer	Optional	페이지 인덱스 0~N (기본값: 0)

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://sens.apigw.ntruss.com/alimtalk/v2/services/ncp:kkobizmsg:kr:16******8:sens/templates?channelId=%40********' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`createTime`	String	Required	템플릿 생성 일시 YYYY-MM-DDTHH:mm:ss.sss 형식
`updateTime`	String	Optional	템플릿 수정 일시 YYYY-MM-DDTHH:mm:ss.sss 형식
`channelId`	String	Required	채널 아이디
`templateCode`	String	Required	템플릿 코드
`templateName`	String	Required	템플릿 이름
`categoryCode`	String	Required	템플릿 카테고리 코드
`categoryName`	String	Required	템플릿 카테고리
`messageType`	String	Required	메시지 타입 `BA` \| `EX` \| `AD` \| `MI` `BA`: 기본형 `EX`: 부가 정보형 `AD`: 채널 추가형 `MI`: 복합형
`emphasizeType`	String	Required	강조 유형 `NONE` \| `TEXT` \| `IMAGE` \| `ITEM_LIST` `NONE`: 기본형 `TEXT`: 강조 표기형 `IMAGE`: 이미지형 `ITEM_LIST`: 아이템 리스트형
`content`	String	Required	템플릿 내용
`adContent`	String	Optional	광고 내용 광고 내용 존재 시 표시
`extraContent`	String	Optional	부가 정보 내용 부가 정보 존재 시 표시
`title`	String	Optional	강조 정보 제목
`additionalTitle`	String	Optional	강조 정보 보조 제목
`comments`	Array	Optional	검수 정보 템플릿 상세 조회 시 표시
`templateInspectionStatus`	String	Required	검수 상태 `ACCEPT` \| `REGISTER` \| `INSPECT` \| `COMPLETE` \| `REJECT` `ACCEPT`: 접수 `REGISTER`: 대기중 `INSPECT`: 처리중 `COMPLETE`: 완료 `REJECT`: 반려
`templateStatus`	String	Required	템플릿 상태 `ACTIVE` \| `READY` \| `NOT_REGISTER` \| `STOP` `ACTIVE`: 정상 `READY`: 등록 완료 `NOT_REGISTER`: 등록 대기중 `STOP`: 정지
`buttons`	Array	Optional	버튼 목록 최대 5개
`securityFlag`	Boolean	Required	보안 설정 여부 `true` \| `false` `true`: 설정 `false`: 미설정
`isBlock`	Boolean	Required	차단 여부 `true` \| `false` `true`: 차단 `false`: 차단되지 않음
`isDormant`	Boolean	Required	휴면 여부 `true` \| `false` `true`: 휴면 상태 `false`: 휴면 상태 아님
`useImage`	Boolean	Required	이미지 사용 여부 `true` \| `false` `true`: 사용 `false`: 사용 안 함
`imageName`	String	Optional	이미지 파일 이름
`imageUrl`	String	Optional	이미지 URL
`useHeaderContent`	Boolean	Required	헤더 사용 여부 `true` \| `false` `true`: 사용 `false`: 사용 안 함
`headerContent`	String	Optional	헤더 내용
`useItemHighlight`	Boolean	Required	아이템 하이라이트 사용 여부 `true` \| `false` `true`: 사용 `false`: 사용 안 함
`useItemHighlightImage`	Boolean	Required	아이템 하이라이트 이미지 사용 여부 `true` \| `false` `true`: 사용 `false`: 사용 안 함
`itemHighlight`	Object	Optional	아이템 하이라이트 정보
`itemHighlight.title`	String	Optional	아이템 하이라이트 제목
`itemHighlight.description`	String	Optional	아이템 하이라이트 내용
`itemHighlight.imageUrl`	String	Optional	아이템 하이라이트 이미지 URL
`item`	Object	Optional	아이템 리스트 정보
`item.list`	Array	Optional	아이템 리스트
`item.summary`	Object	Optional	아이템 요약 정보
`item.summary.title`	String	Optional	아이템 요약 제목
`item.summary.description`	String	Optional	아이템 요약 내용

`comments`

comments에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`commentId`	String	Required	검수 아이디
`content`	String	Required	검수 내용
`status`	String	Required	검수 상태 `APR` \| `REJ` `APR`: 검수 완료 `REJ`: 검수 반려
`createTime`	String	Required	검수 일시 YYYY-MM-DD HH:mm:ss 형식
`attachment`	Array	Optional	검수 문의 내용 첨부 파일

`attachment`

attachment에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`fileName`	String	Required	첨부 파일 이름
`fileUrl`	String	Required	첨부 파일 URL

`buttons`

buttons에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`order`	Integer	Required	버튼 순서
`type`	String	Required	버튼 유형 `DS` \| `WL` \| `AL` \| `BK` \| `MD` \| `AC` `DS`: 배송 조회 `WL`: 웹 링크 `AL`: 앱 링크 `BK`: 봇 키워드 `MD`: 메시지 전달 `AC`: 채널 추가
`name`	String	Required	버튼 이름
`linkMobile`	String	Optional	모바일 웹 링크
`linkPc`	String	Optional	PC 웹 링크
`schemeIos`	String	Optional	iOS 앱 링크
`schemeAndroid`	String	Optional	Android 앱 링크

`item.list`

item.list에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`title`	String	Required	아이템 이름
`description`	String	Required	아이템 내용

응답 상태 코드

Simple & Easy Notification Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Simple & Easy Notification Service 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

목록 조회 시

[
  {
    "createTime": "2025-11-25T10:38:52.604",
    "updateTime": "2025-11-25T10:41:21.538",
    "channelId": "@********",
    "templateCode": "templatecode1",
    "templateName": "t001"
  }
]

상세 조회 시(templateCode 포함 조회)

[
    {
        "createTime": "2025-11-25T10:38:52.604",
        "updateTime": "2025-11-25T10:41:21.538",
        "channelId": "@********",
        "templateCode": "templatecode1",
        "templateName": "t001",
        "categoryCode": "009001",
        "categoryName": "쿠폰발급",
        "messageType": "BA",
        "emphasizeType": "TEXT",
        "content": "🎉 신규 고객 웰컴 쿠폰 지급!\n지금 회원가입하면 바로 사용 가능한\n5,000원 쿠폰을 드립니다.\n👉 쿠폰 받기: #{URL}",
        "title": "신규 고객 혜택",
        "additionalTitle": "신규 고객 웰컴 쿠폰 지급",
        "comments": [],
        "templateInspectionStatus": "REGISTER",
        "templateStatus": "READY",
        "buttons": [],
        "securityFlag": false,
        "isBlock": false,
        "isDormant": false,
        "useImage": false,
        "useHeaderContent": false,
        "useItemHighlight": false
    }
]