1) 템플릿 등록
| API 정보 |
• 브랜드 메시지 기본형 템플릿을 등록합니다.
• POST /v4/kakao/brand/template/add • Content-Type: application/json |
|||||
| 요청 파라미터 | ||||||
| 키 | - | - | 타입 | 필수 | 설명 | |
| bizId | String | O | BIZPPURIO ID | |||
| apiKey | String | O | API 발급 키 | |||
| senderKey | String | O | 발신 프로필 키(senderKeyType이 G인 경우 프로필 그룹키) | |||
| senderKeyType | String | X | 발신 프로필 키 타입 (S:일반(default), G:그룹) | |||
| templateName | String | O | 템플릿 이름 | |||
| chatBubbleType | String | O | 메시지 타입 ('9.1.1. 메시지 타입 별 필수 파라미터' 참조) | |||
| adult | Boolean |
- |
성인 콘텐츠 여부 | |||
| header | String | - |
템플릿 헤더 - WIDE_ITEM_LIST - 최소 1자, 최대 20자 (줄바꿈: 불가) - PREMIUM_VIDEO - 최대 20자 (줄바꿈: 불가) |
|||
| content | String | - |
템플릿 내용 - TEXT - 최대 1,000자 (줄바꿈: 최대 33개, URL 형식 입력 가능) - IMAGE - 최대 400자 (줄바꿈: 최대 29개, URL 형식 입력 가능) - WIDE, PREMIUM_VIDEO - 최대 76자 (줄바꿈: 최대 1개) |
|||
| additionalContent | String | X |
템플릿 부가정보 - 공백 포함 최대 34자 (줄바꿈: 최대 1개) |
|||
| imageUrl | String | - | 이미지 업로드 API 로 등록한 이미지 URL | |||
| imageLink | String | - | 이미지 클릭시 이동 URL | |||
| carousel | - | - | Object | - |
변수명은 최대 20자 이내 한/영/숫자/허용된 특수기호('-', '_')로만 입력 가능합니다. (단, 변수 선언 후 필드 별 최대 글자수는 초과할 수 없습니다.) head에 최대 20개의 변수명 입력 가능합니다. (중복 제외) list의 아이템 1개당 최대 20개의 변수명 입력 가능합니다. (중복 제외) tail에 변수 사용 불가능합니다 |
|
| header | - | Object | X | 캐러셀 인트로 - CAROUSEL_COMMERCE인 경우 사용 | ||
| header | String | X |
캐러셀 인트로 헤더 최대 20자 (줄바꿈: 불가) |
|||
| content | String | X |
캐러셀 인트로 내용 최대 50자 (줄바꿈: 최대 2개) |
|||
| imageUrl | String | O | 이미지 업로드 API로 등록한 캐러셀 인트로 이미지 URL | |||
| linkMobile | String | O | MOBILE 환경에서 캐러셀 인트로 클릭 시 이동할 URL | |||
| linkPc | String | X | PC 환경에서 캐러셀 인트로 클릭 시 이동할 URL | |||
| linkIos | String | X | MOBILE iOS 환경에서 캐러셀 인트로 클릭 시 실행할 application custom scheme | |||
| linkAndroid | String | X | MOBILE Android 환경에서 캐러셀 인트로 클릭 시 실행할 application custom scheme | |||
| list | - | Array | - | 캐러셀 리스트 | ||
| header | String | X |
캐러셀 리스트 헤더 CAROUSEL_FEED인 경우 사용 최대 20자 (줄바꿈: 불가) |
|||
| content | String | X |
캐러셀 리스트 내용 CAROUSEL_FEED인 경우 사용 최대 180자 (줄바꿈: 최대 2개) |
|||
| imageUrl | String | O | 이미지 업로드 API로 등록한 캐러셀 리스트 이미지 URL | |||
| imageLink | String | X | 캐러셀 리스트 이미지 클릭시 이동할 URL | |||
| commerce | Commerce | O | 커머스 요소 | |||
| buttons | Button[] | O | 버튼 요소 | |||
| coupon | Coupon | X | 쿠폰 요소 | |||
| tail | - | Object | X | 더보기 버튼 | ||
| linkMobile | String | O | MOBILE 환경에서 캐러셀 인트로 클릭 시 이동할 URL | |||
| linkPc | String | X | PC 환경에서 캐러셀 인트로 클릭 시 이동할 URL | |||
| linkIos | String | X | MOBILE iOS 환경에서 캐러셀 인트로 클릭 시 실행할 application custom scheme | |||
| linkAndroid | String | X | MOBILE Android 환경에서 캐러셀 인트로 클릭 시 실행할 application custom scheme | |||
| mainWideItem | Object | - | mainWideItem, subWideItemList 내용 및 링크 통틀어 최대 40개의 변수명 입력 가능합니다. (중복 제외) | |||
| title | String | X |
아이템 제목 - mainWideItem - 최대 25자 (줄바꿈: 최대 1개) - subWideItemList - 최대 30자 (줄바꿈: 최대 1개) |
|||
| imageUrl | String | O | 이미지 업로드 API로 등록한 아이템 이미지 URL | |||
| linkMobile | String | O | MOBILE 환경에서 쿠폰 클릭 시 이동할 URL | |||
| linkPc | String | X | PC 환경에서 쿠폰 클릭 시 이동할 URL | |||
| linkAndroid | String | X | MOBILE Android 환경에서 쿠폰 클릭 시 실행할 application custom scheme | |||
| linkIos | String | X | MOBILE iOS 환경에서 쿠폰 클릭 시 실행할 application custom scheme | |||
| subWideItemList | Array | - | mainWideItem, subWideItemList 내용 및 링크 통틀어 최대 40개의 변수명 입력 가능합니다. (중복 제외) | |||
| title | String | O |
아이템 제목 - mainWideItem - 최대 25자 (줄바꿈: 최대 1개) - subWideItemList - 최대 30자 (줄바꿈: 최대 1개) |
|||
| imageUrl | String | O | 이미지 업로드 API로 등록한 아이템 이미지 URL | |||
| linkMobile | String | O | MOBILE 환경에서 쿠폰 클릭 시 이동할 URL | |||
| linkPc | String | X | PC 환경에서 쿠폰 클릭 시 이동할 URL | |||
| linkAndroid | String | X | MOBILE Android 환경에서 쿠폰 클릭 시 실행할 application custom scheme | |||
| linkIos | String | X | MOBILE iOS 환경에서 쿠폰 클릭 시 실행할 application custom scheme | |||
| video | Object | O | ||||
| videoUrl | String | O | 카카오TV 동영상 URL | |||
| thumbnailUrl | String | X |
이미지 업로드 API로 등록한 동영상 썸네일용 이미지 URL (기본값: 동영상 기본 썸네일 이미지) - thumbnailUrl 필드 필수(videoUrl이 비공개 동영상) |
|||
| commerce | Object | X |
메시지 표기 방식에 따라 regularPrice, discountPrice, discountRate, discountFixed은 다음과 같이 사용할 수 있습니다. 정상 가격으로 표기 : regularPrice 정상 가격 + 할인 후 가격(할인율 포함)으로 표기 : regularPrice, discountPrice, discountRate 정상 가격 + 할인 후 가격(정액 할인 가격 포함)으로 표기 : regularPrice, discountPrice, discountFixed regularPrice, discountPrice, discountRate, discountFixed 값을 입력하지 않을 경우 고정 변수명으로 저장됩니다. 고정 변수명을 사용하면 메시지 발송 시 금액을 변경하여 메시지를 발송 할 수 있습니다. |
|||
| title | String | O | 상품 제목 (줄바꿈 문자 입력 불가. 변수 가능) | |||
| regularPrice | Number | X |
정상 가격 (0 ~ 99,999,999) 값이 없을 경우 고정 변수(변수명: #{정상가격})로 저장 |
|||
| discountPrice | Number | X |
할인 후 가격 (0 ~ 99,999,999) 값이 없을 경우 고정 변수(변수명: #{할인가격})로 저장 |
|||
| discountRate | Number | X |
할인율 (0 ~ 100) 값이 없을 경우 고정 변수(변수명: #{할인율})로 저장 |
|||
| discountFixed | Number | X |
정액 할인 가격 (0 ~ 999,999) 값이 없을 경우 고정 변수(변수명: #{정액할인가격})로 저장 |
|||
| buttons | Array | X |
버튼 요소에는 전체 버튼을 통틀어 최대 20개(중복 제외)의 변수 사용이 가능합니다. 변수명은 최대 20자 이내 한/영/숫자/허용된 특수기호('-', '_')로만 입력 가능합니다. (단, 변수 선언 후 필드 별 최대 글자수는 초과할 수 없습니다.) AC 버튼을 사용할 경우, TEXT, IMAGE 는 첫번째 버튼으로, 그 외 메시지 타입의 경우 마지막 버튼으로 등록해주셔야 합니다. |
|||
| name | String | O |
버튼 제목 TEXT, IMAGE - 최대 14자 그 외 - 최대 8자 (줄바꿈 문자 입력 불가) |
|||
| linkType | String | O | 버튼 링크타입 (WL:웹링크, AL:앱링크, BK:봇키워드, MD: 메시지전달, AC: 채널추가, BF: 비즈니스폼 |
|||
| linkMobile | String | - | MOBILE 환경에서 쿠폰 클릭 시 이동할 URL | |||
| linkPc | String | - | PC 환경에서 쿠폰 클릭 시 이동할 URL | |||
| linkAndroid | String | - | MOBILE Android 환경에서 쿠폰 클릭 시 실행할 application custom scheme | |||
| linkIos | String | - | MOBILE iOS 환경에서 쿠폰 클릭 시 실행할 application custom scheme | |||
| bizFormId | Number | - | 비즈니스폼 ID | |||
| coupon | Object | X |
채널 쿠폰 URL(포맷: alimtalk=coupon://) 사용시 linkAndroid, linkIos 중 하나 필수 입력 채널 쿠폰 URL이 아닌 기본 쿠폰 사용시 linkMobile 필수 입력 |
|||
| title | String | O |
쿠폰 제목 - 변수 사용을 원할 경우 고정 변수명 사용 - #{할인금액}원 할인 쿠폰 (#{할인금액} 범위는 1 ~ 99,999,999) - #{할인율}% 할인 쿠폰 (#{할인율} 범위는 1 ~ 100) - 배송비 할인 쿠폰 - #{상품명} 무료 쿠폰 (#{상품명}은 최대 7자) - #{상품명} UP 쿠폰 (#{상품명}은 최대 7자) |
|||
| description | String | O |
쿠폰 설명 - WIDE, WIDE_ITEM_LIST, PREMIUM_VIDEO - 최대 18자 (줄바꿈: 불가) - 그 외 - 최대 12자 (줄바꿈: 불가)> |
|||
| linkMobile | String | X | MOBILE 환경에서 쿠폰 클릭 시 이동할 URL | |||
| linkPc | String | X | PC 환경에서 쿠폰 클릭 시 이동할 URL | |||
| linkAndroid | String | X | MOBILE Android 환경에서 쿠폰 클릭 시 실행할 application custom scheme | |||
| linkIos | String | X | MOBILE iOS 환경에서 쿠폰 클릭 시 실행할 application custom scheme | |||
| 반환 값 | ||||||
| 키 | - | 타입 | 설명 | |||
| code | String | 결과 코드 | ||||
| message | String | 실패 시 결과 메시지 | ||||
| data | Object | 성공 시 템플릿 정보 (템플릿 조회 참고) | ||||
- 메시지 타입 별 필수 파라미터
변수명은 최대 20자 이내 한/영/숫자/허용된 특수기호('-', '_')로만 입력 가능합니다. (단, 변수 선언 후 필드 별 최대 글자수는 초과할 수 없습니다.)
최대 20개의 변수명 입력 가능합니다. (중복 제외)
브랜드 메시지 유형별 템플릿 사용 가능 요소, 필수 요소, 변수 사용 가능 요소는 다음과 같습니다.
| chatBubbleType | 사용 가능 파라미터 | 필수 파라미터 | 변수 사용 가능 파라미터 |
| TEXT | senderKey templateName chatBubbleType adult content buttons coupon |
senderKey templateName chatBubbleType content |
content buttons[].linkPc buttons[].linkMobile buttons[].linkAndroid buttons[].linkIos coupon.title coupon.description coupon.linkPc coupon.linkMobile coupon.linkAndroid coupon.linkIos |
| IMAGE | senderKey templateName chatBubbleType adult imageLink content imageUrl buttons coupon |
senderKey templateName chatBubbleType content imageUrl |
content buttons[].linkPc buttons[].linkMobile buttons[].linkAndroid buttons[].linkIos coupon.title coupon.description coupon.linkPc coupon.linkMobile coupon.linkAndroid coupon.linkIos |
| WIDE | senderKey templateName chatBubbleType adult content imageUrl imageLink buttons coupon |
senderKey templateName chatBubbleType content imageUrl |
content buttons[].linkPc buttons[].linkMobile buttons[].linkAndroid buttons[].linkIos coupon.title coupon.description coupon.linkPc coupon.linkMobile coupon.linkAndroid coupon.linkIos |
| WIDE_ITEM_LIST | senderKey templateName chatBubbleType adult header mainWideItem subWideItemList buttons coupon |
senderKey templateName chatBubbleType header mainWideItem subWideItemList |
header mainWideItem.title mainWideItem.linkPc mainWideItem.linkMobile mainWideItem.linkAndroid mainWideItem.linkIos subWideItemList[].title subWideItemList[].linkPc subWideItemList[].linkMobile subWideItemList[].linkAndroid subWideItemList[].linkIos buttons.linkPc buttons.linkMobile buttons.linkAndroid buttons.linkIos coupon.title coupon.description coupon.linkPc coupon.linkMobile coupon.linkAndroid coupon.linkIos |
| CAROUSEL_FEED | senderKey templateName chatBubbleType adult carousel.list carousel.tail |
senderKey templateName chatBubbleType carousel.list |
carousel.list[].header carousel.list[].content carousel.list[].buttons[].linkPc carousel.list[].buttons[].linkMobile carousel.list[].buttons[].linkAndroid carousel.list[].buttons[].linkIos carousel.list[].coupon.title carousel.list[].coupon.description carousel.list[].coupon.linkPc carousel.list[].coupon.linkMobile carousel.list[].coupon.linkAndroid carousel.list[].coupon.linkIos |
| PREMIUM_VIDEO | senderKey templateName chatBubbleType adult header content video buttons coupon |
senderKey templateName chatBubbleType video |
header content buttons[].linkPc buttons[].linkMobile buttons[].linkAndroid buttons[].linkIos coupon.title coupon.description coupon.linkPc coupon.linkMobile coupon.linkAndroid coupon.linkIos |
| COMMERCE | senderKey templateName chatBubbleType adult additionalContent imageUrl imageLink commerce buttons coupon |
senderKey templateName chatBubbleType imageUrl commerce buttons |
additionalContent commerce.title commerce.regularPrice, commerce.discountPrice, commerce.discountRate, commerce.discountFixed buttons[].linkPc buttons[].linkMobile buttons[].linkAndroid buttons[].linkIos coupon.title coupon.description coupon.linkPc coupon.linkMobile coupon.linkAndroid coupon.linkIos |
| CAROUSEL_COMMERCE | senderKey templateName chatBubbleType adult carousel.head carousel.list carousel.tail |
senderKey templateName chatBubbleType carousel.list |
carousel.head.header carousel.head.content carousel.head.linkPc carousel.head.linkMobile carousel.head.linkAndroid carousel.head.linkIos carousel.list[].additionalContent carousel.list[].commerce.title carousel.list[].buttons[].linkPc carousel.list[].buttons[].linkMobile carousel.list[].buttons[].linkAndroid carousel.list[].buttons[].linkIos carousel.list[].coupon.title carousel.list[].coupon.description carousel.list[].coupon.linkPc carousel.list[].coupon.linkMobile carousel.list[].coupon.linkAndroid carousel.list[].coupon.linkIos |
2) 템플릿 조회
| API 정보 |
• 템플릿을 조회합니다. • POST /v4/kakao/brand/template/detail • Content-Type: application/json |
||||||
| 요청 파라미터 | |||||||
| 키 | - | 타입 | 필수 | 설명 | |||
| bizId | String | O | BIZPPURIO ID | ||||
| apiKey | String | O | API 발급 키 | ||||
| senderKey | String | O | 발신 프로필 키(senderKeyType이 G인 경우 프로필 그룹키) | ||||
| senderKeyType | String | X | 발신 프로필 키 타입 (S:일반(default), G:그룹) | ||||
| code | String | O | 템플릿 코드 | ||||
| 반환 값 | |||||||
| 키 | - | 타입 | 설명 | ||||
| code | String | 결과 코드 | |||||
| message | String | 결과 메시지 | |||||
| data | Object | 업로드 결과 | |||||
| code | String | 템플릿 코드 | |||||
| templateName | String | 템플릿 이름 | |||||
| chatBubbleType | String | 메시지 타입 | |||||
| content | String | 템플릿 내용 | |||||
| adult | Boolean | 성인용 메시지 여부 | |||||
| imageLink | String | 이미지 클릭시 이동할 URL | |||||
| imageUrl | String | 이미지 업로드 API로 등록한 이미지 URL | |||||
| header | String | 헤더 | |||||
| additionalContent | String | 부가 정보 | |||||
| carousel | Object | 캐러셀 요소 (9.1 템플릿 등록 참고) | |||||
| wideItemList | Array | 와이드 리스트 목록 (9.1 템플릿 등록 참고) | |||||
| video | Object | 동영상 요소 (9.1 템플릿 등록 참고) | |||||
| commerce | Object | 커머스 요소 (9.1 템플릿 등록 참고) | |||||
| createdAt | String | 등록일시 (yyyy-MM-dd HH:mm:ss) | |||||
| modifiedAt | String | 수정일시 (yyyy-MM-dd HH:mm:ss) | |||||
| status | String | 템플릿 상태 (A: 등록, S: 차단) | |||||
| buttons | Array | 버튼 목록 (9.1 템플릿 등록 참고) | |||||
| coupon | Object | 쿠폰 요소 (9.1 템플릿 등록 참고) | |||||
3) 템플릿 수정
| API 정보 |
• 템플릿을 수정합니다. • POST /v4/kakao/brand/template/update • Content-Type: application/json |
|||||
| 요청 파라미터 | ||||||
| 키 | 타입 | 필수 | 설명 | |||
| bizId | String | O | BIZPPURIO ID | |||
| apiKey | String | O | API 발급 키 | |||
| senderKey | String | O | 발신 프로필 키 | |||
| senderKeyType | String | X | (S:일반, G:그룹) | |||
| templateName | String | O | 템플릿 이름 (최대 200자) | |||
| chatBubbleType | String | O | 메시지 타입 ('9.1.1. 메시지 타입 별 필수 파라미터' 참조) | |||
| adult | Boolean | X | 성인용 메시지 여부 | |||
| header | String | - | 이미지 클릭시 이동할 URL | |||
| content | String | - | 이미지 업로드 API로 등록한 이미지 URL | |||
| additionalContent | String | X | 헤더 | |||
| imageUrl | String | - | 부가 정보 | |||
| imageLink | String | - | 와이드 리스트 목록 (9.1 템플릿 등록 참고) | |||
| carousel | Object | - | 동영상 요소 (9.1 템플릿 등록 참고) | |||
| mainWideItem | Object | - | 커머스 요소 (9.1 템플릿 등록 참고) | |||
| subWideItemList | Array | - | 등록일시 (yyyy-MM-dd HH:mm:ss) | |||
| video | Object | - | 수정일시 (yyyy-MM-dd HH:mm:ss) | |||
| commerce | Object | - | 템플릿 상태 (A: 등록, S: 차단) | |||
| buttons | Array | - | 버튼 목록 (9.1 템플릿 등록 참고) | |||
| coupon | Object | X | 쿠폰 요소 (9.1 템플릿 등록 참고) | |||
| 반환 값 | ||||||
| 키 | - | 타입 | 설명 | |||
| code | String | 결과 코드 | ||||
| message | String | 결과 메시지 | ||||
| data | Object | 업로드 결과 | ||||
| code | String | 템플릿 코드 | ||||
| templateName | String | 템플릿 이름 | ||||
| chatBubbleType | String | 메시지 타입 | ||||
| content | String | 템플릿 내용 | ||||
| adult | Boolean | 성인용 메시지 여부 | ||||
| imageLink | String | 이미지 클릭시 이동할 URL | ||||
| imageUrl | String | 이미지 업로드 API로 등록한 이미지 URL | ||||
| header | String | 헤더 | ||||
| additionalContent | String | 부가 정보 | ||||
| carousel | Object | 캐러셀 요소 (9.1 템플릿 등록 참고) | ||||
| wideItemList | Array | 와이드 리스트 목록 (9.1 템플릿 등록 참고) | ||||
| video | Object | 동영상 요소 (9.1 템플릿 등록 참고) | ||||
| commerce | Object | 커머스 요소 (9.1 템플릿 등록 참고) | ||||
| createdAt | String | 등록일시 (yyyy-MM-dd HH:mm:ss) | ||||
| modifiedAt | String | 수정일시 (yyyy-MM-dd HH:mm:ss) | ||||
| status | String | 템플릿 상태 (A: 등록, S: 차단) | ||||
| buttons | Array | 버튼 목록 (9.1 템플릿 등록 참고) | ||||
| coupon | Object | 쿠폰 요소 (9.1 템플릿 등록 참고) | ||||
4) 템플릿 삭제
| API 정보 |
• 템플릿을 삭제합니다. 템플릿 상태가 등록(A)인 경우에만 삭제 가능합니다. • POST /v4/kakao/brand/template/delete • Content-Type: application/json |
||||||
| 요청 파라미터 | |||||||
| 키 | - | 타입 | 필수 | 설명 | |||
| bizId | String | O | BIZPPURIO ID | ||||
| apiKey | String | O | API 발급 키 | ||||
| senderKey | String | O | 발신 프로필 키(senderKeyType이 G인 경우 프로필 그룹키) | ||||
| senderKeyType | String | X | 발신 프로필 키 타입 (S:일반(default), G:그룹) | ||||
| code | String | O | 템플릿 코드 | ||||
| 반환 값 | |||||||
| 키 | - | 타입 | 설명 | ||||
| code | String | 결과 코드 | |||||
| message | String | 실패 시 결과 메시지 | |||||
댓글
댓글 0개
이 문서에는 댓글을 달 수 없습니다.