POST/kakao/v2/brand-templates
새로운 브랜드 템플릿을 등록합니다.
알림톡 템플릿과 달리 등록 즉시 검수 절차 없이 바로 사용할 수 있습니다. 다양한 버블 타입을 지원하며, 각 타입별로 필수 파라미터와 버튼 개수 제한이 다르므로 하단의 타입별 요약 표를 참고하세요.
pfId와 pfGroupId 중 하나만 필수로 입력해야 하며, 둘 다 입력하거나 둘 다 입력하지 않으면 ValidationError가 발생합니다.
변수명은 최대 20자 이내로, 한글/영문/숫자/특수기호(-, _)만 사용 가능합니다.
Body Params
| Name | Type | Required | Description |
|---|
| pfId | string | | 플러스친구 아이디 (pfId와 pfGroupId 중 하나만 필수) |
| pfGroupId | string | | 플러스친구 그룹 아이디 (pfId와 pfGroupId 중 하나만 필수) |
| chatBubbleType | string | * | 채팅 버블 타입 (TEXT, IMAGE, WIDE, WIDE_ITEM_LIST, CAROUSEL_FEED, COMMERCE, CAROUSEL_COMMERCE, PREMIUM_VIDEO) |
| name | string | | 템플릿 이름 (최대 100자) |
| content | string | | 템플릿 내용 (최대 400자, 타입별 제한 상이) |
| adult | boolean | | 성인용 메시지 여부 (기본값: false) |
| header | string | | 템플릿 헤더 (최대 20자, 줄바꿈 불가) |
| imageId | string | | 브랜드 메시지 이미지 아이디 |
| imageLink | string | | 이미지 클릭 시 이동할 링크 (최대 500자) |
| additionalContent | string | | 템플릿 부가정보 |
| carousel | object | | 캐러셀 정보 |
| head | object | | 캐러셀 인트로 (CAROUSEL_COMMERCE 전용) |
| header | string | | 헤더 (최대 20자) |
| content | string | | 내용 (최대 50자) |
| imageId | string | | 이미지 ID |
| linkPc | string | | PC 링크 |
| linkMobile | string | | 모바일 링크 |
| linkAndroid | string | | 안드로이드 링크 |
| linkIos | string | | iOS 링크 |
| list | array | * | 캐러셀 아이템 목록 (최소 2개, 최대 6개) |
| header | string | | 아이템 헤더 (최대 20자) |
| content | string | | 아이템 내용 (최대 180자) |
| additionalContent | string | | 부가정보 (최대 34자) |
| imageId | string | | 이미지 ID |
| imageLink | string | | 이미지 클릭 링크 |
| commerce | object | | 커머스 정보 (CAROUSEL_COMMERCE 전용, 구조는 하단 commerce 참고) |
| buttons | array | | 버튼 목록 (구조는 하단 buttons 참고) |
| coupon | object | | 쿠폰 정보 (구조는 하단 coupon 참고) |
| tail | object | | 캐러셀 더보기 링크 |
| linkPc | string | | PC 링크 |
| linkMobile | string | | 모바일 링크 |
| linkAndroid | string | | 안드로이드 링크 |
| linkIos | string | | iOS 링크 |
| mainWideItem | object | | 와이드 리스트의 첫 번째 아이템 |
| title | string | | 아이템 제목 |
| imageId | string | | 이미지 ID |
| linkMobile | string | | 모바일 링크 |
| linkPc | string | | PC 링크 |
| linkAndroid | string | | 안드로이드 링크 |
| linkIos | string | | iOS 링크 |
| subWideItemList | array | | 와이드 리스트의 서브 아이템들 (mainWideItem과 동일한 구조) |
| video | object | | 프리미엄 동영상 정보 |
| videoUrl | string | | 동영상 URL |
| imageId | string | | 썸네일 이미지 ID |
| commerce | object | | 커머스 정보 |
| title | string | | 상품명 |
| regularPrice | string | | 정가 (0~99,999,999) |
| discountPrice | string | | 할인가 (0~99,999,999) |
| discountRate | string | | 할인율 (0~99,999,999) |
| discountFixed | string | | 정액 할인 (0~99,999,999) |
| buttons | array | | 버튼 목록 (타입별 개수 제한 있음) |
| name | string | * | 버튼 이름 |
| linkType | string | * | 링크 타입 |
| linkMobile | string | | 모바일 링크 |
| linkPc | string | | PC 링크 |
| linkAndroid | string | | 안드로이드 링크 |
| linkIos | string | | iOS 링크 |
| coupon | object | | 쿠폰 정보 |
| title | string | | 쿠폰 제목 |
| description | string | | 쿠폰 설명 (WIDE 계열 최대 18자, 그 외 최대 12자) |
| linkMobile | string | | 모바일 링크 |
| linkPc | string | | PC 링크 |
| linkAndroid | string | | 안드로이드 링크 |
| linkIos | string | | iOS 링크 |
chatBubbleType 필수 파라미터 요약
| Name | Description |
|---|
| TEXT | 텍스트 버블 타입 |
| pfId 또는 pfGroupId | 플러스친구 아이디 또는 그룹 아이디 (둘 중 하나 필수) |
| name | 템플릿 이름 |
| chatBubbleType | "TEXT" |
| content | 템플릿 내용 (최대 400자) |
| IMAGE | 이미지 버블 타입 |
| pfId 또는 pfGroupId | 플러스친구 아이디 또는 그룹 아이디 (둘 중 하나 필수) |
| name | 템플릿 이름 |
| chatBubbleType | "IMAGE" |
| content | 템플릿 내용 |
| imageId | 이미지 아이디 |
| WIDE | 와이드 버블 타입 |
| pfId 또는 pfGroupId | 플러스친구 아이디 또는 그룹 아이디 (둘 중 하나 필수) |
| name | 템플릿 이름 |
| chatBubbleType | "WIDE" |
| content | 템플릿 내용 |
| imageId | 이미지 아이디 |
| WIDE_ITEM_LIST | 와이드 아이템 리스트 버블 타입 |
| pfId 또는 pfGroupId | 플러스친구 아이디 또는 그룹 아이디 (둘 중 하나 필수) |
| name | 템플릿 이름 |
| chatBubbleType | "WIDE_ITEM_LIST" |
| header | 헤더 (최대 20자) |
| mainWideItem | 메인 와이드 아이템 |
| subWideItemList | 서브 와이드 아이템 목록 |
| CAROUSEL_FEED | 캐러셀 피드 버블 타입 |
| pfId 또는 pfGroupId | 플러스친구 아이디 또는 그룹 아이디 (둘 중 하나 필수) |
| name | 템플릿 이름 |
| chatBubbleType | "CAROUSEL_FEED" |
| carousel.list | 캐러셀 아이템 목록 (최소 2개, 최대 6개) |
| COMMERCE | 커머스 버블 타입 |
| pfId 또는 pfGroupId | 플러스친구 아이디 또는 그룹 아이디 (둘 중 하나 필수) |
| name | 템플릿 이름 |
| chatBubbleType | "COMMERCE" |
| imageId | 이미지 아이디 |
| commerce | 커머스 정보 |
| buttons | 버튼 목록 (최소 1개) |
| CAROUSEL_COMMERCE | 캐러셀 커머스 버블 타입 |
| pfId 또는 pfGroupId | 플러스친구 아이디 또는 그룹 아이디 (둘 중 하나 필수) |
| name | 템플릿 이름 |
| chatBubbleType | "CAROUSEL_COMMERCE" |
| carousel.list | 캐러셀 아이템 목록 (최소 2개, 최대 6개) |
| PREMIUM_VIDEO | 프리미엄 비디오 버블 타입 |
| pfId 또는 pfGroupId | 플러스친구 아이디 또는 그룹 아이디 (둘 중 하나 필수) |
| name | 템플릿 이름 |
| chatBubbleType | "PREMIUM_VIDEO" |
| video | 프리미엄 동영상 정보 |
타입별 버튼 제한
| Name | Description |
|---|
| TEXT | 쿠폰 적용 시 최대 4개, 그 외 최대 5개 |
| IMAGE | 쿠폰 적용 시 최대 4개, 그 외 최대 5개 |
| WIDE | 최대 2개 |
| CAROUSEL_FEED | 캐러셀당 최소 1개, 최대 2개 |
| CAROUSEL_COMMERCE | 캐러셀당 최소 1개, 최대 2개 |
| WIDE_ITEM_LIST | 최대 2개 |
| PREMIUM_VIDEO | 최대 1개 |
| COMMERCE | 최소 1개, 최대 2개 |
Response
chat
브랜드 템플릿 객체를 반환합니다. 이 엔드포인트만 toV2UserJSON() 변환이 적용되어 pfId, pfGroupId, isDeleted 필드가 제외되고, 대신 status와 code 필드가 추가됩니다. 브랜드 템플릿 객체의 자세한 사항은 공통 응답 스키마를 참조하세요.
{
"brandTemplateId": "KA01BP240101000000001",
"accountId": "AC01000000000001",
"name": "테스트 텍스트 템플릿",
"assignType": "CHANNEL",
"chatBubbleType": "TEXT",
"content": "안녕하세요 #{이름}님",
"header": null,
"imageId": null,
"imageLink": null,
"additionalContent": null,
"adult": false,
"allowCopy": false,
"buttons": [],
"coupon": null,
"carousel": null,
"mainWideItem": null,
"subWideItemList": [],
"video": null,
"commerce": null,
"status": "ACTIVE",
"code": "CODE01",
"codes": [
{
"code": "CODE01",
"status": "ACTIVE",
"service": "biz",
"isMain": true
}
],
"variables": [
{ "name": "이름" }
],
"dateCreated": "2024-01-01T00:00:00.000Z",
"dateUpdated": "2024-01-01T00:00:00.000Z"
}