전송결과

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

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

function GetMessages(corpNum : String; receiptNum : String; userID : String = '') : TSentKakaoInfo;

요청

Parameters

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

응답

TSentKakaoInfo

순번	변수명	타입	길이	설명
1	contentType	String	-	카카오톡 유형 1 알림톡 4 알림톡 이미지
2	templateCode	String	12	템플릿 코드 → 알림톡 전송 시 반환
3	plusFriendID	String	30	검색용 아이디
4	sendNum	String	20	발신번호
5	altSubject	String	64	대체문자 제목 → 단위 : byte
6	altContent	String	2,000	대체문자 내용 → 단위 : byte
7	altSendType	String	1	대체문자 유형 null 미전송 C 카카오톡과 동일 내용 전송 A 대체문자 내용 전송
8	reserveDT	String	14	예약일시 → 형식 : yyyyMMddHHmmss
9	adsYN	Boolean	-	광고메시지 전송 여부 true 광고 false 일반
10	sendCnt	String	-	전송건수
11	successCnt	String	-	성공건수
12	failCnt	String	-	실패건수
13	altCnt	String	-	대체문자 건수
14	cancelCnt	String	-	취소건수
15	btns	KakaoButton[ ]	5	버튼 목록 → 최대 : 5개
KakaoButton[ ] 순번 변수명 타입 길이 설명 1 buttonName String 14 버튼명 2 buttonType String 2 버튼유형 WL 웹링크 AL 앱링크 DS 배송조회 MD 메시지전달 BK 봇키워드 AC 채널추가 3 buttonURL1 String 1,000 버튼링크 → {buttonType} = "AL" 경우 iOS 앱링크 적용 {buttonType} = "WL" 경우 Mobile 웹링크 적용 4 buttonURL2 String 1,000 버튼링크 → {buttonType} = "AL" 경우 Android 앱링크 적용 {buttonType} = "WL" 경우 PC 웹링크 적용 5 buttonTG String 3 아웃 링크 out 디바이스 기본 브라우저 ※ 기본값 : 카카오톡 인앱 브라우저 사용
16	msgs	KakaoSentDetail[ ]	1,000	전송결과 정보
KakaoSentDetail[ ] 순번 변수명 타입 길이 설명 1 state Integer 1 상태코드 → [참고] 팝빌 상태코드 2 sendDT String 14 전송일시 → 형식 : yyyyMMddHHmmss 3 result Integer 3 카카오 결과코드 → [참고] 카카오 결과코드(카카오톡) ✓ {state} = 3 경우 카카오톡 전송결과 확인 가능 4 resultDT String 14 전송결과 수신일시 → 형식 : yyyyMMddHHmmss 5 contentType Integer - 카카오톡 유형 1 알림톡 4 알림톡 이미지 6 receiveNum String 20 수신번호 7 receiveName String 70 수신자명 8 content String 1,300 카카오톡 내용 9 altSubject String 64 대체문자 제목 → 단위 : byte 10 altContent String 2,000 대체문자 내용 → 단위 : byte 11 altContentType Integer 1 대체문자 전송타입 4 단문 6 장문 12 altSendDT String 14 대체문자 전송일시 → 형식 : yyyyMMddHHmmss 13 altResult Integer 3 대체문자 통신사 결과코드 → [참고] 통신사 결과코드(대체문자) 14 altResultDT String 14 대체문자 전송결과 수신일시 → 형식 : yyyyMMddHHmmss 15 receiptNum String 18 접수번호 16 requestNum String 36 요청번호 17 interOPRefKey String 20 파트너 지정키 → 카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

예외

EPopbillException

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

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

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

function GetMessagesRN(corpNum : String; requestNum : String; userID : String = '') : TSentKakaoInfo;

요청

Parameters

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

응답

TSentKakaoInfo

