템플릿 목록 조회

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

브랜드메시지의 템플릿 정보를 조회합니다.

요청

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

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

요청 헤더

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

요청 경로 파라미터

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

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`plusFriendId`	String	Required	채널 아이디 채널 조회 참조
`templateCode`	String	Optional	템플릿 코드
`templateName`	String	Optional	템플릿 이름 전체 또는 부분 일치하는 값 필터링
`messageType`	String	Optional	메시지 타입 `TEXT` \| `IMAGE` \| `WIDE_IMAGE` \| `WIDE_ITEM_LIST` \| `COMMERCE` \| `CAROUSEL_COMMERCE` \| `CAROUSEL_FEED` \| `PREMIUM_VIDEO` `TEXT`: 텍스트 `IMAGE`: 이미지형 `WIDE_IMAGE`: 와이드 이미지형 `WIDE_ITEM_LIST`: 와이드 리스트형 `COMMERCE`: 커머스형 `CAROUSEL_COMMERCE`: 캐러셀 커머스형 `CAROUSEL_FEED`: 캐러셀 피드형 `PREMIUM_VIDEO`: 프리미엄 동영상형
`pageSize`	Integer	Optional	페이지당 항목 수 1~100 (기본값: 100)
`pageIndex`	Integer	Optional	페이지 인덱스 0~N (기본값: 0)

요청 예시

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

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

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`items`	Array	Required	이미지 목록
`pageIndex`	Integer	Required	페이지 인덱스
`pageSize`	Integer	Required	페이지당 항목 수
`itemCount`	Integer	Required	응답 결과 수
`hasPrevious`	Boolean	Required	이전 페이지 존재 여부 `true` \| `false` `true`: 존재 `false`: 존재 안 함
`hasNext`	Boolean	Required	다음 페이지 존재 여부 `true` \| `false` `true`: 존재 `false`: 존재 안 함
`totalCount`	Integer	Required	전체 항목 수

`items`

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

필드	타입	필수 여부	설명
`createTime`	String	Required	템플릿 생성 일시 YYYY-MM-DDTHH:mm:ss.sss 형식
`updateTime`	String	Optional	템플릿 수정 일시 YYYY-MM-DDTHH:mm:ss.sss 형식
`plusFriendId`	String	Required	채널 아이디
`templateCode`	String	Required	템플릿 코드
`templateName`	String	Required	템플릿 이름
`templateStatus`	String	Required	템플릿 상태 `ACTIVE`: 정상
`messageType`	String	Required	메시지 타입 `TEXT` \| `IMAGE` \| `WIDE_IMAGE` \| `WIDE_ITEM_LIST` \| `COMMERCE` \| `CAROUSEL_COMMERCE` \| `CAROUSEL_FEED` \| `PREMIUM_VIDEO` `TEXT`: 텍스트 `IMAGE`: 이미지형 `WIDE_IMAGE`: 와이드 이미지형 `WIDE_ITEM_LIST`: 와이드 리스트형 `COMMERCE`: 커머스형 `CAROUSEL_COMMERCE`: 캐러셀 커머스형 `CAROUSEL_FEED`: 캐러셀 피드형 `PREMIUM_VIDEO`: 프리미엄 동영상형
`isAdult`	Boolean	Required
`headerContent`	String	Optional	헤더 내용
`content`	String	Optional	템플릿 내용
`additionalContent`	String	Optional	헤더 내용
`buttons`	Array	Optional	버튼 정보
`item`	Object	Optional	아이템 리스트 정보
`image`	Object	Optional	이미지 정보
`carousel`	Object	Optional	캐러셀 정보
`commerce`	Object	Optional	커머스 정보
`video`	Object	Optional	동영상 정보
`coupon`	Object	Optional	쿠폰 정보

응답 상태 코드

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

응답 예시

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

{
  "items": [
    {
      "plusFriendId": "@********",
      "templateCode": "99fd4b93b256ef*********************",
      "templateName": "무료쿠폰발급",
      "templateStatus": "ACTIVE",
      "messageType": "TEXT",
      "isAdult": false,
      "createTime": "2025-11-19T22:57:19.949",
      "updateTime": "2025-11-25T15:01:36.265",
      "content": "#{content}",
      "buttons": [
        {
          "type": "WL",
          "name": "사이트 바로가기",
          "linkMobile": "https://www.****.com"
        }
      ],
      "coupon": {
        "title": "네이버클라우드 무료 쿠폰",
        "description": "무료쿠폰",
        "linkMobile": "https://www.****.com"
      }
    }
  ],
  "pageIndex": 0,
  "pageSize": 100,
  "itemCount": 1,
  "hasPrevious": false,
  "hasNext": false,
  "totalCount": 1
}