브랜드 메시지 템플릿

1. GetBMSTemplateMgtURL - 브랜드 메시지 템플릿 관리 팝업 URL

미리보기

브랜드 메시지 템플릿을 관리하는 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 1,000px (최소 1,000px) / height = 800px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

string GetBMSTemplateMgtURL(string CorpNum, string UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	UserID	string	50	Y	팝빌회원 아이디

응답

string - 요청에 대한 응답 URL

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	Message	string	-	API 처리 실패에 대한 오류메시지

2. GetBMSTemplate - 브랜드 메시지 템플릿 정보 확인

브랜드 메시지 템플릿 정보를 확인합니다.

BMSTemplate GetBMSTemplate(string CorpNum, string TemplateCode, string UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	TemplateCode	string	12	Y	템플릿 코드
3	UserID	string	50	N	팝빌회원 아이디

응답

BMSTemplate

순번	변수명	타입	길이	설명
1	templateCode	string	12	템플릿 코드
2	templateType	string	4	템플릿 유형 BMST 브랜드 메시지 텍스트 BMSI 브랜드 메시지 이미지 BMSW 브랜드 메시지 와이드 BMSL 브랜드 메시지 리스트 BMSC 브랜드 메시지 캐러셀 BMSM 브랜드 메시지 커머스 BMSA 브랜드 메시지 캐러셀 커머스
3	templateName	string	200	템플릿 제목
4	content	string	1,300	템플릿 내용
5	plusFriendID	string	30	검색용 아이디
6	adultYN	bool?	-	성인용 메시지 여부
7	header	string	20	제목
8	addContent	string	34	부가메시지
9	imageUrl	string	-	이미지 URL
10	imageLink	string	500	이미지 링크 URL
11	state	int	-	템플릿 상태 1 사용 3 차단
12	stateDT	string	14	템플릿 상태 일시 → 형식 : yyyyMMddHHmmss
13	item	List<KakaoItem>	20	아이템 목록
List<KakaoItem> 순번 변수명 타입 길이 설명 1 title string 30 타이틀 2 imageUrl string 500 이미지 URL 3 linkMobile string 1,000 Mobile 웹링크 4 linkPc string 1,000 PC 웹링크 5 linkAndroid string 1,000 Android 앱링크 6 linkIos string 1,000 iOS 앱링크
14	commerce	KakaoCommerce	-	커머스 정보
KakaoCommerce 순번 변수명 타입 길이 설명 1 title string 30 상품명 2 regularPrice int? - 정상가격 → 0 ~ 99,999,999 3 discountType string 1 할인유형 R 할인율 F 할인금액 4 discount int? - 할인율/할인금액 → {discountType}="R" 경우 1 ~ 100 {discountType}="F" 경우 0 ~ 999,999 5 discountPrice int? - 할인가격 → 0 ~ 99,999,999 할인 적용 후 최종 가격
15	head	KakaoCarouselHead	-	캐러셀 인트로
KakaoCarouselHead 순번 변수명 타입 길이 설명 1 header string 20 제목 2 content string 50 내용 3 imageUrl string 500 이미지 URL 4 linkMobile string 1,000 Mobile 웹링크 5 linkPc string 1,000 PC 웹링크 6 linkAndroid string 1,000 Android 앱링크 7 linkIos string 1,000 iOS 앱링크
16	carousel	List<KakaoCarousel>	6	캐러셀 목록
List<KakaoCarousel> 순번 변수명 타입 길이 설명 1 header string 20 제목 2 content string 180 내용 3 imageUrl string 500 이미지 URL 4 imageLink string 500 이미지 링크 URL → 이미지를 클릭하면 연결되는 URL 5 addContent string 34 부가메시지 6 commerce KakaoCommerce - 커머스 정보 KakaoCommerce 순번 변수명 타입 길이 설명 1 title string 30 상품명 2 regularPrice int? - 정상가격 → 0 ~ 99,999,999 3 discountType string 1 할인유형 R 할인율 F 할인금액 4 discount int? - 할인율/할인금액 → {discountType}="R" 경우 1 ~ 100 {discountType}="F" 경우 0 ~ 999,999 5 discountPrice int? - 할인가격 → 0 ~ 99,999,999 할인 적용 후 최종 가격 7 btns List<KakaoButton> 2 버튼 목록 List<KakaoButton> 순번 변수명 타입 길이 설명 1 n string 8 버튼명 2 t string 2 버튼유형 WL 웹링크 AL 앱링크 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 string 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 string 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 8 coupon KakaoCoupon - 쿠폰 KakaoCoupon 순번 변수명 타입 길이 설명 1 title string 15 쿠폰 제목 #{숫자}원 할인 쿠폰 (숫자 : 1~99,999,999) #{숫자}% 할인 쿠폰 (숫자 : 1~100) 배송비 할인 쿠폰 #{7자 이내} 무료 쿠폰 #{7자 이내} UP 쿠폰 2 description string 12 쿠폰 설명 → 줄바꿈 사용 불가 3 linkMobile string 1,000 Mobile 웹링크 4 linkPc string 1,000 PC 웹링크 5 linkAndroid string 1,000 Android 앱링크 6 linkIos string 1,000 iOS 앱링크
17	tail	KakaoCarouselTail	-	캐러셀 더보기
KakaoCarouselTail 순번 변수명 타입 길이 설명 1 linkMobile string 1,000 Mobile 웹링크 2 linkPc string 1,000 PC 웹링크 3 linkAndroid string 1,000 Android 앱링크 4 linkIos string 1,000 iOS 앱링크
18	btns	List<KakaoButton>	5	버튼 목록
List<KakaoButton> 순번 변수명 타입 길이 설명 1 n string 14 버튼명 2 t string 2 버튼유형 WL 웹링크 AL 앱링크 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 string 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 string 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용
19	coupon	KakaoCoupon	-	쿠폰
KakaoCoupon 순번 변수명 타입 길이 설명 1 title string 15 쿠폰 제목 #{숫자}원 할인 쿠폰 (숫자 : 1~99,999,999) #{숫자}% 할인 쿠폰 (숫자 : 1~100) 배송비 할인 쿠폰 #{7자 이내} 무료 쿠폰 #{7자 이내} UP 쿠폰 2 description string 12 쿠폰 설명 → 줄바꿈 사용 불가 3 linkMobile string 1,000 Mobile 웹링크 4 linkPc string 1,000 PC 웹링크 5 linkAndroid string 1,000 Android 앱링크 6 linkIos string 1,000 iOS 앱링크

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	Message	string	-	API 처리 실패에 대한 오류메시지

3. ListBMSTemplate - 브랜드 메시지 템플릿 목록 확인

“사용” 상태의 브랜드 메시지 템플릿 목록을 확인합니다.

List<BMSTemplate> ListBMSTemplate(string CorpNum, string UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	UserID	string	50	N	팝빌회원 아이디

응답

List<BMSTemplate>

순번	변수명	타입	길이	설명
1	templateCode	string	12	템플릿 코드
2	templateType	string	4	템플릿 유형 BMST 브랜드 메시지 텍스트 BMSI 브랜드 메시지 이미지 BMSW 브랜드 메시지 와이드 BMSL 브랜드 메시지 리스트 BMSC 브랜드 메시지 캐러셀 BMSM 브랜드 메시지 커머스 BMSA 브랜드 메시지 캐러셀 커머스
3	templateName	string	200	템플릿 제목
4	content	string	1,300	템플릿 내용
5	plusFriendID	string	30	검색용 아이디
6	adultYN	bool?	-	성인용 메시지 여부
7	header	string	20	제목
8	addContent	string	34	부가메시지
9	imageUrl	string	-	이미지 URL
10	imageLink	string	500	이미지 링크 URL
11	state	int	-	템플릿 상태 1 사용
12	stateDT	string	14	템플릿 상태 일시 → 형식 : yyyyMMddHHmmss
13	item	List<KakaoItem>	20	아이템 목록
List<KakaoItem> 순번 변수명 타입 길이 설명 1 title string 30 타이틀 2 imageUrl string 500 이미지 URL 3 linkMobile string 1,000 Mobile 웹링크 4 linkPc string 1,000 PC 웹링크 5 linkAndroid string 1,000 Android 앱링크 6 linkIos string 1,000 iOS 앱링크
14	commerce	KakaoCommerce	-	커머스 정보
KakaoCommerce 순번 변수명 타입 길이 설명 1 title string 30 상품명 2 regularPrice int? - 정상가격 → 0 ~ 99,999,999 3 discountType string 1 할인유형 R 할인율 F 할인금액 4 discount int? - 할인율/할인금액 → {discountType}="R" 경우 1 ~ 100 {discountType}="F" 경우 0 ~ 999,999 5 discountPrice int? - 할인가격 → 0 ~ 99,999,999 할인 적용 후 최종 가격
15	head	KakaoCarouselHead	-	캐러셀 인트로
KakaoCarouselHead 순번 변수명 타입 길이 설명 1 header string 20 제목 2 content string 50 내용 3 imageUrl string 500 이미지 URL 4 linkMobile string 1,000 Mobile 웹링크 5 linkPc string 1,000 PC 웹링크 6 linkAndroid string 1,000 Android 앱링크 7 linkIos string 1,000 iOS 앱링크
16	carousel	List<KakaoCarousel>	6	캐러셀 목록
List<KakaoCarousel> 순번 변수명 타입 길이 설명 1 header string 20 제목 2 content string 180 내용 3 imageUrl string 500 이미지 URL 4 imageLink string 500 이미지 링크 URL → 이미지를 클릭하면 연결되는 URL 5 addContent string 34 부가메시지 6 commerce KakaoCommerce - 커머스 정보 KakaoCommerce 순번 변수명 타입 길이 설명 1 title string 30 상품명 2 regularPrice int? - 정상가격 → 0 ~ 99,999,999 3 discountType string 1 할인유형 R 할인율 F 할인금액 4 discount int? - 할인율/할인금액 → {discountType}="R" 경우 1 ~ 100 {discountType}="F" 경우 0 ~ 999,999 5 discountPrice int? - 할인가격 → 0 ~ 99,999,999 할인 적용 후 최종 가격 7 btns List<KakaoButton> 2 버튼 목록 List<KakaoButton> 순번 변수명 타입 길이 설명 1 n string 8 버튼명 2 t string 2 버튼유형 WL 웹링크 AL 앱링크 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 string 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 string 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 8 coupon KakaoCoupon - 쿠폰 KakaoCoupon 순번 변수명 타입 길이 설명 1 title string 15 쿠폰 제목 #{숫자}원 할인 쿠폰 (숫자 : 1~99,999,999) #{숫자}% 할인 쿠폰 (숫자 : 1~100) 배송비 할인 쿠폰 #{7자 이내} 무료 쿠폰 #{7자 이내} UP 쿠폰 2 description string 12 쿠폰 설명 → 줄바꿈 사용 불가 3 linkMobile string 1,000 Mobile 웹링크 4 linkPc string 1,000 PC 웹링크 5 linkAndroid string 1,000 Android 앱링크 6 linkIos string 1,000 iOS 앱링크
17	tail	KakaoCarouselTail	-	캐러셀 더보기
KakaoCarouselTail 순번 변수명 타입 길이 설명 1 linkMobile string 1,000 Mobile 웹링크 2 linkPc string 1,000 PC 웹링크 3 linkAndroid string 1,000 Android 앱링크 4 linkIos string 1,000 iOS 앱링크
18	btns	List<KakaoButton>	5	버튼 목록
List<KakaoButton> 순번 변수명 타입 길이 설명 1 n string 14 버튼명 2 t string 2 버튼유형 WL 웹링크 AL 앱링크 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 string 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 string 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용
19	coupon	KakaoCoupon	-	쿠폰
KakaoCoupon 순번 변수명 타입 길이 설명 1 title string 15 쿠폰 제목 #{숫자}원 할인 쿠폰 (숫자 : 1~99,999,999) #{숫자}% 할인 쿠폰 (숫자 : 1~100) 배송비 할인 쿠폰 #{7자 이내} 무료 쿠폰 #{7자 이내} UP 쿠폰 2 description string 12 쿠폰 설명 → 줄바꿈 사용 불가 3 linkMobile string 1,000 Mobile 웹링크 4 linkPc string 1,000 PC 웹링크 5 linkAndroid string 1,000 Android 앱링크 6 linkIos string 1,000 iOS 앱링크

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	Message	string	-	API 처리 실패에 대한 오류메시지