전송결과

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

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

function kakaoResult getmessages(string corpnum, string receiptnum, string userid) throws popbillexception

요청

Parameters

변수명	타입	길이	필수	설명
corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
receiptnum	string	18	Y	팝빌에서 할당한 접수번호
userid	string	50	N	팝빌회원 아이디

응답

KakaoResult

순번

변수명

타입

길이

설명

contentType

string

카카오톡 유형

1알림톡

4알림톡 이미지

templateCode

string

템플릿 코드

알림톡 전송 시 반환

plusFriendID

string

검색용 아이디

sendNum

string

발신번호

altSubject

string

대체문자 제목

단위 : byte

altContent

string

2,000

대체문자 내용

단위 : byte

altSendType

string

대체문자 유형

null미전송

C카카오톡과 동일 내용 전송

A대체문자 내용 전송

reserveDT

string

예약일시

형식 : yyyyMMddHHmmss

adsYN

boolean

광고메시지 전송 여부

true광고

false일반

sendCnt

string

전송건수

successCnt

string

성공건수

failCnt

string

실패건수

altCnt

string

대체문자 건수

cancelCnt

string

취소건수

btns

KakaoButton[ ]

버튼 목록

최대 : 5개

변수명	타입	길이	설명
n	string	14	버튼명
t	string	2	버튼유형 WL웹링크 AL앱링크 DS배송조회 - 알림톡 전용 MD메시지전달 BK봇키워드 AC채널추가
u1	string	1,000	버튼링크 - {t} = "AL" 경우 iOS 앱링크 적용 - {t} = "WL" 경우 Mobile 웹링크 적용
u2	string	1,000	버튼링크 - {t} = "AL" 경우 Android 앱링크 적용 - {t} = "WL" 경우 PC 웹링크 적용

msgs

KakaoResultMSG[ ]

1,000

전송결과 정보

변수명	타입	길이	설명
state	integer	1	상태코드 [참고] 팝빌 상태코드
sendDT	string	14	전송일시 형식 : yyyyMMddHHmmss
result	integer	3	카카오 결과코드 {state} = 3 경우 카카오톡 전송결과 확인 가능 [참고] 카카오 결과코드(카카오톡)
resultDT	string	14	전송결과 수신일시 형식 : yyyyMMddHHmmss
contentType	string	-	카카오톡 유형 1알림톡 4알림톡 이미지
receiveNum	string	20	수신번호
receiveName	string	70	수신자명
content	string	1,300	카카오톡 내용
altSubject	string	64	대체문자 제목 단위 : byte
altContent	string	2,000	대체문자 내용 단위 : byte
altContentType	integer	1	대체문자 전송타입 4단문 6장문
altSendDT	string	14	대체문자 전송일시 형식 : yyyyMMddHHmmss
altResult	integer	3	대체문자 통신사 결과코드 [참고] 통신사 결과코드(대체문자)
altResultDT	string	14	대체문자 전송결과 수신일시 형식 : yyyyMMddHHmmss
receiptNum	string	18	접수번호
requestNum	string	36	요청번호
interOPRefKey	string	20	파트너 지정키 카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

예외

PopbillException

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

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

function kakaoResult getmessagesrn(string corpnum, string requestnum, string userid) throws popbillexception

요청

Parameters

변수명	타입	길이	필수	설명
corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
requestnum	string	36	Y	파트너가 할당한 요청번호
userid	string	50	N	팝빌회원 아이디

응답

KakaoResult

순번

변수명

타입

길이

설명

contentType

string

카카오톡 유형

1알림톡

4알림톡 이미지

templateCode

string

템플릿 코드

알림톡 전송 시 반환

plusFriendID

string

검색용 아이디

sendNum

string

발신번호

altSubject

string

대체문자 제목

단위 : byte

altContent

string

2,000

대체문자 내용

단위 : byte

altSendType

string

대체문자 유형

null미전송

C카카오톡과 동일 내용 전송

A대체문자 내용 전송

reserveDT

string

예약일시

형식 : yyyyMMddHHmmss

adsYN

boolean

광고메시지 전송 여부

true광고

false일반

sendCnt

string

전송건수

successCnt

string

성공건수

failCnt

string

실패건수

altCnt

string

대체문자 건수

cancelCnt

string

취소건수

btns

KakaoButton[ ]

버튼 목록

최대 : 5개

변수명	타입	길이	설명
n	string	14	버튼명
t	string	2	버튼유형 WL웹링크 AL앱링크 DS배송조회 - 알림톡 전용 MD메시지전달 BK봇키워드 AC채널추가
u1	string	1,000	버튼링크 - {t} = "AL" 경우 iOS 앱링크 적용 - {t} = "WL" 경우 Mobile 웹링크 적용
u2	string	1,000	버튼링크 - {t} = "AL" 경우 Android 앱링크 적용 - {t} = "WL" 경우 PC 웹링크 적용

