SDK 레퍼런스 카카오톡 Python 브랜드 메시지 전송
1. SendBMSText - 텍스트 전송
- 카카오톡 채널을 추가한 사용자 또는 마케팅 정보 수신에 동의한 사용자에게 텍스트형 광고성 메시지를 전송합니다. (최대 1,000건)
- 비채널 친구에게 브랜드 메시지를 전송하기 위해서는 등록된 비즈니스 채널에 대해 브랜드 메시지 채널 신청이 필요합니다.
- 전송실패시 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
def sendBMSText(corpNum, bms, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
bms |
BMS |
- |
Y |
브랜드 메시지 정보
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
plusFriendID |
str |
30 |
Y |
검색용 아이디 |
|
targeting |
str |
1 |
Y |
전송대상
I채널 친구
N비채널 친구
M전체
|
|
adultYN |
bool |
- |
N |
성인용 메시지 여부
기본값 : false
동보 전송인 경우 입력
|
|
content |
str |
1,300 |
조건부 |
브랜드 메시지 내용
줄바꿈 최대 99회
동보 전송인 경우 필수
|
|
unsubscribeNo |
str |
13 |
조건부 |
080 수신거부 번호
{targeting}="N" or "M" 인 경우 필수
|
|
altYN |
bool |
- |
N |
대체문자 전송 여부
기본값 : false
|
|
sendNum |
str |
20 |
조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
|
|
altSubject |
str |
64 |
N |
대체문자 제목
대체문자 내용이 90byte 이상인 경우에만 적용
단위 : byte
동보 전송인 경우 입력
|
|
altContent |
str |
2,000 |
조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte
동보 전송인 경우 입력
|
|
altUnsubscribeNo |
str |
20 |
조건부 |
대체문자 080 수신거부 번호
대체문자 전송 시 필수
|
|
reserveDT |
str |
14 |
N |
전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50
기본값 : 즉시전송
|
|
requestNum |
str |
36 |
N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
|
|
btns |
list[KakaoButton] |
5 |
N |
버튼 목록
최대 5개 (쿠폰을 포함하는 경우 최대 4개)
동보 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
n |
str |
14 |
Y |
버튼명 |
|
t |
str |
2 |
Y |
버튼유형
- 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 |
- |
N |
쿠폰
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수
동보 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
15 |
Y |
쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
|
|
description |
str |
12 |
Y |
쿠폰 설명
줄바꿈 사용 불가
|
|
linkMobile |
str |
1,000 |
조건부 |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
조건부 |
Android 앱링크 |
|
linkIos |
str |
1,000 |
조건부 |
iOS 앱링크 |
|
|
receivers |
list[KakaoReceiver] |
1,000 |
Y |
수신자 목록
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
receiverNum |
str |
20 |
Y |
수신번호 |
|
receiverName |
str |
70 |
N |
수신자명 |
|
adultYN |
bool |
- |
N |
성인용 메시지 여부
기본값 : false
대량 전송인 경우 입력
|
|
content |
str |
1,300 |
조건부 |
브랜드 메시지 내용
줄바꿈 최대 99회
대량 전송인 경우 필수
|
|
altSubject |
str |
64 |
N |
대체문자 제목
대량전송 경우 사용
메시지 길이가 90byte 이상인 경우에만 적용
단위 : byte
대량 전송인 경우 입력
|
|
altContent |
str |
2,000 |
조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte
대량 전송인 경우 입력
|
|
interOPRefKey |
str |
20 |
N |
파트너 지정키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
|
btns |
list[KakaoButton] |
5 |
N |
버튼 목록
최대 5개 (쿠폰을 포함하는 경우 최대 4개)
대량 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
n |
str |
14 |
Y |
버튼명 |
|
t |
str |
2 |
Y |
버튼유형
- 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 |
- |
N |
쿠폰
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수
대량 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
15 |
Y |
쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
|
|
description |
str |
12 |
Y |
쿠폰 설명
줄바꿈 사용 불가
|
|
linkMobile |
str |
1,000 |
조건부 |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
조건부 |
Android 앱링크 |
|
linkIos |
str |
1,000 |
조건부 |
iOS 앱링크 |
|
|
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
str - 요청에 대한 접수번호(receiptNum)
예외
2-1. SendBMSImage - 이미지 전송
- 카카오톡 채널을 추가한 사용자 또는 마케팅 정보 수신에 동의한 사용자에게 이미지형 광고성 메시지를 전송합니다. (최대 1,000건)
- 비채널 친구에게 브랜드 메시지를 전송하기 위해서는 등록된 비즈니스 채널에 대해 브랜드 메시지 채널 신청이 필요합니다.
- 브랜드 메시지 전송 전에 [UploadImage - 이미지 업로드] API로 이미지 업로드가 필요합니다.
- 전송실패시 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
def sendBMSImage(corpNum, bms, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
bms |
BMS |
- |
Y |
브랜드 메시지 정보
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
plusFriendID |
str |
30 |
Y |
검색용 아이디 |
|
targeting |
str |
1 |
Y |
전송대상
I채널 친구
N비채널 친구
M전체
|
|
adultYN |
bool |
- |
N |
성인용 메시지 여부
기본값 : false
동보 전송인 경우 입력
|
|
imageUrl |
str |
500 |
조건부 |
이미지 URL
동보 전송인 경우 필수
|
|
imageLink |
str |
500 |
N |
이미지 링크 URL
이미지를 클릭하면 연결되는 URL
동보 전송인 경우 입력
|
|
content |
str |
1,300 |
조건부 |
브랜드 메시지 내용
줄바꿈 최대 99회
동보 전송인 경우 필수
|
|
unsubscribeNo |
str |
13 |
조건부 |
080 수신거부 번호
{targeting}="N" or "M" 인 경우 필수
|
|
altYN |
bool |
- |
N |
대체문자 전송 여부
기본값 : false
|
|
sendNum |
str |
20 |
조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
|
|
altSubject |
str |
64 |
N |
대체문자 제목
대체문자 내용이 90byte 이상인 경우에만 적용
단위 : byte
동보 전송인 경우 입력
|
|
altContent |
str |
2,000 |
조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte
동보 전송인 경우 입력
|
|
altUnsubscribeNo |
str |
20 |
조건부 |
대체문자 080 수신거부 번호
대체문자 전송 시 필수
|
|
reserveDT |
str |
14 |
N |
전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50
기본값 : 즉시전송
|
|
requestNum |
str |
36 |
N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
|
|
btns |
list[KakaoButton] |
5 |
N |
버튼 목록
최대 5개 (쿠폰을 포함하는 경우 최대 4개)
동보 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
n |
str |
14 |
Y |
버튼명 |
|
t |
str |
2 |
Y |
버튼유형
- 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 |
- |
N |
쿠폰
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수
동보 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
15 |
Y |
쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
|
|
description |
str |
12 |
Y |
쿠폰 설명
줄바꿈 사용 불가
|
|
linkMobile |
str |
1,000 |
조건부 |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
조건부 |
Android 앱링크 |
|
linkIos |
str |
1,000 |
조건부 |
iOS 앱링크 |
|
|
receivers |
list[KakaoReceiver] |
1,000 |
Y |
수신자 목록
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
receiverNum |
str |
20 |
Y |
수신번호 |
|
receiverName |
str |
70 |
N |
수신자명 |
|
imageUrl |
str |
500 |
조건부 |
이미지 URL
대량 전송인 경우 필수
|
|
imageLink |
str |
500 |
N |
이미지 링크 URL
이미지를 클릭하면 연결되는 URL
대량 전송인 경우 입력
|
|
adultYN |
bool |
- |
N |
성인용 메시지 여부
기본값 : false
대량 전송인 경우 입력
|
|
content |
str |
1,300 |
조건부 |
브랜드 메시지 내용
줄바꿈 최대 99회
대량 전송인 경우 필수
|
|
altSubject |
str |
64 |
N |
대체문자 제목
대량전송 경우 사용
메시지 길이가 90byte 이상인 경우에만 적용
단위 : byte
대량 전송인 경우 입력
|
|
altContent |
str |
2,000 |
조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte
대량 전송인 경우 입력
|
|
interOPRefKey |
str |
20 |
N |
파트너 지정키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
|
btns |
list[KakaoButton] |
5 |
N |
버튼 목록
최대 5개 (쿠폰을 포함하는 경우 최대 4개)
대량 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
n |
str |
14 |
Y |
버튼명 |
|
t |
str |
2 |
Y |
버튼유형
- 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 |
- |
N |
쿠폰
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수
대량 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
15 |
Y |
쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
|
|
description |
str |
12 |
Y |
쿠폰 설명
줄바꿈 사용 불가
|
|
linkMobile |
str |
1,000 |
조건부 |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
조건부 |
Android 앱링크 |
|
linkIos |
str |
1,000 |
조건부 |
iOS 앱링크 |
|
|
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
str - 요청에 대한 접수번호(receiptNum)
예외
2-2. UploadImage - 이미지 업로드
- 브랜드 메시지 전송에 사용할 이미지를 업로드합니다.
def uploadImage(corpNum, filePath, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
filePath |
str |
- |
Y |
이미지 파일 경로
가로:세로 비율제한 - 2:1이상 3:4이하
권장 사이즈 - 800*400px(가로 500px 이상)
파일형식 및 크기 - jpg, png / 최대 5MB
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
str - 이미지 URL(imageUrl)
예외
2-3. UploadImageBinary - 이미지 업로드 (바이너리)
- 브랜드 메시지 전송에 사용할 바이너리 형식의 이미지를 업로드합니다.
def uploadImageBinary(corpNum, file, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
file |
BinaryFile |
- |
Y |
이미지 파일
가로:세로 비율제한 - 2:1이상 3:4이하
권장 사이즈 - 800*400px(가로 500px 이상)
파일형식 및 크기 - jpg, png / 최대 5MB
|
|
userID |
String |
50 |
N |
팝빌회원 아이디 |
응답
str - 이미지 URL(imageUrl)
예외
3-1. SendBMSWideImage - 와이드 이미지 전송
- 카카오톡 채널을 추가한 사용자 또는 마케팅 정보 수신에 동의한 사용자에게 와이드 이미지형 광고성 메시지를 전송합니다. (최대 1,000건)
- 비채널 친구에게 브랜드 메시지를 전송하기 위해서는 등록된 비즈니스 채널에 대해 브랜드 메시지 채널 신청이 필요합니다.
- 브랜드 메시지 전송 전에 [UploadWideImage - 와이드형 이미지 업로드] API로 이미지 업로드가 필요합니다.
- 전송실패시 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
def sendBMSWideImage(corpNum, bms, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
bms |
BMS |
- |
Y |
브랜드 메시지 정보
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
plusFriendID |
str |
30 |
Y |
검색용 아이디 |
|
targeting |
str |
1 |
Y |
전송대상
I채널 친구
N비채널 친구
M전체
|
|
adultYN |
bool |
- |
N |
성인용 메시지 여부
기본값 : false
동보 전송인 경우 입력
|
|
imageUrl |
str |
500 |
조건부 |
이미지 URL
동보 전송인 경우 필수
|
|
imageLink |
str |
500 |
N |
이미지 링크 URL
이미지를 클릭하면 연결되는 URL
동보 전송인 경우 입력
|
|
content |
str |
76 |
조건부 |
브랜드 메시지 내용
줄바꿈 최대 5회
동보 전송인 경우 필수
|
|
unsubscribeNo |
str |
13 |
조건부 |
080 수신거부 번호
{targeting}="N" or "M" 인 경우 필수
|
|
altYN |
bool |
- |
N |
대체문자 전송 여부
기본값 : false
|
|
sendNum |
str |
20 |
조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
|
|
altSubject |
str |
64 |
N |
대체문자 제목
대체문자 내용이 90byte 이상인 경우에만 적용
단위 : byte
동보 전송인 경우 입력
|
|
altContent |
str |
2,000 |
조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte
동보 전송인 경우 입력
|
|
altUnsubscribeNo |
str |
20 |
조건부 |
대체문자 080 수신거부 번호
대체문자 전송 시 필수
|
|
reserveDT |
str |
14 |
N |
전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50
기본값 : 즉시전송
|
|
requestNum |
str |
36 |
N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
|
|
btns |
list[KakaoButton] |
2 |
N |
버튼 목록
최대 2개
동보 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
n |
str |
8 |
Y |
버튼명 |
|
t |
str |
2 |
Y |
버튼유형
- 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 |
- |
N |
쿠폰
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수
동보 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
15 |
Y |
쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
|
|
description |
str |
18 |
Y |
쿠폰 설명
줄바꿈 사용 불가
|
|
linkMobile |
str |
1,000 |
조건부 |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
조건부 |
Android 앱링크 |
|
linkIos |
str |
1,000 |
조건부 |
iOS 앱링크 |
|
|
receivers |
list[KakaoReceiver] |
1,000 |
Y |
수신자 목록
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
receiverNum |
str |
20 |
Y |
수신번호 |
|
receiverName |
str |
70 |
N |
수신자명 |
|
imageUrl |
str |
500 |
조건부 |
이미지 URL
대량 전송인 경우 필수
|
|
imageLink |
str |
500 |
N |
이미지 링크 URL
이미지를 클릭하면 연결되는 URL
대량 전송인 경우 입력
|
|
adultYN |
bool |
- |
N |
성인용 메시지 여부
기본값 : false
대량 전송인 경우 입력
|
|
content |
str |
76 |
조건부 |
브랜드 메시지 내용
줄바꿈 최대 5회
대량 전송인 경우 필수
|
|
altSubject |
str |
64 |
N |
대체문자 제목
대량전송 경우 사용
메시지 길이가 90byte 이상인 경우에만 적용
단위 : byte
대량 전송인 경우 입력
|
|
altContent |
str |
2,000 |
조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte
대량 전송인 경우 입력
|
|
interOPRefKey |
str |
20 |
N |
파트너 지정키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
|
btns |
list[KakaoButton] |
2 |
N |
버튼 목록
최대 2개
대량 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
n |
str |
8 |
Y |
버튼명 |
|
t |
str |
2 |
Y |
버튼유형
- 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 |
- |
N |
쿠폰
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수
대량 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
15 |
Y |
쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
|
|
description |
str |
18 |
Y |
쿠폰 설명
줄바꿈 사용 불가
|
|
linkMobile |
str |
1,000 |
조건부 |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
조건부 |
Android 앱링크 |
|
linkIos |
str |
1,000 |
조건부 |
iOS 앱링크 |
|
|
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
str - 요청에 대한 접수번호(receiptNum)
예외
3-2. UploadWideImage - 와이드 이미지 업로드
- 브랜드 메시지 와이드 이미지 전송에 사용할 이미지를 업로드합니다.
def uploadWideImage(corpNum, filePath, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
filePath |
str |
- |
Y |
이미지 파일 경로
가로:세로 비율제한 - 2:1이상 1:1이하
권장 사이즈 - 800*600px(가로 500px 이상)
파일형식 및 크기 - jpg, png / 최대 5MB
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
str - 이미지 URL(imageUrl)
예외
3-3. UploadWideImageBinary - 와이드 이미지 업로드 (바이너리)
- 브랜드 메시지 와이드 이미지 전송에 사용할 바이너리 형식의 이미지를 업로드합니다.
def uploadWideImageBinary(corpNum, file, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
file |
BinaryFile |
- |
Y |
이미지 파일
가로:세로 비율제한 - 2:1이상 1:1이하
권장 사이즈 - 800*600px(가로 500px 이상)
파일형식 및 크기 - jpg, png / 최대 5MB
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
str - 이미지 URL(imageUrl)
예외
4-1. SendBMSWideList - 리스트 전송
- 카카오톡 채널을 추가한 사용자 또는 마케팅 정보 수신에 동의한 사용자에게 와이드 리스트형 광고성 메시지를 전송합니다. (최대 1,000건)
- 비채널 친구에게 브랜드 메시지를 전송하기 위해서는 등록된 비즈니스 채널에 대해 브랜드 메시지 채널 신청이 필요합니다.
- 전송실패시 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
def sendBMSWideList(corpNum, bms, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
bms |
BMS |
- |
Y |
브랜드 메시지 정보
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
plusFriendID |
str |
30 |
Y |
검색용 아이디 |
|
targeting |
str |
1 |
Y |
전송대상
I채널 친구
N비채널 친구
M전체
|
|
adultYN |
bool |
- |
N |
성인용 메시지 여부
기본값 : false
동보 전송인 경우 입력
|
|
unsubscribeNo |
str |
13 |
조건부 |
080 수신거부 번호
{targeting}="N" or "M" 인 경우 필수
|
|
altYN |
bool |
- |
N |
대체문자 전송 여부
기본값 : false
|
|
sendNum |
str |
20 |
조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
|
|
altSubject |
str |
64 |
N |
대체문자 제목
대체문자 내용이 90byte 이상인 경우에만 적용
단위 : byte
동보 전송인 경우 입력
|
|
altContent |
str |
2,000 |
조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte
동보 전송인 경우 입력
|
|
altUnsubscribeNo |
str |
20 |
조건부 |
대체문자 080 수신거부 번호
대체문자 전송 시 필수
|
|
reserveDT |
str |
14 |
N |
전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50
기본값 : 즉시전송
|
|
requestNum |
str |
36 |
N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
|
|
item |
list[KakaoItem] |
4 |
조건부 |
아이템 목록
최소 3개, 최대 4개
동보 전송인 경우 필수
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
30 |
Y |
타이틀
메인 아이템은 최대 25자, 서브 아이템은 30자
줄바꿈 최대 1개
|
|
imageUrl |
str |
500 |
Y |
이미지 URL
|
|
linkMobile |
str |
1,000 |
Y |
Mobile 웹링크
|
|
linkPc |
str |
1,000 |
N |
PC 웹링크
|
|
linkAndroid |
str |
1,000 |
N |
Android 앱링크
|
|
linkIos |
str |
1,000 |
N |
iOS 앱링크
|
|
|
btns |
list[KakaoButton] |
2 |
N |
버튼 목록
최대 2개
동보 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
n |
str |
8 |
Y |
버튼명 |
|
t |
str |
2 |
Y |
버튼유형
- 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 |
- |
N |
쿠폰
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수
동보 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
15 |
Y |
쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
|
|
description |
str |
18 |
Y |
쿠폰 설명
줄바꿈 사용 불가
|
|
linkMobile |
str |
1,000 |
조건부 |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
조건부 |
Android 앱링크 |
|
linkIos |
str |
1,000 |
조건부 |
iOS 앱링크 |
|
|
receivers |
list[KakaoReceiver] |
1,000 |
Y |
수신자 목록
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
receiverNum |
str |
20 |
Y |
수신번호 |
|
receiverName |
str |
70 |
N |
수신자명 |
|
adultYN |
bool |
- |
N |
성인용 메시지 여부
기본값 : false
대량 전송인 경우 입력
|
|
altSubject |
str |
64 |
N |
대체문자 제목
대량전송 경우 사용
메시지 길이가 90byte 이상인 경우에만 적용
단위 : byte
대량 전송인 경우 입력
|
|
altContent |
str |
2,000 |
조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte
대량 전송인 경우 입력
|
|
interOPRefKey |
str |
20 |
N |
파트너 지정키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
|
item |
list[KakaoItem] |
4 |
조건부 |
아이템 목록
최소 3개, 최대 4개
대량 전송인 경우 필수
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
30 |
Y |
타이틀
메인 아이템은 최대 25자, 서브 아이템은 30자
줄바꿈 최대 1개
|
|
imageUrl |
str |
500 |
Y |
이미지 URL
|
|
linkMobile |
str |
1,000 |
Y |
Mobile 웹링크
|
|
linkPc |
str |
1,000 |
N |
PC 웹링크
|
|
linkAndroid |
str |
1,000 |
N |
Android 앱링크
|
|
linkIos |
str |
1,000 |
N |
iOS 앱링크
|
|
|
btns |
list[KakaoButton] |
2 |
N |
버튼 목록
최대 2개
대량 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
n |
str |
8 |
Y |
버튼명 |
|
t |
str |
2 |
Y |
버튼유형
- 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 |
- |
N |
쿠폰
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수
대량 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
15 |
Y |
쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
|
|
description |
str |
18 |
Y |
쿠폰 설명
줄바꿈 사용 불가
|
|
linkMobile |
str |
1,000 |
조건부 |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
조건부 |
Android 앱링크 |
|
linkIos |
str |
1,000 |
조건부 |
iOS 앱링크 |
|
|
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
str - 요청에 대한 접수번호(receiptNum)
예외
4-2. UploadWideListMainImage - 리스트 메인 이미지 업로드
- 브랜드 메시지 리스트 전송에 사용할 메인 이미지를 업로드합니다.
def uploadWideListMainImage(corpNum, filePath, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
filePath |
str |
- |
Y |
이미지 파일 경로
가로:세로 비율제한 - 고정비율 2:1
권장 사이즈 800*400px(가로 500px 이상)
파일형식 및 크기 - jpg, png / 최대 5MB
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
str - 이미지 URL(imageUrl)
예외
4-3. UploadWideListMainImageBinary - 리스트 메인 이미지 업로드 (바이너리)
- 브랜드 메시지 리스트 전송에 사용할 바이너리 형식의 메인 이미지를 업로드합니다.
def uploadWideListMainImageBinary(corpNum, file, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
file |
BinaryFile |
- |
Y |
이미지 파일
가로:세로 비율제한 - 고정비율 2:1
권장 사이즈 800*400px(가로 500px 이상)
파일형식 및 크기 - jpg, png / 최대 5MB
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
str - 이미지 URL(imageUrl)
예외
4-4. UploadWideListImage - 리스트 서브 이미지 업로드
- 브랜드 메시지 리스트 전송에 사용할 서브 이미지를 업로드합니다.
def uploadWideListMainImage(corpNum, filePath, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
filePath |
list |
3 |
Y |
이미지 파일 경로
가로:세로 비율제한 - 1:1 고정비율
권장 사이즈 - 800*800px(가로 500px 이상)
파일형식 및 크기 - jpg, png / 최대 5MB
업로드 요청 최대 파일수 - 3개
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
예외
4-5. UploadWideListImageBinary - 리스트 서브 이미지 업로드 (바이너리)
- 브랜드 메시지 리스트 전송에 사용할 바이너리 형식의 서브 이미지를 업로드합니다.
def uploadWideListImageBinary(corpNum, file, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
file |
BinaryFile[ ] |
3 |
Y |
이미지 파일
가로:세로 비율제한 - 1:1 고정비율
권장 사이즈 - 800*800px(가로 500px 이상)
파일형식 및 크기 - jpg, png / 최대 5MB
업로드 요청 최대 파일수 - 3개
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
예외
5-1. SendBMSCarouselFeed - 캐러셀 전송
- 카카오톡 채널을 추가한 사용자 또는 마케팅 정보 수신에 동의한 사용자에게 캐러셀 피드형 광고성 메시지를 전송합니다. (최대 1,000건)
- 비채널 친구에게 브랜드 메시지를 전송하기 위해서는 등록된 비즈니스 채널에 대해 브랜드 메시지 채널 신청이 필요합니다.
- 전송실패시 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
def sendBMSCarouselFeed(corpNum, bms, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
bms |
BMS |
- |
Y |
브랜드 메시지 정보
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
plusFriendID |
str |
30 |
Y |
검색용 아이디 |
|
targeting |
str |
1 |
Y |
전송대상
I채널 친구
N비채널 친구
M전체
|
|
adultYN |
bool |
- |
N |
성인용 메시지 여부
기본값 : false
동보 전송인 경우 입력
|
|
unsubscribeNo |
str |
13 |
조건부 |
080 수신거부 번호
{targeting}="N" or "M" 인 경우 필수
|
|
altYN |
bool |
- |
N |
대체문자 전송 여부
기본값 : false
|
|
sendNum |
str |
20 |
조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
|
|
altSubject |
str |
64 |
N |
대체문자 제목
대체문자 내용이 90byte 이상인 경우에만 적용
단위 : byte
동보 전송인 경우 입력
|
|
altContent |
str |
2,000 |
조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte
동보 전송인 경우 입력
|
|
altUnsubscribeNo |
str |
20 |
조건부 |
대체문자 080 수신거부 번호
대체문자 전송 시 필수
|
|
reserveDT |
str |
14 |
N |
전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50
기본값 : 즉시전송
|
|
requestNum |
str |
36 |
N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
|
|
carousel |
list[KakaoCarousel] |
6 |
조건부 |
캐러셀 목록
최소 2개, 최대 6개
동보 전송인 경우 필수
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
content |
str |
180 |
Y |
내용 |
|
imageUrl |
str |
500 |
Y |
이미지 URL
|
|
imageLink |
str |
500 |
N |
이미지 링크 URL 이미지를 클릭하면 연결되는 URL |
|
btns |
list[KakaoButton] |
2 |
N |
버튼 목록
최소 1개, 최대 2개
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
n |
str |
8 |
Y |
버튼명 |
|
t |
str |
2 |
Y |
버튼유형
- 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 |
- |
N |
쿠폰
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
15 |
Y |
쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
|
|
description |
str |
12 |
Y |
쿠폰 설명
줄바꿈 사용 불가
|
|
linkMobile |
str |
1,000 |
조건부 |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
조건부 |
Android 앱링크 |
|
linkIos |
str |
1,000 |
조건부 |
iOS 앱링크 |
|
|
|
tail |
KakaoCarouselTail |
- |
N |
캐러셀 더보기
동보 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
linkMobile |
str |
1,000 |
Y |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
N |
Android 앱링크 |
|
linkIos |
str |
1,000 |
N |
iOS 앱링크 |
|
|
receivers |
list[KakaoReceiver] |
1,000 |
Y |
수신자 목록
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
receiverNum |
str |
20 |
Y |
수신번호 |
|
receiverName |
str |
70 |
N |
수신자명 |
|
adultYN |
bool |
- |
N |
성인용 메시지 여부
기본값 : false
대량 전송인 경우 입력
|
|
altSubject |
str |
64 |
N |
대체문자 제목
대량전송 경우 사용
메시지 길이가 90byte 이상인 경우에만 적용
단위 : byte
대량 전송인 경우 입력
|
|
altContent |
str |
2,000 |
조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte
대량 전송인 경우 입력
|
|
interOPRefKey |
str |
20 |
N |
파트너 지정키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
|
carousel |
list[KakaoCarousel] |
6 |
조건부 |
캐러셀 목록
최소 2개, 최대 6개
대량 전송인 경우 필수
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
content |
str |
180 |
Y |
내용 |
|
imageUrl |
str |
500 |
Y |
이미지 URL
|
|
imageLink |
str |
500 |
N |
이미지 링크 URL 이미지를 클릭하면 연결되는 URL |
|
btns |
list[KakaoButton] |
2 |
N |
버튼 목록
최소 1개, 최대 2개
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
n |
str |
8 |
Y |
버튼명 |
|
t |
str |
2 |
Y |
버튼유형
- 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 |
- |
N |
쿠폰
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
15 |
Y |
쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
|
|
description |
str |
12 |
Y |
쿠폰 설명
줄바꿈 사용 불가
|
|
linkMobile |
str |
1,000 |
조건부 |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
조건부 |
Android 앱링크 |
|
linkIos |
str |
1,000 |
조건부 |
iOS 앱링크 |
|
|
|
tail |
KakaoCarouselTail |
- |
N |
캐러셀 더보기
대량 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
linkMobile |
str |
1,000 |
Y |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
N |
Android 앱링크 |
|
linkIos |
str |
1,000 |
N |
iOS 앱링크 |
|
|
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
str - 요청에 대한 접수번호(receiptNum)
예외
5-2. UploadCarouselFeedImage - 캐러셀 이미지 업로드
- 브랜드 메시지 캐러셀 전송에 사용할 이미지를 업로드합니다.
def uploadCarouselFeedImage(corpNum, filePath, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
filePath |
list |
- |
Y |
이미지 파일 경로
가로:세로 비율제한 - 2:1이상 3:4이하
권장 사이즈 - 800*600px 또는 800*400px(가로 500px 이상)
파일형식 및 크기 - jpg, png / 최대 5MB
업로드 요청 최대 파일수 - 10개
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
예외
5-3. UploadCarouselFeedImageBinary - 캐러셀 이미지 업로드 (바이너리)
- 브랜드 메시지 캐러셀 전송에 사용할 이미지를 업로드합니다.
def uploadCarouselFeedImageBinary(corpNum, file, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
file |
BinaryFile[ ] |
10 |
Y |
이미지 파일
가로:세로 비율제한 - 2:1이상 3:4이하
권장 사이즈 - 800*600px 또는 800*400px(가로 500px 이상)
파일형식 및 크기 - jpg, png / 최대 5MB
업로드 요청 최대 파일수 - 10개
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
예외
6-1. SendBMSCommerce - 커머스 전송
- 카카오톡 채널을 추가한 사용자 또는 마케팅 정보 수신에 동의한 사용자에게 커머스형 광고성 메시지를 전송합니다. (최대 1,000건)
- 비채널 친구에게 브랜드 메시지를 전송하기 위해서는 등록된 비즈니스 채널에 대해 브랜드 메시지 채널 신청이 필요합니다.
- 전송실패시 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
def sendBMSCommerce(corpNum, bms, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
bms |
BMS |
- |
Y |
브랜드 메시지 정보
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
plusFriendID |
str |
30 |
Y |
검색용 아이디 |
|
targeting |
str |
1 |
Y |
전송대상
I채널 친구
N비채널 친구
M전체
|
|
adultYN |
bool |
- |
N |
성인용 메시지 여부
기본값 : false
동보 전송인 경우 입력
|
|
imageUrl |
str |
500 |
조건부 |
이미지 URL
동보 전송인 경우 필수
|
|
imageLink |
str |
500 |
N |
이미지 링크 URL
이미지를 클릭하면 연결되는 URL
동보 전송인 경우 입력
|
|
addContent |
str |
34 |
N |
부가메시지
줄바꿈 최대 1회
동보 전송인 경우 입력
|
|
unsubscribeNo |
str |
13 |
조건부 |
080 수신거부 번호
{targeting}="N" or "M" 인 경우 필수
|
|
altYN |
bool |
- |
N |
대체문자 전송 여부
기본값 : false
|
|
sendNum |
str |
20 |
조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
|
|
altSubject |
str |
64 |
N |
대체문자 제목
대체문자 내용이 90byte 이상인 경우에만 적용
단위 : byte
동보 전송인 경우 입력
|
|
altContent |
str |
2,000 |
조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte
동보 전송인 경우 입력
|
|
altUnsubscribeNo |
str |
20 |
조건부 |
대체문자 080 수신거부 번호
대체문자 전송 시 필수
|
|
reserveDT |
str |
14 |
N |
전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50
기본값 : 즉시전송
|
|
requestNum |
str |
36 |
N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
|
|
commerce |
KakaoCommerce |
- |
조건부 |
커머스 정보
동보 전송인 경우 필수
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
30 |
Y |
상품명
|
|
regularPrice |
int |
- |
Y |
정상가격
0 ~ 99,999,999
|
|
discountType |
str |
- |
조건부 |
할인유형
R할인율
F할인금액
미입력 : 할인없음
|
|
discountPrice |
int |
- |
조건부 |
할인가격
0 ~ 99,999,999
|
|
discount |
int |
- |
조건부 |
할인율/할인금액
|
|
|
btns |
list[KakaoButton] |
2 |
조건부 |
버튼 목록
최소 1개, 최대 2개
동보 전송인 경우 필수
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
n |
str |
8 |
Y |
버튼명 |
|
t |
str |
2 |
Y |
버튼유형
- 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 |
- |
N |
쿠폰
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수
동보 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
15 |
Y |
쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
|
|
description |
str |
12 |
Y |
쿠폰 설명
줄바꿈 사용 불가
|
|
linkMobile |
str |
1,000 |
조건부 |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
조건부 |
Android 앱링크 |
|
linkIos |
str |
1,000 |
조건부 |
iOS 앱링크 |
|
|
receivers |
list[KakaoReceiver] |
1,000 |
Y |
수신자 목록
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
receiverNum |
str |
20 |
Y |
수신번호 |
|
receiverName |
str |
70 |
N |
수신자명 |
|
adultYN |
bool |
- |
N |
성인용 메시지 여부
기본값 : false
대량 전송인 경우 입력
|
|
imageUrl |
str |
500 |
조건부 |
이미지 URL
대량 전송인 경우 필수
|
|
imageLink |
str |
500 |
N |
이미지 링크 URL
이미지를 클릭하면 연결되는 URL
대량 전송인 경우 입력
|
|
addContent |
str |
34 |
N |
부가메시지
줄바꿈 최대 1회
대량 전송인 경우 입력
|
|
altSubject |
str |
64 |
N |
대체문자 제목
대량전송 경우 사용
메시지 길이가 90byte 이상인 경우에만 적용
단위 : byte
대량 전송인 경우 입력
|
|
altContent |
str |
2,000 |
조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte
대량 전송인 경우 입력
|
|
interOPRefKey |
str |
20 |
N |
파트너 지정키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
|
commerce |
KakaoCommerce |
- |
조건부 |
커머스 정보
대량 전송인 경우 필수
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
30 |
Y |
상품명
|
|
regularPrice |
int |
- |
Y |
정상가격
0 ~ 99,999,999
|
|
discountType |
str |
- |
조건부 |
할인유형
R할인율
F할인금액
미입력 : 할인없음
|
|
discountPrice |
int |
- |
조건부 |
할인가격
0 ~ 99,999,999
|
|
discount |
int |
- |
조건부 |
할인율/할인금액
|
|
|
btns |
list[KakaoButton] |
2 |
조건부 |
버튼 목록
최소 1개, 최대 2개
대량 전송인 경우 필수
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
n |
str |
8 |
Y |
버튼명 |
|
t |
str |
2 |
Y |
버튼유형
- 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 |
- |
N |
쿠폰
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수
대량 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
15 |
Y |
쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
|
|
description |
str |
12 |
Y |
쿠폰 설명
줄바꿈 사용 불가
|
|
linkMobile |
str |
1,000 |
조건부 |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
조건부 |
Android 앱링크 |
|
linkIos |
str |
1,000 |
조건부 |
iOS 앱링크 |
|
|
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
str - 요청에 대한 접수번호(receiptNum)
예외
6-2. UploadCommerceImage - 커머스 이미지 업로드
- 브랜드 메시지 커머스 전송에 사용할 이미지를 업로드합니다.
def uploadCommerceImage(corpNum, filePath, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
filePath |
str |
- |
Y |
이미지 파일 경로
가로:세로 비율제한 - 2:1이상 3:4이하
권장 사이즈 - 800*400px(가로 500px 이상)
파일형식 및 크기 - jpg, png / 최대 5MB
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
str - 이미지 URL(imageUrl)
예외
6-3. UploadCommerceImageBinary - 커머스 이미지 업로드 (바이너리)
- 브랜드 메시지 커머스 전송에 사용할 이미지를 업로드합니다.
def uploadCommerceImageBinary(corpNum, file, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
file |
BinaryFile |
- |
Y |
이미지 파일
가로:세로 비율제한 - 2:1이상 3:4이하
권장 사이즈 - 800*400px(가로 500px 이상)
파일형식 및 크기 - jpg, png / 최대 5MB
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
str - 이미지 URL(imageUrl)
예외
7-1. SendBMSCarouselCommerce - 캐러셀 커머스 전송
- 카카오톡 채널을 추가한 사용자 또는 마케팅 정보 수신에 동의한 사용자에게 캐러셀 커머스형 광고성 메시지를 전송합니다. (최대 1,000건)
- 비채널 친구에게 브랜드 메시지를 전송하기 위해서는 등록된 비즈니스 채널에 대해 브랜드 메시지 채널 신청이 필요합니다.
- 전송실패시 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
def sendBMSCarouselCommerce(corpNum, bms, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
bms |
BMS |
- |
Y |
브랜드 메시지 정보
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
plusFriendID |
str |
30 |
Y |
검색용 아이디 |
|
targeting |
str |
1 |
Y |
전송대상
I채널 친구
N비채널 친구
M전체
|
|
adultYN |
bool |
- |
N |
성인용 메시지 여부
기본값 : false
동보 전송인 경우 입력
|
|
unsubscribeNo |
str |
13 |
조건부 |
080 수신거부 번호
{targeting}="N" or "M" 인 경우 필수
|
|
altYN |
bool |
- |
N |
대체문자 전송 여부
기본값 : false
|
|
sendNum |
str |
20 |
조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
|
|
altSubject |
str |
64 |
N |
대체문자 제목
대체문자 내용이 90byte 이상인 경우에만 적용
단위 : byte
동보 전송인 경우 입력
|
|
altContent |
str |
2,000 |
조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte
동보 전송인 경우 입력
|
|
altUnsubscribeNo |
str |
20 |
조건부 |
대체문자 080 수신거부 번호
대체문자 전송 시 필수
|
|
reserveDT |
str |
14 |
N |
전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50
기본값 : 즉시전송
|
|
requestNum |
str |
36 |
N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
|
|
head |
KakaoCarouselHead |
- |
N |
캐러셀 인트로
동보 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
content |
str |
50 |
Y |
내용
|
|
imageUrl |
str |
500 |
Y |
이미지 URL
|
|
linkMobile |
str |
1,000 |
N |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
N |
Android 앱링크 |
|
linkIos |
str |
1,000 |
N |
iOS 앱링크 |
|
|
carousel |
list[KakaoCarousel] |
6 |
조건부 |
캐러셀 목록
최소 2개, 최대 6개
동보 전송인 경우 필수
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
imageUrl |
str |
500 |
Y |
이미지 URL
|
|
imageLink |
str |
500 |
N |
이미지 링크 URL 이미지를 클릭하면 연결되는 URL |
|
addContent |
str |
34 |
N |
부가메시지 |
|
commerce |
KakaoCommerce |
- |
Y |
커머스 정보
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
30 |
Y |
상품명
|
|
regularPrice |
int |
- |
Y |
정상가격
0 ~ 99,999,999
|
|
discountType |
str |
- |
조건부 |
할인유형
R할인율
F할인금액
미입력 : 할인없음
|
|
discountPrice |
int |
- |
조건부 |
할인가격
0 ~ 99,999,999
|
|
discount |
int |
- |
조건부 |
할인율/할인금액
|
|
|
btns |
list[KakaoButton] |
2 |
N |
버튼 목록
최소 1개, 최대 2개
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
n |
str |
8 |
Y |
버튼명 |
|
t |
str |
2 |
Y |
버튼유형
- 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 |
- |
N |
쿠폰
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
15 |
Y |
쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
|
|
description |
str |
12 |
Y |
쿠폰 설명
줄바꿈 사용 불가
|
|
linkMobile |
str |
1,000 |
조건부 |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
조건부 |
Android 앱링크 |
|
linkIos |
str |
1,000 |
조건부 |
iOS 앱링크 |
|
|
|
tail |
KakaoCarouselTail |
- |
N |
캐러셀 더보기
동보 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
linkMobile |
str |
1,000 |
Y |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
N |
Android 앱링크 |
|
linkIos |
str |
1,000 |
N |
iOS 앱링크 |
|
|
receivers |
list[KakaoReceiver] |
1,000 |
Y |
수신자 목록
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
receiverNum |
str |
20 |
Y |
수신번호 |
|
receiverName |
str |
70 |
N |
수신자명 |
|
adultYN |
bool |
- |
N |
성인용 메시지 여부
기본값 : false
대량 전송인 경우 입력
|
|
altSubject |
str |
64 |
N |
대체문자 제목
대량전송 경우 사용
메시지 길이가 90byte 이상인 경우에만 적용
단위 : byte
대량 전송인 경우 입력
|
|
altContent |
str |
2,000 |
조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte
대량 전송인 경우 입력
|
|
interOPRefKey |
str |
20 |
N |
파트너 지정키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
|
head |
KakaoCarouselHead |
- |
N |
캐러셀 인트로
동보 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
content |
str |
50 |
Y |
내용
|
|
imageUrl |
str |
500 |
Y |
이미지 URL
|
|
linkMobile |
str |
1,000 |
N |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
N |
Android 앱링크 |
|
linkIos |
str |
1,000 |
N |
iOS 앱링크 |
|
|
carousel |
list[KakaoCarousel] |
6 |
조건부 |
캐러셀 목록
최소 2개, 최대 6개
대량 전송인 경우 필수
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
imageUrl |
str |
500 |
Y |
이미지 URL
|
|
imageLink |
str |
500 |
N |
이미지 링크 URL 이미지를 클릭하면 연결되는 URL |
|
addContent |
str |
34 |
N |
부가메시지 |
|
commerce |
KakaoCommerce |
- |
Y |
커머스 정보
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
30 |
Y |
상품명
|
|
regularPrice |
int |
- |
Y |
정상가격
0 ~ 99,999,999
|
|
discountType |
str |
- |
조건부 |
할인유형
R할인율
F할인금액
미입력 : 할인없음
|
|
discountPrice |
int |
- |
조건부 |
할인가격
0 ~ 99,999,999
|
|
discount |
int |
- |
조건부 |
할인율/할인금액
|
|
|
btns |
list[KakaoButton] |
2 |
N |
버튼 목록
최소 1개, 최대 2개
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
n |
str |
8 |
Y |
버튼명 |
|
t |
str |
2 |
Y |
버튼유형
- 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 |
- |
N |
쿠폰
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
title |
str |
15 |
Y |
쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
|
|
description |
str |
12 |
Y |
쿠폰 설명
줄바꿈 사용 불가
|
|
linkMobile |
str |
1,000 |
조건부 |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
조건부 |
Android 앱링크 |
|
linkIos |
str |
1,000 |
조건부 |
iOS 앱링크 |
|
|
|
tail |
KakaoCarouselTail |
- |
N |
캐러셀 더보기
대량 전송인 경우 입력
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
linkMobile |
str |
1,000 |
Y |
Mobile 웹링크 |
|
linkPc |
str |
1,000 |
N |
PC 웹링크 |
|
linkAndroid |
str |
1,000 |
N |
Android 앱링크 |
|
linkIos |
str |
1,000 |
N |
iOS 앱링크 |
|
|
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
str - 요청에 대한 접수번호(receiptNum)
예외
7-2. UploadCarouselCommerceImage - 캐러셀 커머스 이미지 업로드
- 브랜드 메시지 캐러셀 커머스 전송에 사용할 이미지를 업로드합니다.
- 캐러셀 커머스 이미지는 모든 업로드 이미지의 비율이 동일해야 합니다.
def uploadCarouselCommerceImage(corpNum, filePath, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
filePath |
list |
11 |
Y |
이미지 파일 경로
가로:세로 비율제한 - 2:1이상 3:4이하
권장 사이즈 - 800*600px 또는 800*400px(가로 500px 이상)
파일형식 및 크기 - jpg, png / 최대 5MB
업로드 요청 최대 파일수 - 11개
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
예외
7-3. UploadCarouselCommerceImageBinary - 캐러셀 커머스 이미지 업로드 (바이너리)
- 브랜드 메시지 캐러셀 커머스 전송에 사용할 이미지를 업로드합니다.
- 캐러셀 커머스 이미지는 모든 업로드 이미지의 비율이 동일해야 합니다.
def uploadCarouselCommerceImageBinary(corpNum, file, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
file |
BinaryFile[ ] |
11 |
Y |
이미지 파일
가로:세로 비율제한 - 2:1이상 3:4이하
권장 사이즈 - 800*600px 또는 800*400px(가로 500px 이상)
파일형식 및 크기 - jpg, png / 최대 5MB
업로드 요청 최대 파일수 - 11개
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
예외
8. SendBMSVariable - 템플릿형 전송
- 카카오톡 채널을 추가한 사용자 또는 마케팅 정보 수신에 동의한 사용자에게 템플릿형 광고성 메시지를 전송합니다. (최대 1,000건)
- 비채널 친구에게 브랜드 메시지를 전송하기 위해서는 등록된 비즈니스 채널에 대해 브랜드 메시지 채널 신청이 필요합니다.
- 전송실패시 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
def sendBMSVariable(corpNum, bms, userID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
corpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
bms |
BMS |
- |
Y |
브랜드 메시지 정보
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
templateCode |
str |
12 |
Y |
템플릿 코드 |
|
targeting |
str |
1 |
Y |
전송대상
I채널 친구
N비채널 친구
M전체
|
|
unsubscribeNo |
str |
13 |
조건부 |
080 수신거부 번호
{targeting}="N" or "M" 인 경우 필수
|
|
altYN |
bool |
- |
N |
대체문자 전송 여부
기본값 : false
|
|
sendNum |
str |
20 |
조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환
|
|
altSubject |
str |
64 |
N |
대체문자 제목
대체문자 내용이 90byte 이상인 경우에만 적용
단위 : byte
동보 전송인 경우 입력
|
|
altContent |
str |
2,000 |
조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte
동보 전송인 경우 입력
|
|
altUnsubscribeNo |
str |
20 |
조건부 |
대체문자 080 수신거부 번호
대체문자 전송 시 필수
|
|
reserveDT |
str |
14 |
N |
전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50
기본값 : 즉시전송
|
|
requestNum |
str |
36 |
N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
|
|
contentVariable |
dict |
- |
조건부 |
브랜드 메시지 내용 변수
내용, 헤더, 아이템 제목, 아이템 이미지 링크, 부가메시지에 변수 사용한 경우 필수
동보 전송인 경우 필수
|
|
buttonVariable |
dict |
- |
조건부 |
브랜드 메시지 버튼 변수
버튼 링크에 변수 사용한 경우 필수
동보 전송인 경우 필수
|
|
couponVariable |
dict |
- |
조건부 |
브랜드 메시지 쿠폰 변수
쿠폰 설명, 링크에 변수 사용한 경우 필수
동보 전송인 경우 필수
|
|
commerceVariable |
dict |
- |
조건부 |
브랜드 메시지 커머스 변수
상품명, 정상가격, 할인가격, 할인율, 할인금액에 변수 사용한 경우 필수
동보 전송인 경우 필수
|
|
carouselVariable |
list[KakaoCarouselVariable] |
- |
조건부 |
브랜드 메시지 캐러셀 변수
캐러셀에 변수 사용한 경우 필수
동보 전송인 경우 필수
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
contentVariable |
dict |
- |
조건부 |
브랜드 메시지 캐러셀 내용 변수
캐러셀 제목, 캐러셀 내용, 캐러셀 이미지 링크, 캐러셀 부가메시지에 변수 사용한 경우 필수
|
|
buttonVariable |
dict |
- |
조건부 |
브랜드 메시지 캐러셀 버튼 변수
버튼 링크에 변수 사용한 경우 필수
|
|
couponVariable |
dict |
- |
조건부 |
브랜드 메시지 캐러셀 쿠폰 변수
쿠폰 설명, 링크에 변수 사용한 경우 필수
|
|
commerceVariable |
dict |
- |
조건부 |
브랜드 메시지 캐러셀 커머스 변수
상품명, 정상가격, 할인가격, 할인율, 할인금액에 변수 사용한 경우 필수
|
|
|
receivers |
list[KakaoReceiver] |
1,000 |
Y |
수신자 목록
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
receiveNum |
str |
20 |
N |
수신번호 |
|
receiverName |
str |
70 |
N |
수신자명 |
|
altSubject |
str |
64 |
N |
대체문자 제목
대량전송 경우 사용
메시지 길이가 90byte 이상인 경우에만 적용
단위 : byte
대량 전송인 경우 입력
|
|
altContent |
str |
2,000 |
조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte
대량 전송인 경우 입력
|
|
interOPRefKey |
str |
20 |
N |
파트너 지정키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
|
contentVariable |
dict |
- |
조건부 |
브랜드 메시지 내용 변수
내용, 헤더, 아이템 제목, 아이템 이미지 링크, 부가메시지에 변수 사용한 경우 필수
대량 전송인 경우 필수
|
|
buttonVariable |
dict |
- |
조건부 |
브랜드 메시지 버튼 변수
버튼 링크에 변수 사용한 경우 필수
대량 전송인 경우 필수
|
|
couponVariable |
dict |
- |
조건부 |
브랜드 메시지 쿠폰 변수
쿠폰 설명, 링크에 변수 사용한 경우 필수
대량 전송인 경우 필수
|
|
commerceVariable |
dict |
- |
조건부 |
브랜드 메시지 커머스 변수
상품명, 정상가격, 할인가격, 할인율, 할인금액에 변수 사용한 경우 필수
대량 전송인 경우 필수
|
|
carouselVariable |
list[KakaoCarouselVariable] |
- |
조건부 |
브랜드 메시지 캐러셀 변수
캐러셀에 변수 사용한 경우 필수
대량 전송인 경우 필수
|
| 순번 |
변수명 |
타입 |
길이 |
필수 |
설명 |
|
contentVariable |
dict |
- |
조건부 |
브랜드 메시지 캐러셀 내용 변수
캐러셀 제목, 캐러셀 내용, 캐러셀 이미지 링크, 캐러셀 부가메시지에 변수 사용한 경우 필수
|
|
buttonVariable |
dict |
- |
조건부 |
브랜드 메시지 캐러셀 버튼 변수
버튼 링크에 변수 사용한 경우 필수
|
|
couponVariable |
dict |
- |
조건부 |
브랜드 메시지 캐러셀 쿠폰 변수
쿠폰 설명, 링크에 변수 사용한 경우 필수
|
|
commerceVariable |
dict |
- |
조건부 |
브랜드 메시지 캐러셀 커머스 변수
상품명, 정상가격, 할인가격, 할인율, 할인금액에 변수 사용한 경우 필수
|
|
|
|
|
userID |
str |
50 |
N |
팝빌회원 아이디 |
응답
str - 요청에 대한 접수번호(receiptNum)
예외
9. CancelReserve - 예약전송 취소 (접수번호)
- 팝빌에서 반환받은 접수번호로 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
def cancelReserve(CorpNum, ReceiptNum, UserID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
ReceiptNum |
str |
18 |
Y |
팝빌에서 할당한 접수번호
카카오톡 예약전송 요청의 반환값
|
|
UserID |
str |
50 |
N |
팝빌회원 아이디 |
응답
예외
10. CancelReservebyRCV - 예약전송 부분 취소 (접수번호)
- 팝빌에서 반환받은 접수번호로 접수 건을 식별하여 수신번호에 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
def cancelReservebyRCV(CorpNum, ReceiptNum, ReceiveNum, UserID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
ReceiptNum |
str |
18 |
Y |
팝빌에서 할당한 접수번호
카카오톡 예약전송 요청의 반환값
|
|
ReceiveNum |
str |
20 |
Y |
예약전송 수신번호 |
|
UserID |
str |
50 |
N |
팝빌회원 아이디 |
응답
예외
11. CancelReserveRN - 예약전송 전체 취소 (요청번호)
- 파트너가 할당한 요청번호로 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
def cancelReserveRN(CorpNum, RequestNum, UserID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
RequestNum |
str |
36 |
Y |
파트너가 할당한 요청번호 |
|
UserID |
str |
50 |
N |
팝빌회원 아이디 |
응답
예외
12. CancelReserveRNbyRCV - 예약전송 부분 취소 (요청번호)
- 파트너가 할당한 요청번호로 접수 건을 식별하여 수신번호에 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
def cancelReserveRNbyRCV(CorpNum, RequestNum, ReceiveNum, UserID=None):
요청
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|
|
CorpNum |
str |
10 |
Y |
팝빌회원 사업자번호 ('-' 제외) |
|
RequestNum |
str |
36 |
Y |
파트너가 할당한 요청번호 |
|
ReceiveNum |
str |
20 |
Y |
예약전송 수신번호 |
|
UserID |
str |
50 |
N |
팝빌회원 아이디 |
응답
예외
