POPBill Developers
연동신청
  • 가이드 0
  • 레퍼런스 0
  • 오류코드 0
카카오톡
  • 전자세금계산서
  • 현금영수증
  • 전자명세서
  • 홈택스수집(세금)
  • 홈택스수집(현금)
  • 사업자등록상태조회
  • 기업정보조회
  • 계좌조회
  • 예금주조회
  • 카카오톡
  • 문자
  • 팩스
Python
  • Java
  • PHP
  • .NET
  • .NET Core
  • Node.js
  • Python
  • Ruby
  • ASP
  • Delphi
  • PowerBuilder
  • Visual Basic
  • MS Access
SDK 레퍼런스

브랜드 메시지 템플릿

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

def getBMSTemplateMgtURL(corpNum, userID):
요청
Parameters
순번변수명타입길이필수설명
corpNum str 10 Y 팝빌회원 사업자번호 ('-' 제외)
userID str 50 Y 팝빌회원 아이디
응답

str - 요청에 대한 응답 URL

예외
PopbillException

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

  • 브랜드 메시지 템플릿 정보를 확인합니다.
def getBMSTemplate(corpNum, templateCode, userID=None):
요청
Parameters
순번변수명타입길이필수설명
corpNum str 10 Y 팝빌회원 사업자번호 ('-' 제외)
templateCode str 12 Y 템플릿 코드
userID str 50 N 팝빌회원 아이디
응답
BMSTemplate
순번 변수명 타입 길이 설명
templateCode str 12 템플릿 코드
templateType str 4 템플릿 유형
BMST브랜드 메시지 텍스트
BMSI브랜드 메시지 이미지
BMSW브랜드 메시지 와이드
BMSL브랜드 메시지 리스트
BMSC브랜드 메시지 캐러셀
BMSM브랜드 메시지 커머스
BMSA브랜드 메시지 캐러셀 커머스
templateName str 200 템플릿 제목
content str 1,300 템플릿 내용
plusFriendID str 30 검색용 아이디
adultYN bool - 성인용 메시지 여부
header str 20 제목
addContent str 34 부가메시지
imageUrl str - 이미지 URL
state int - 템플릿 상태
  • 1사용
  • 3차단
stateDT str 14 템플릿 상태 일시
형식 : yyyyMMddHHmmss
item list[KakaoItem] 20 아이템 목록
순번 변수명 타입 길이 설명
title str 30 타이틀
imageUrl str 500 이미지 URL
linkMobile str 1,000 Mobile 웹링크
linkPc str 1,000 PC 웹링크
linkAndroid str 1,000 Android 앱링크
linkIos str 1,000 iOS 앱링크
commerce KakaoCommerce - 커머스 정보
순번 변수명 타입 길이 설명
title str 30 상품명
regularPrice int - 정상가격
0 ~ 99,999,999
discountType str - 할인유형
R할인율
F할인금액
discountPrice int - 할인가격
0 ~ 99,999,999
discount int - 할인율/할인금액
head KakaoCarouselHead - 캐러셀 인트로
순번 변수명 타입 길이 설명
header str 20 제목
content str 50 내용
imageUrl str 500 이미지 URL
linkMobile str 1,000 Mobile 웹링크
linkPc str 1,000 PC 웹링크
linkAndroid str 1,000 Android 앱링크
linkIos str 1,000 iOS 앱링크
순번 변수명 타입 길이 설명
순번 변수명 타입 길이 설명
순번 변수명 타입 길이 설명
순번 변수명 타입 길이 설명
tail KakaoCarouselTail - 캐러셀 더보기
순번 변수명 타입 길이 설명
linkMobile str 1,000 Mobile 웹링크
linkPc str 1,000 PC 웹링크
linkAndroid str 1,000 Android 앱링크
linkIos str 1,000 iOS 앱링크
btns list[KakaoButton] 5 버튼 목록
순번 변수명 타입 길이 설명
n str 14 버튼명
t str 2 버튼유형
  • WL웹링크
  • AL앱링크
  • MD메시지전달
  • BK봇키워드
  • AC채널추가
