전송결과

1. GetMessages - 카카오톡 전송내역 확인

팝빌에서 반환받은 접수번호를 통해 카카오톡 전송상태 및 결과를 확인합니다.

def getMessages(corpNum, receiptNum, userID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	receiptNum	str	18	Y	팝빌에서 할당한 접수번호
3	userID	str	50	N	팝빌회원 아이디

응답

KakaoSentInfo

순번	변수명	타입	길이	설명
1	contentType	int	-	카카오톡 유형 1 알림톡 4 알림톡 이미지 5 알림톡 강조표기 6 브랜드 메시지 텍스트 7 브랜드 메시지 이미지 8 브랜드 메시지 와이드 9 브랜드 메시지 리스트 10 브랜드 메시지 캐러셀 12 브랜드 메시지 커머스 13 브랜드 메시지 캐러셀 커머스
2	templateCode	str	12	알림톡 템플릿 코드 → 알림톡 전송 시 사용한 코드값
3	bmsTemplateCode	str	12	브랜드 메시지 템플릿 코드 → 브랜드 메시지 전송 시 사용한 코드값
4	plusFriendID	str	30	검색용 아이디
5	targeting	str	1	전송대상 I 채널친구 M 전체 N 비채널 친구 → 브랜드 메시지 전송 시 반환
6	unsubscribeNo	str	20	080 무료수신거부 전화번호 → 브랜드 메시지 전송 시 반환
7	sendNum	str	20	발신번호
8	altUnsubscribeNo	str	20	대체문자 080 무료수신거부 전화번호 → 브랜드 메시지 전송 시 반환
9	altSubject	str	64	대체문자 제목 → 단위 : byte
10	altContent	str	2,000	대체문자 내용 → 단위 : byte
11	altSendType	str	1	대체문자 유형 null 미전송 C 카카오톡과 동일 내용 전송 A 대체문자 내용 전송
12	reserveDT	str	14	예약일시 → 형식 : yyyyMMddHHmmss
13	adsYN	bool	-	광고메시지 전송 여부 true 광고 false 일반
14	sendCnt	str	-	전송건수
15	successCnt	str	-	성공건수
16	failCnt	str	-	실패건수
17	altCnt	str	-	대체문자 건수
18	cancelCnt	str	-	취소건수
19	btns	KakaoButton[ ]	5	버튼 목록 → 최대 : 5개
KakaoButton[ ] 순번 변수명 타입 길이 설명 1 n str 14 버튼명 2 t str 2 버튼유형 WL 웹링크 AL 앱링크 TN 전화걸기 DS 배송조회 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 str 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 str 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 5 tg str 3 아웃 링크 out 디바이스 기본 브라우저 ※ 기본값 : 카카오톡 인앱 브라우저 사용 6 telNum str 14 전화걸기 번호
20	msgs	KakaoSentDetail[ ]	1,000	전송결과 정보
KakaoSentDetail[ ] 순번 변수명 타입 길이 설명 1 state int 1 상태코드 → [참고] 팝빌 상태코드 2 sendDT str 14 전송일시 → 형식 : yyyyMMddHHmmss 3 result int 3 카카오 결과코드 → [참고] 카카오 결과코드(카카오톡) ✓ {state} = 3 경우 카카오톡 전송결과 확인 가능 4 resultDT str 14 전송결과 수신일시 → 형식 : yyyyMMddHHmmss 5 contentType int - 카카오톡 유형 1 알림톡 4 알림톡 이미지 5 알림톡 강조표기 6 브랜드 메시지 텍스트 7 브랜드 메시지 이미지 8 브랜드 메시지 와이드 9 브랜드 메시지 리스트 10 브랜드 메시지 캐러셀 12 브랜드 메시지 커머스 13 브랜드 메시지 캐러셀 커머스 6 receiveNum str 20 수신번호 7 receiveName str 70 수신자명 8 emphasizeTitle str 50 강조표기 타이틀 → 알림톡 강조표기형 전송 시 반환 9 adultYN bool - 성인용 메시지 여부 → 브랜드 메시지 전송 시 반환 10 header str 20 제목 → 브랜드 메시지 전송 시 반환 11 content str 1,300 카카오톡 내용 12 addContent str 34 부가메시지 → 브랜드 메시지 전송 시 반환 13 imageUrl str 500 이미지 URL → 브랜드 메시지 전송 시 반환 14 imageLink str 500 이미지 링크 URL → 브랜드 메시지 전송 시 반환 15 altSubject str 64 대체문자 제목 → 단위 : byte 16 altContent str 2,000 대체문자 내용 → 단위 : byte 17 altContentType int 1 대체문자 전송타입 4 단문 6 장문 18 altSendDT str 14 대체문자 전송일시 → 형식 : yyyyMMddHHmmss 19 altResult int 3 대체문자 통신사 결과코드 → [참고] 통신사 결과코드(대체문자) 20 altResultDT str 14 대체문자 전송결과 수신일시 → 형식 : yyyyMMddHHmmss 21 reserveDT str 14 예약일시 → 형식 : yyyyMMddHHmmss 22 receiptNum str 18 접수번호 23 requestNum str 36 요청번호 24 interOPRefKey str 20 파트너 지정키 → 카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값 25 item KakaoItem[ ] 4 아이템 목록 → 브랜드 메시지 전송 시 반환 KakaoItem[ ] 순번 변수명 타입 길이 설명 1 title str 30 타이틀 2 imageUrl str 500 이미지 URL 3 linkMobile str 1,000 Mobile 웹링크 4 linkPc str 1,000 PC 웹링크 5 linkAndroid str 1,000 Android 앱링크 6 linkIos str 1,000 iOS 앱링크 26 commerce KakaoCommerce - 커머스 정보 → 브랜드 메시지 전송 시 반환 KakaoCommerce 순번 변수명 타입 길이 설명 1 title str 30 상품명 2 regularPrice int - 정상가격 → 0 ~ 99,999,999 3 discountType str 1 할인유형 R 할인율 F 할인금액 4 discount int - 할인율/할인금액 → {discountType}="R" 경우 1 ~ 100 {discountType}="F" 경우 0 ~ 999,999 5 discountPrice int - 할인가격 → 0 ~ 99,999,999 할인 적용 후 최종 가격 27 head KakaoCarouselHead - 캐러셀 인트로 → 브랜드 메시지 전송 시 반환 KakaoCarouselHead 순번 변수명 타입 길이 설명 1 header str 20 제목 2 content str 50 내용 3 imageUrl str 500 이미지 URL 4 linkMobile str 1,000 Mobile 웹링크 5 linkPc str 1,000 PC 웹링크 6 linkAndroid str 1,000 Android 앱링크 7 linkIos str 1,000 iOS 앱링크 28 carousel KakaoCarousel[ ] 6 캐러셀 목록 → 브랜드 메시지 전송 시 반환 KakaoCarousel[ ] 순번 변수명 타입 길이 설명 1 header str 20 제목 2 content str 180 내용 3 imageUrl str 500 이미지 URL 4 imageLink str 500 이미지 링크 URL → 이미지를 클릭하면 연결되는 URL 5 addContent str 34 부가메시지 6 commerce KakaoCommerce - 커머스 정보 KakaoCommerce 순번 변수명 타입 길이 설명 1 title str 30 상품명 2 regularPrice int - 정상가격 → 0 ~ 99,999,999 3 discountType str 1 할인유형 R 할인율 F 할인금액 4 discount int - 할인율/할인금액 → {discountType}="R" 경우 1 ~ 100 {discountType}="F" 경우 0 ~ 999,999 5 discountPrice int - 할인가격 → 0 ~ 99,999,999 할인 적용 후 최종 가격 7 btns KakaoButton[ ] 2 버튼 목록 KakaoButton[ ] 순번 변수명 타입 길이 설명 1 n str 8 버튼명 2 t str 2 버튼유형 WL 웹링크 AL 앱링크 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 str 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 str 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 8 coupon KakaoCoupon - 쿠폰 KakaoCoupon 순번 변수명 타입 길이 설명 1 title str 15 쿠폰 제목 #{숫자}원 할인 쿠폰 (숫자 : 1~99,999,999) #{숫자}% 할인 쿠폰 (숫자 : 1~100) 배송비 할인 쿠폰 #{7자 이내} 무료 쿠폰 #{7자 이내} UP 쿠폰 2 description str 12 쿠폰 설명 → 줄바꿈 사용 불가 3 linkMobile str 1,000 Mobile 웹링크 4 linkPc str 1,000 PC 웹링크 5 linkAndroid str 1,000 Android 앱링크 6 linkIos str 1,000 iOS 앱링크 29 tail KakaoCarouselTail - 캐러셀 더보기 → 브랜드 메시지 전송 시 반환 KakaoCarouselTail 순번 변수명 타입 길이 설명 1 linkMobile str 1,000 Mobile 웹링크 2 linkPc str 1,000 PC 웹링크 3 linkAndroid str 1,000 Android 앱링크 4 linkIos str 1,000 iOS 앱링크 30 btns KakaoButton[ ] 5 버튼 목록 KakaoButton[ ] 순번 변수명 타입 길이 설명 1 n str 14 버튼명 2 t str 2 버튼유형 WL 웹링크 AL 앱링크 TN 전화걸기 DS 배송조회 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 str 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 str 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 5 tg str 3 아웃 링크 out 디바이스 기본 브라우저 ※ 기본값 : 카카오톡 인앱 브라우저 사용 6 telNum str 14 전화걸기 번호 31 coupon KakaoCoupon - 쿠폰 → 브랜드 메시지 전송 시 반환 KakaoCoupon 순번 변수명 타입 길이 설명 1 title str 15 쿠폰 제목 #{숫자}원 할인 쿠폰 (숫자 : 1~99,999,999) #{숫자}% 할인 쿠폰 (숫자 : 1~100) 배송비 할인 쿠폰 #{7자 이내} 무료 쿠폰 #{7자 이내} UP 쿠폰 2 description str 12 쿠폰 설명 → 줄바꿈 사용 불가 3 linkMobile str 1,000 Mobile 웹링크 4 linkPc str 1,000 PC 웹링크 5 linkAndroid str 1,000 Android 앱링크 6 linkIos str 1,000 iOS 앱링크 32 contentVariable dict - 브랜드 메시지 내용 변수 → 브랜드 메시지 전송 시 반환 33 buttonVariable dict - 브랜드 메시지 버튼 변수 → 브랜드 메시지 전송 시 반환 34 couponVariable dict - 브랜드 메시지 쿠폰 변수 → 브랜드 메시지 전송 시 반환 35 commerceVariable dict - 브랜드 메시지 커머스 변수 → 브랜드 메시지 전송 시 반환 36 carouselVariable KakaoCarouselVariable[ ] - 브랜드 메시지 캐러셀 변수 → 브랜드 메시지 전송 시 반환 KakaoCarouselVariable[ ] 순번 변수명 타입 길이 설명 1 contentVariable dict - 브랜드 메시지 캐러셀 내용 변수 2 buttonVariable dict - 브랜드 메시지 캐러셀 버튼 변수 3 couponVariable dict - 브랜드 메시지 캐러셀 쿠폰 변수 4 commerceVariable dict - 브랜드 메시지 캐러셀 커머스 변수

예외

PopbillException

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

2. GetMessagesRN - 카카오톡 전송내역 확인 (요청번호 할당)

파트너가 할당한 요청번호를 통해 카카오톡 전송상태 및 결과를 확인합니다.

def getMessagesRN(corpNum, requestNum, userID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	requestNum	str	36	Y	파트너가 할당한 요청번호
3	userID	str	50	N	팝빌회원 아이디

응답

KakaoSentInfo

순번	변수명	타입	길이	설명
1	contentType	int	-	카카오톡 유형 1 알림톡 4 알림톡 이미지 5 알림톡 강조표기 6 브랜드 메시지 텍스트 7 브랜드 메시지 이미지 8 브랜드 메시지 와이드 9 브랜드 메시지 리스트 10 브랜드 메시지 캐러셀 12 브랜드 메시지 커머스 13 브랜드 메시지 캐러셀 커머스
2	templateCode	str	12	알림톡 템플릿 코드 → 알림톡 전송 시 사용한 코드값
3	bmsTemplateCode	str	12	브랜드 메시지 템플릿 코드 → 브랜드 메시지 전송 시 사용한 코드값
4	plusFriendID	str	30	검색용 아이디
5	targeting	str	1	전송대상 I 채널친구 M 전체 N 비채널 친구 → 브랜드 메시지 전송 시 반환
6	unsubscribeNo	str	20	080 무료수신거부 전화번호 → 브랜드 메시지 전송 시 반환
7	sendNum	str	20	발신번호
8	altUnsubscribeNo	str	20	대체문자 080 무료수신거부 전화번호 → 브랜드 메시지 전송 시 반환
9	altSubject	str	64	대체문자 제목 → 단위 : byte
10	altContent	str	2,000	대체문자 내용 → 단위 : byte
11	altSendType	str	1	대체문자 유형 null 미전송 C 카카오톡과 동일 내용 전송 A 대체문자 내용 전송
12	reserveDT	str	14	예약일시 → 형식 : yyyyMMddHHmmss
13	adsYN	bool	-	광고메시지 전송 여부 true 광고 false 일반
14	sendCnt	str	-	전송건수
15	successCnt	str	-	성공건수
16	failCnt	str	-	실패건수
17	altCnt	str	-	대체문자 건수
18	cancelCnt	str	-	취소건수
19	btns	KakaoButton[ ]	5	버튼 목록 → 최대 : 5개
KakaoButton[ ] 순번 변수명 타입 길이 설명 1 n str 14 버튼명 2 t str 2 버튼유형 WL 웹링크 AL 앱링크 TN 전화걸기 DS 배송조회 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 str 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 str 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 5 tg str 3 아웃 링크 out 디바이스 기본 브라우저 ※ 기본값 : 카카오톡 인앱 브라우저 사용 6 telNum str 14 전화걸기 번호
20	msgs	KakaoSentDetail[ ]	1,000	전송결과 정보
KakaoSentDetail[ ] 순번 변수명 타입 길이 설명 1 state int 1 상태코드 → [참고] 팝빌 상태코드 2 sendDT str 14 전송일시 → 형식 : yyyyMMddHHmmss 3 result int 3 카카오 결과코드 → [참고] 카카오 결과코드(카카오톡) ✓ {state} = 3 경우 카카오톡 전송결과 확인 가능 4 resultDT str 14 전송결과 수신일시 → 형식 : yyyyMMddHHmmss 5 contentType int - 카카오톡 유형 1 알림톡 4 알림톡 이미지 5 알림톡 강조표기 6 브랜드 메시지 텍스트 7 브랜드 메시지 이미지 8 브랜드 메시지 와이드 9 브랜드 메시지 리스트 10 브랜드 메시지 캐러셀 12 브랜드 메시지 커머스 13 브랜드 메시지 캐러셀 커머스 6 receiveNum str 20 수신번호 7 receiveName str 70 수신자명 8 emphasizeTitle str 50 강조표기 타이틀 → 알림톡 강조표기형 전송 시 반환 9 adultYN bool - 성인용 메시지 여부 → 브랜드 메시지 전송 시 반환 10 header str 20 제목 → 브랜드 메시지 전송 시 반환 11 content str 1,300 카카오톡 내용 12 addContent str 34 부가메시지 → 브랜드 메시지 전송 시 반환 13 imageUrl str 500 이미지 URL → 브랜드 메시지 전송 시 반환 14 imageLink str 500 이미지 링크 URL → 브랜드 메시지 전송 시 반환 15 altSubject str 64 대체문자 제목 → 단위 : byte 16 altContent str 2,000 대체문자 내용 → 단위 : byte 17 altContentType int 1 대체문자 전송타입 4 단문 6 장문 18 altSendDT str 14 대체문자 전송일시 → 형식 : yyyyMMddHHmmss 19 altResult int 3 대체문자 통신사 결과코드 → [참고] 통신사 결과코드(대체문자) 20 altResultDT str 14 대체문자 전송결과 수신일시 → 형식 : yyyyMMddHHmmss 21 reserveDT str 14 예약일시 → 형식 : yyyyMMddHHmmss 22 receiptNum str 18 접수번호 23 requestNum str 36 요청번호 24 interOPRefKey str 20 파트너 지정키 → 카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값 25 item KakaoItem[ ] 4 아이템 목록 → 브랜드 메시지 전송 시 반환 KakaoItem[ ] 순번 변수명 타입 길이 설명 1 title str 30 타이틀 2 imageUrl str 500 이미지 URL 3 linkMobile str 1,000 Mobile 웹링크 4 linkPc str 1,000 PC 웹링크 5 linkAndroid str 1,000 Android 앱링크 6 linkIos str 1,000 iOS 앱링크 26 commerce KakaoCommerce - 커머스 정보 → 브랜드 메시지 전송 시 반환 KakaoCommerce 순번 변수명 타입 길이 설명 1 title str 30 상품명 2 regularPrice int - 정상가격 → 0 ~ 99,999,999 3 discountType str 1 할인유형 R 할인율 F 할인금액 4 discount int - 할인율/할인금액 → {discountType}="R" 경우 1 ~ 100 {discountType}="F" 경우 0 ~ 999,999 5 discountPrice int - 할인가격 → 0 ~ 99,999,999 할인 적용 후 최종 가격 27 head KakaoCarouselHead - 캐러셀 인트로 → 브랜드 메시지 전송 시 반환 KakaoCarouselHead 순번 변수명 타입 길이 설명 1 header str 20 제목 2 content str 50 내용 3 imageUrl str 500 이미지 URL 4 linkMobile str 1,000 Mobile 웹링크 5 linkPc str 1,000 PC 웹링크 6 linkAndroid str 1,000 Android 앱링크 7 linkIos str 1,000 iOS 앱링크 28 carousel KakaoCarousel[ ] 6 캐러셀 목록 → 브랜드 메시지 전송 시 반환 KakaoCarousel[ ] 순번 변수명 타입 길이 설명 1 header str 20 제목 2 content str 180 내용 3 imageUrl str 500 이미지 URL 4 imageLink str 500 이미지 링크 URL → 이미지를 클릭하면 연결되는 URL 5 addContent str 34 부가메시지 6 commerce KakaoCommerce - 커머스 정보 KakaoCommerce 순번 변수명 타입 길이 설명 1 title str 30 상품명 2 regularPrice int - 정상가격 → 0 ~ 99,999,999 3 discountType str 1 할인유형 R 할인율 F 할인금액 4 discount int - 할인율/할인금액 → {discountType}="R" 경우 1 ~ 100 {discountType}="F" 경우 0 ~ 999,999 5 discountPrice int - 할인가격 → 0 ~ 99,999,999 할인 적용 후 최종 가격 7 btns KakaoButton[ ] 2 버튼 목록 KakaoButton[ ] 순번 변수명 타입 길이 설명 1 n str 8 버튼명 2 t str 2 버튼유형 WL 웹링크 AL 앱링크 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 str 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 str 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 8 coupon KakaoCoupon - 쿠폰 KakaoCoupon 순번 변수명 타입 길이 설명 1 title str 15 쿠폰 제목 #{숫자}원 할인 쿠폰 (숫자 : 1~99,999,999) #{숫자}% 할인 쿠폰 (숫자 : 1~100) 배송비 할인 쿠폰 #{7자 이내} 무료 쿠폰 #{7자 이내} UP 쿠폰 2 description str 12 쿠폰 설명 → 줄바꿈 사용 불가 3 linkMobile str 1,000 Mobile 웹링크 4 linkPc str 1,000 PC 웹링크 5 linkAndroid str 1,000 Android 앱링크 6 linkIos str 1,000 iOS 앱링크 29 tail KakaoCarouselTail - 캐러셀 더보기 → 브랜드 메시지 전송 시 반환 KakaoCarouselTail 순번 변수명 타입 길이 설명 1 linkMobile str 1,000 Mobile 웹링크 2 linkPc str 1,000 PC 웹링크 3 linkAndroid str 1,000 Android 앱링크 4 linkIos str 1,000 iOS 앱링크 30 btns KakaoButton[ ] 5 버튼 목록 KakaoButton[ ] 순번 변수명 타입 길이 설명 1 n str 14 버튼명 2 t str 2 버튼유형 WL 웹링크 AL 앱링크 TN 전화걸기 DS 배송조회 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 str 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 str 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 5 tg str 3 아웃 링크 out 디바이스 기본 브라우저 ※ 기본값 : 카카오톡 인앱 브라우저 사용 6 telNum str 14 전화걸기 번호 31 coupon KakaoCoupon - 쿠폰 → 브랜드 메시지 전송 시 반환 KakaoCoupon 순번 변수명 타입 길이 설명 1 title str 15 쿠폰 제목 #{숫자}원 할인 쿠폰 (숫자 : 1~99,999,999) #{숫자}% 할인 쿠폰 (숫자 : 1~100) 배송비 할인 쿠폰 #{7자 이내} 무료 쿠폰 #{7자 이내} UP 쿠폰 2 description str 12 쿠폰 설명 → 줄바꿈 사용 불가 3 linkMobile str 1,000 Mobile 웹링크 4 linkPc str 1,000 PC 웹링크 5 linkAndroid str 1,000 Android 앱링크 6 linkIos str 1,000 iOS 앱링크 32 contentVariable dict - 브랜드 메시지 내용 변수 → 브랜드 메시지 전송 시 반환 33 buttonVariable dict - 브랜드 메시지 버튼 변수 → 브랜드 메시지 전송 시 반환 34 couponVariable dict - 브랜드 메시지 쿠폰 변수 → 브랜드 메시지 전송 시 반환 35 commerceVariable dict - 브랜드 메시지 커머스 변수 → 브랜드 메시지 전송 시 반환 36 carouselVariable KakaoCarouselVariable[ ] - 브랜드 메시지 캐러셀 변수 → 브랜드 메시지 전송 시 반환 KakaoCarouselVariable[ ] 순번 변수명 타입 길이 설명 1 contentVariable dict - 브랜드 메시지 캐러셀 내용 변수 2 buttonVariable dict - 브랜드 메시지 캐러셀 버튼 변수 3 couponVariable dict - 브랜드 메시지 캐러셀 쿠폰 변수 4 commerceVariable dict - 브랜드 메시지 캐러셀 커머스 변수

예외

PopbillException

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

3. Search - 전송내역 목록 조회

검색조건에 해당하는 카카오톡 전송내역을 조회합니다. (조회기간 단위 : 최대 2개월)

• 카카오톡 접수일시로부터 12개월 이내 접수건만 조회할 수 있습니다.

def search(corpNum, sDate, eDate, state, item, reserveYN, SenderYN, page, perpage, order, userID, Qstring, plusFriendID)

매개변수 page, perpage, order를 이용하여 페이징 기능을 구현할 수 있습니다.

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	sDate	str	8	Y	검색 시작일자 → 형식 : yyyyMMdd
3	eDate	str	8	Y	검색 종료일자 → 형식 : yyyyMMdd
4	state	list	-	N	전송상태 (다중 선택 가능) 0 전송대기 1 전송중 2 전송성공 3 대체문자 전송성공 4 전송실패 5 예약취소
5	item	list	-	N	검색대상 ATS 알림톡 BMS 브랜드 메시지 ※ 기본값 : 전체조회
6	reserveYN	str	1	N	전송유형별 조회 (택 1) 0 즉시전송건 1 예약전송건 ※ 기본값 : 전체조회
7	SenderYN	bool	-	N	사용자권한별 조회 True 팝빌회원 아이디(userID)로 전송한 카카오톡만 조회 False 전송한 카카오톡 전체 조회 : 기본값
8	page	int	-	N	목록 페이지번호 ※ 기본값 : 1
9	perpage	int	-	N	페이지당 표시할 목록 건수 → 최대 : 1,000건 ※ 기본값 : 500건
10	order	str	1	N	카카오톡 접수일시를 기준으로 하는 목록 정렬 방향 D 내림차순 : 기본값 A 오름차순
11	userID	str	50	N	팝빌회원 아이디
12	Qstring	str	70	N	조회 검색어(수신자명, 수신번호) ※ 기본값 : 전체조회
13	plusFriendID	str	30	N	검색용 아이디

응답

KakaoSearchResult

순번	변수명	타입	길이	설명
1	code	int	-	API 처리에 대한 응답코드 1 성공
2	message	str	-	API 처리에 대한 응답메시지
3	total	str	-	총 검색결과 건수
4	perPage	str	-	페이지 당 목록 건수
5	pageNum	str	-	페이지 번호
6	pageCount	str	-	페이지 개수
7	list	KakaoSentDetail[ ]	1,000	전송결과 정보
KakaoSentDetail[ ] 순번 변수명 타입 길이 설명 1 state int 1 상태코드 → [참고] 팝빌 상태코드 2 sendDT str 14 전송일시 → 형식 : yyyyMMddHHmmss 3 result int 3 카카오 결과코드 → [참고] 카카오 결과코드(카카오톡) ✓ {state} = 3 경우 카카오톡 전송결과 확인 가능 4 resultDT str 14 전송결과 수신일시 → 형식 : yyyyMMddHHmmss 5 contentType int - 카카오톡 유형 1 알림톡 4 알림톡 이미지 5 알림톡 강조표기 6 브랜드 메시지 텍스트 7 브랜드 메시지 이미지 8 브랜드 메시지 와이드 9 브랜드 메시지 리스트 10 브랜드 메시지 캐러셀 12 브랜드 메시지 커머스 13 브랜드 메시지 캐러셀 커머스 6 receiveNum str 20 수신번호 7 receiveName str 70 수신자명 8 emphasizeTitle str 50 강조표기 타이틀 → 알림톡 강조표기형 전송 시 반환 9 adultYN bool - 성인용 메시지 여부 → 브랜드 메시지 전송 시 반환 10 header str 20 제목 → 브랜드 메시지 전송 시 반환 11 content str 1,300 카카오톡 내용 12 addContent str 34 부가메시지 → 브랜드 메시지 전송 시 반환 13 imageUrl str 500 이미지 URL → 브랜드 메시지 전송 시 반환 14 imageLink str 500 이미지 링크 URL → 브랜드 메시지 전송 시 반환 15 altSubject str 64 대체문자 제목 → 단위 : byte 16 altContent str 2,000 대체문자 내용 → 단위 : byte 17 altContentType int 1 대체문자 전송타입 4 단문 6 장문 18 altSendDT str 14 대체문자 전송일시 → 형식 : yyyyMMddHHmmss 19 altResult int 3 대체문자 통신사 결과코드 → [참고] 통신사 결과코드(대체문자) 20 altResultDT str 14 대체문자 전송결과 수신일시 → 형식 : yyyyMMddHHmmss 21 reserveDT str 14 예약일시 → 형식 : yyyyMMddHHmmss 22 receiptNum str 18 접수번호 23 requestNum str 36 요청번호 24 interOPRefKey str 20 파트너 지정키 → 카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값 25 item KakaoItem[ ] 4 아이템 목록 → 브랜드 메시지 전송 시 반환 KakaoItem[ ] 순번 변수명 타입 길이 설명 1 title str 30 타이틀 2 imageUrl str 500 이미지 URL 3 linkMobile str 1,000 Mobile 웹링크 4 linkPc str 1,000 PC 웹링크 5 linkAndroid str 1,000 Android 앱링크 6 linkIos str 1,000 iOS 앱링크 26 commerce KakaoCommerce - 커머스 정보 → 브랜드 메시지 전송 시 반환 KakaoCommerce 순번 변수명 타입 길이 설명 1 title str 30 상품명 2 regularPrice int - 정상가격 → 0 ~ 99,999,999 3 discountType str 1 할인유형 R 할인율 F 할인금액 4 discount int - 할인율/할인금액 → {discountType}="R" 경우 1 ~ 100 {discountType}="F" 경우 0 ~ 999,999 5 discountPrice int - 할인가격 → 0 ~ 99,999,999 할인 적용 후 최종 가격 27 head KakaoCarouselHead - 캐러셀 인트로 → 브랜드 메시지 전송 시 반환 KakaoCarouselHead 순번 변수명 타입 길이 설명 1 header str 20 제목 2 content str 50 내용 3 imageUrl str 500 이미지 URL 4 linkMobile str 1,000 Mobile 웹링크 5 linkPc str 1,000 PC 웹링크 6 linkAndroid str 1,000 Android 앱링크 7 linkIos str 1,000 iOS 앱링크 28 carousel KakaoCarousel[ ] 6 캐러셀 목록 → 브랜드 메시지 전송 시 반환 KakaoCarousel[ ] 순번 변수명 타입 길이 설명 1 header str 20 제목 2 content str 180 내용 3 imageUrl str 500 이미지 URL 4 imageLink str 500 이미지 링크 URL → 이미지를 클릭하면 연결되는 URL 5 addContent str 34 부가메시지 6 commerce KakaoCommerce - 커머스 정보 KakaoCommerce 순번 변수명 타입 길이 설명 1 title str 30 상품명 2 regularPrice int - 정상가격 → 0 ~ 99,999,999 3 discountType str 1 할인유형 R 할인율 F 할인금액 4 discount int - 할인율/할인금액 → {discountType}="R" 경우 1 ~ 100 {discountType}="F" 경우 0 ~ 999,999 5 discountPrice int - 할인가격 → 0 ~ 99,999,999 할인 적용 후 최종 가격 7 btns KakaoButton[ ] 2 버튼 목록 KakaoButton[ ] 순번 변수명 타입 길이 설명 1 n str 8 버튼명 2 t str 2 버튼유형 WL 웹링크 AL 앱링크 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 str 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 str 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 8 coupon KakaoCoupon - 쿠폰 KakaoCoupon 순번 변수명 타입 길이 설명 1 title str 15 쿠폰 제목 #{숫자}원 할인 쿠폰 (숫자 : 1~99,999,999) #{숫자}% 할인 쿠폰 (숫자 : 1~100) 배송비 할인 쿠폰 #{7자 이내} 무료 쿠폰 #{7자 이내} UP 쿠폰 2 description str 12 쿠폰 설명 → 줄바꿈 사용 불가 3 linkMobile str 1,000 Mobile 웹링크 4 linkPc str 1,000 PC 웹링크 5 linkAndroid str 1,000 Android 앱링크 6 linkIos str 1,000 iOS 앱링크 29 tail KakaoCarouselTail - 캐러셀 더보기 → 브랜드 메시지 전송 시 반환 KakaoCarouselTail 순번 변수명 타입 길이 설명 1 linkMobile str 1,000 Mobile 웹링크 2 linkPc str 1,000 PC 웹링크 3 linkAndroid str 1,000 Android 앱링크 4 linkIos str 1,000 iOS 앱링크 30 btns KakaoButton[ ] 5 버튼 목록 KakaoButton[ ] 순번 변수명 타입 길이 설명 1 n str 14 버튼명 2 t str 2 버튼유형 WL 웹링크 AL 앱링크 TN 전화걸기 DS 배송조회 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 str 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 str 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 5 tg str 3 아웃 링크 out 디바이스 기본 브라우저 ※ 기본값 : 카카오톡 인앱 브라우저 사용 6 telNum str 14 전화걸기 번호 31 coupon KakaoCoupon - 쿠폰 → 브랜드 메시지 전송 시 반환 KakaoCoupon 순번 변수명 타입 길이 설명 1 title str 15 쿠폰 제목 #{숫자}원 할인 쿠폰 (숫자 : 1~99,999,999) #{숫자}% 할인 쿠폰 (숫자 : 1~100) 배송비 할인 쿠폰 #{7자 이내} 무료 쿠폰 #{7자 이내} UP 쿠폰 2 description str 12 쿠폰 설명 → 줄바꿈 사용 불가 3 linkMobile str 1,000 Mobile 웹링크 4 linkPc str 1,000 PC 웹링크 5 linkAndroid str 1,000 Android 앱링크 6 linkIos str 1,000 iOS 앱링크 32 contentVariable dict - 브랜드 메시지 내용 변수 → 브랜드 메시지 전송 시 반환 33 buttonVariable dict - 브랜드 메시지 버튼 변수 → 브랜드 메시지 전송 시 반환 34 couponVariable dict - 브랜드 메시지 쿠폰 변수 → 브랜드 메시지 전송 시 반환 35 commerceVariable dict - 브랜드 메시지 커머스 변수 → 브랜드 메시지 전송 시 반환 36 carouselVariable KakaoCarouselVariable[ ] - 브랜드 메시지 캐러셀 변수 → 브랜드 메시지 전송 시 반환 KakaoCarouselVariable[ ] 순번 변수명 타입 길이 설명 1 contentVariable dict - 브랜드 메시지 캐러셀 내용 변수 2 buttonVariable dict - 브랜드 메시지 캐러셀 버튼 변수 3 couponVariable dict - 브랜드 메시지 캐러셀 쿠폰 변수 4 commerceVariable dict - 브랜드 메시지 캐러셀 커머스 변수

예외

PopbillException

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

4. GetSentListURL - 카카오톡 전송내역 팝업 URL

미리보기

카카오톡 전송내역 팝업 URL을 반환합니다.

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

def getSentListURL(corpNum, userID)

요청

Parameters

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

응답

str - 요청에 대한 응답 URL

예외

PopbillException

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