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

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

SDK 레퍼런스

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

팝빌의
SDK 다운로드
API 레퍼런스

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

고객지원

API 연동 중 발생하는 문제는
팝빌에서 해결을 도와드립니다.

팝빌의
서비스 제안서 수많은 기업이
선택한 팝빌
SDK 레퍼런스
카카오톡
Node.js
SDK 레퍼런스 카카오톡 Node.js 브랜드 메시지 템플릿

브랜드 메시지 템플릿

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

  • 브랜드 메시지 템플릿을 관리하는 팝업 URL을 반환합니다.
  • 권장 사이즈 : width = 1,000px (최소 1,000px) / height = 800px
  • 반환되는 URL은 30초 동안만 사용이 가능합니다.
  • 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.
kakaoService.getBMSTemplateMgtURL(CorpNum, UserID, success, error)
요청
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
UserID string 50 Y 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
응답

string - 요청에 대한 응답 URL

예외
PopbillException

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

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

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

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