u1 str 1,000 버튼링크
- {t} = "AL" 경우 iOS 앱링크 적용
- {t} = "WL" 경우 Mobile 웹링크 적용
u2 str 1,000 버튼링크
- {t} = "AL" 경우 Android 앱링크 적용
- {t} = "WL" 경우 PC 웹링크 적용
coupon KakaoCoupon - 쿠폰
순번 변수명 타입 길이 설명
title str 15 쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
description str 12 쿠폰 설명
linkMobile str 1,000 Mobile 웹링크
linkPc str 1,000 PC 웹링크
linkAndroid str 1,000 Android 앱링크
linkIos str 1,000 iOS 앱링크
예외
PopbillException

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

  • "사용" 상태의 브랜드 메시지 템플릿 목록을 확인합니다.
def listBMSTemplate(corpNum, userID=None):
요청
Parameters
순번변수명타입길이필수설명
corpNum str 10 Y 팝빌회원 사업자번호 ('-' 제외)
userID str 50 N 팝빌회원 아이디
응답
BMSTemplate[ ]
순번 변수명 타입 길이 설명
templateCode str 12 템플릿 코드
templateType str 4 템플릿 유형
BMST브랜드 메시지 텍스트
BMSI브랜드 메시지 이미지
BMSW브랜드 메시지 와이드
BMSL브랜드 메시지 리스트
BMSC브랜드 메시지 캐러셀
BMSM브랜드 메시지 커머스
BMSA브랜드 메시지 캐러셀 커머스
templateName str 200 템플릿 제목
content str 1,300 템플릿 내용
plusFriendID str 30 검색용 아이디
adultYN bool - 성인용 메시지 여부
header str 20 제목
addContent str 34 부가메시지
imageUrl str - 이미지 URL
state int - 템플릿 상태
  • 1사용
stateDT str 14 템플릿 상태 일시
형식 : yyyyMMddHHmmss
item list[KakaoItem] 20 아이템 목록
순번 변수명 타입 길이 설명
title str 30 타이틀
imageUrl str 500 이미지 URL
linkMobile str 1,000 Mobile 웹링크
linkPc str 1,000 PC 웹링크
linkAndroid str 1,000 Android 앱링크
linkIos str 1,000 iOS 앱링크
commerce KakaoCommerce - 커머스 정보
순번 변수명 타입 길이 설명
title str 30 상품명
regularPrice int - 정상가격
0 ~ 99,999,999
discountType str - 할인유형
R할인율
F할인금액
discountPrice int - 할인가격
0 ~ 99,999,999
discount int - 할인율/할인금액
head KakaoCarouselHead - 캐러셀 인트로
순번 변수명 타입 길이 설명
header str 20 제목
content str 50 내용
imageUrl str 500 이미지 URL
linkMobile str 1,000 Mobile 웹링크
linkPc str 1,000 PC 웹링크
linkAndroid str 1,000 Android 앱링크
linkIos str 1,000 iOS 앱링크
순번 변수명 타입 길이 설명
순번 변수명 타입 길이 설명
순번 변수명 타입 길이 설명
순번 변수명 타입 길이 설명
tail KakaoCarouselTail - 캐러셀 더보기
순번 변수명 타입 길이 설명
linkMobile str 1,000 Mobile 웹링크
linkPc str 1,000 PC 웹링크
linkAndroid str 1,000 Android 앱링크
linkIos str 1,000 iOS 앱링크
btns list[KakaoButton] 5 버튼 목록
순번 변수명 타입 길이 설명
n str 14 버튼명
t str 2 버튼유형
  • WL웹링크
  • AL앱링크
  • MD메시지전달
  • BK봇키워드
  • AC채널추가
u1 str 1,000 버튼링크
- {t} = "AL" 경우 iOS 앱링크 적용
- {t} = "WL" 경우 Mobile 웹링크 적용
u2 str 1,000 버튼링크
- {t} = "AL" 경우 Android 앱링크 적용
- {t} = "WL" 경우 PC 웹링크 적용
coupon KakaoCoupon - 쿠폰
순번 변수명 타입 길이 설명
title str 15 쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
description str 12 쿠폰 설명
linkMobile str 1,000 Mobile 웹링크
linkPc str 1,000 PC 웹링크
linkAndroid str 1,000 Android 앱링크
linkIos str 1,000 iOS 앱링크
예외
PopbillException