순번	변수명	타입	길이	설명
1	contentType	String	-	카카오톡 유형 1 알림톡 4 알림톡 이미지
2	templateCode	String	12	템플릿 코드 → 알림톡 전송 시 반환
3	plusFriendID	String	30	검색용 아이디
4	sendNum	String	20	발신번호
5	altSubject	String	64	대체문자 제목 → 단위 : byte
6	altContent	String	2,000	대체문자 내용 → 단위 : byte
7	altSendType	String	1	대체문자 유형 null 미전송 C 카카오톡과 동일 내용 전송 A 대체문자 내용 전송
8	reserveDT	String	14	예약일시 → 형식 : yyyyMMddHHmmss
9	adsYN	Boolean	-	광고메시지 전송 여부 true 광고 false 일반
10	sendCnt	String	-	전송건수
11	successCnt	String	-	성공건수
12	failCnt	String	-	실패건수
13	altCnt	String	-	대체문자 건수
14	cancelCnt	String	-	취소건수
15	btns	KakaoButton[ ]	5	버튼 목록 → 최대 : 5개
KakaoButton[ ] 순번 변수명 타입 길이 설명 1 buttonName String 14 버튼명 2 buttonType String 2 버튼유형 WL 웹링크 AL 앱링크 DS 배송조회 MD 메시지전달 BK 봇키워드 AC 채널추가 3 buttonURL1 String 1,000 버튼링크 → {buttonType} = "AL" 경우 iOS 앱링크 적용 {buttonType} = "WL" 경우 Mobile 웹링크 적용 4 buttonURL2 String 1,000 버튼링크 → {buttonType} = "AL" 경우 Android 앱링크 적용 {buttonType} = "WL" 경우 PC 웹링크 적용 5 buttonTG String 3 아웃 링크 out 디바이스 기본 브라우저 ※ 기본값 : 카카오톡 인앱 브라우저 사용
16	msgs	KakaoSentDetail[ ]	1,000	전송결과 정보
KakaoSentDetail[ ] 순번 변수명 타입 길이 설명 1 state Integer 1 상태코드 → [참고] 팝빌 상태코드 2 sendDT String 14 전송일시 → 형식 : yyyyMMddHHmmss 3 result Integer 3 카카오 결과코드 → [참고] 카카오 결과코드(카카오톡) ✓ {state} = 3 경우 카카오톡 전송결과 확인 가능 4 resultDT String 14 전송결과 수신일시 → 형식 : yyyyMMddHHmmss 5 contentType Integer - 카카오톡 유형 1 알림톡 4 알림톡 이미지 6 receiveNum String 20 수신번호 7 receiveName String 70 수신자명 8 content String 1,300 카카오톡 내용 9 altSubject String 64 대체문자 제목 → 단위 : byte 10 altContent String 2,000 대체문자 내용 → 단위 : byte 11 altContentType Integer 1 대체문자 전송타입 4 단문 6 장문 12 altSendDT String 14 대체문자 전송일시 → 형식 : yyyyMMddHHmmss 13 altResult Integer 3 대체문자 통신사 결과코드 → [참고] 통신사 결과코드(대체문자) 14 altResultDT String 14 대체문자 전송결과 수신일시 → 형식 : yyyyMMddHHmmss 15 receiptNum String 18 접수번호 16 requestNum String 36 요청번호 17 interOPRefKey String 20 파트너 지정키 → 카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

예외

EPopbillException

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

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

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

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

function Search(corpNum : String; sDate : String; eDate : String; state : Array Of String; item : Array Of String; reserveYN : String; SenderYN : boolean; page : Integer; perpage : Integer; order : String; qString : String; userID : String) : TKakaoSearchList;

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

요청

Parameters

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

응답

KakaoSearchResult

순번	변수명	타입	길이	설명
1	code	long	-	API 처리에 대한 응답코드 1 성공
2	message	String	-	API 처리에 대한 응답메시지
3	total	Integer	-	총 검색결과 건수
4	perPage	Integer	-	페이지 당 목록 건수
5	pageNum	Integer	-	페이지 번호
6	pageCount	Integer	-	페이지 개수
7	list	KakaoSentDetail[ ]	1,000	전송결과 정보
KakaoSentDetail[ ] 순번 변수명 타입 길이 설명 1 state Integer 1 상태코드 → [참고] 팝빌 상태코드 2 sendDT String 14 전송일시 → 형식 : yyyyMMddHHmmss 3 result Integer 3 카카오 결과코드 → [참고] 카카오 결과코드(카카오톡) ✓ {state} = 3 경우 카카오톡 전송결과 확인 가능 4 resultDT String 14 전송결과 수신일시 → 형식 : yyyyMMddHHmmss 5 contentType Integer - 카카오톡 유형 1 알림톡 4 알림톡 이미지 6 receiveNum String 20 수신번호 7 receiveName String 70 수신자명 8 content String 1,300 카카오톡 내용 9 altSubject String 64 대체문자 제목 → 단위 : byte 10 altContent String 2,000 대체문자 내용 → 단위 : byte 11 altContentType Integer 1 대체문자 전송타입 4 단문 6 장문 12 altSendDT String 14 대체문자 전송일시 → 형식 : yyyyMMddHHmmss 13 altResult Integer 3 대체문자 통신사 결과코드 → [참고] 통신사 결과코드(대체문자) 14 altResultDT String 14 대체문자 전송결과 수신일시 → 형식 : yyyyMMddHHmmss 15 receiptNum String 18 접수번호 16 requestNum String 36 요청번호 17 interOPRefKey String 20 파트너 지정키 → 카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

예외

EPopbillException

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

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

미리보기

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

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

function GetSentListURL(corpNum : String; userID : String) : String;

요청

Parameters

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

응답

String - 요청에 대한 응답 URL

예외

EPopbillException

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