msgs

KakaoResultMSG[ ]

1,000

전송결과 정보

변수명	타입	길이	설명
state	integer	1	상태코드 [참고] 팝빌 상태코드
sendDT	string	14	전송일시 형식 : yyyyMMddHHmmss
result	integer	3	카카오 결과코드 {state} = 3 경우 카카오톡 전송결과 확인 가능 [참고] 카카오 결과코드(카카오톡)
resultDT	string	14	전송결과 수신일시 형식 : yyyyMMddHHmmss
contentType	string	-	카카오톡 유형 1알림톡 4알림톡 이미지
receiveNum	string	20	수신번호
receiveName	string	70	수신자명
content	string	1,300	카카오톡 내용
altSubject	string	64	대체문자 제목 단위 : byte
altContent	string	2,000	대체문자 내용 단위 : byte
altContentType	integer	1	대체문자 전송타입 4단문 6장문
altSendDT	string	14	대체문자 전송일시 형식 : yyyyMMddHHmmss
altResult	integer	3	대체문자 통신사 결과코드 [참고] 통신사 결과코드(대체문자)
altResultDT	string	14	대체문자 전송결과 수신일시 형식 : yyyyMMddHHmmss
receiptNum	string	18	접수번호
requestNum	string	36	요청번호
interOPRefKey	string	20	파트너 지정키 카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

예외

PopbillException

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

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

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

function kakaosearchresult search(string corpnum, string sdate, string edate, string state[], string item[], string reserveyn, boolean senderyn, string order, int page, int perpage, string userid, string qstring) throws popbillexception

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

요청

Parameters

변수명	타입	길이	필수	설명
corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
sdate	string	8	Y	검색 시작일자 형식 : yyyyMMdd
edate	string	8	Y	검색 종료일자 형식 : yyyyMMdd
state	string[ ]		Y	전송상태 (다중 선택 가능) 0전송대기 1전송중 2전송성공 3대체문자 전송성공 4전송실패 5예약취소
item	string[ ]		N	검색대상 ATS알림톡 기본값 : 전체조회
reserveyn	string	-	N	전송유형별 조회 (택 1) 0즉시전송건 1예약전송건 기본값 : 전체조회
senderyn	boolean	-	N	사용자권한별 조회 true팝빌회원 아이디(userID)로 전송한 카카오톡만 조회 false전송한 카카오톡 전체 조회 : 기본값
order	string	1	N	카카오톡 접수일시를 기준으로 하는 목록 정렬 방향 D내림차순 : 기본값 A오름차순
page	int	-	N	목록 페이지번호 기본값 : 1
perpage	int	-	N	페이지당 표시할 목록 건수 최대 : 1,000건 기본값 : 500건
userid	string	50	N	팝빌회원 아이디
qstring	string	-	N	조회 검색어(수신자명, 수신번호) 기본값 : 전체조회

응답

KakaoSearchResult

순번

변수명

타입

길이

설명

code

string

API 처리에 대한 응답코드

1성공

message

string

API 처리에 대한 응답메시지

total

string

총 검색결과 건수

perPage

string

페이지 당 목록 건수

pageNum

string

페이지 번호

pageCount

string

페이지 개수

list

KakaoResultMSG[ ]

1,000

전송결과 정보

변수명	타입	길이	설명
state	integer	1	상태코드 [참고] 팝빌 상태코드
sendDT	string	14	전송일시 형식 : yyyyMMddHHmmss
result	integer	3	카카오 결과코드 {state} = 3 경우 카카오톡 전송결과 확인 가능 [참고] 카카오 결과코드(카카오톡)
resultDT	string	14	전송결과 수신일시 형식 : yyyyMMddHHmmss
contentType	string	-	카카오톡 유형 1알림톡 4알림톡 이미지
receiveNum	string	20	수신번호
receiveName	string	70	수신자명
content	string	1,300	카카오톡 내용
altSubject	string	64	대체문자 제목 단위 : byte
altContent	string	2,000	대체문자 내용 단위 : byte
altContentType	integer	1	대체문자 전송타입 4단문 6장문
altSendDT	string	14	대체문자 전송일시 형식 : yyyyMMddHHmmss
altResult	integer	3	대체문자 통신사 결과코드 [참고] 통신사 결과코드(대체문자)
altResultDT	string	14	대체문자 전송결과 수신일시 형식 : yyyyMMddHHmmss
receiptNum	string	18	접수번호
requestNum	string	36	요청번호
interOPRefKey	string	20	파트너 지정키 카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

예외

PopbillException

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

function string getSentListURL(string corpnum, string userid) throws popbillexception

요청

Parameters

순번	변수명	타입	길이	필수	설명
	corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
	userid	string	50	N	팝빌회원 아이디

응답

string - 요청에 대한 응답 URL

예외

PopbillException