전송결과

1. Getfaxresult - 전송내역 확인 (접수번호)

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

subroutine getfaxresult(string corpnum, string receiptnum, ref faxresult ref_result[]) throws popbillexception

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	receiptnum	string	18	Y	팝빌에서 할당한 접수번호
3	ref_result	ref FaxResult[ ]	-	Y	서브루틴 반환 결과값
ref FaxResult[ ] 순번 변수명 타입 길이 필수 설명 1 state integer 1 N 상태코드 → [참고] 팝빌 상태코드 2 result integer 3 N 결과코드 → [참고] 통신사 결과코드 ✓ {state} = 3 경우 팩스 전송결과 확인 가능 3 sendNum string 20 N 발신번호 4 senderName string 30 N 발신자명 5 receiveNum string 20 N 수신번호 6 receiveNumType string 2 N 수신번호 유형 일반 일반망 (지능망을 제외한 번호) 지능 지능망 (030*, 050*, 070*, 080*, 대표번호) 7 receiveName string 30 N 수신자명 8 title string 100 N 팩스제목 9 sendPageCnt integer - N 전체 페이지수 10 successPageCnt integer - N 성공 페이지수 11 failPageCnt integer - N 실패 페이지수 12 cancelPageCnt integer - N 취소 페이지수 13 reserveDT string 14 N 예약일시 → 형식 : yyyyMMddHHmmss 14 receiptDT string 14 N 접수일시 → 형식 : yyyyMMddHHmmss 15 sendDT string 14 N 전송일시 → 형식 : yyyyMMddHHmmss 16 resultDT string 14 N 전송결과 수신일시 → 형식 : yyyyMMddHHmmss 17 fileNames string[ ] - N 전송 파일명 리스트 → 최대 : 30개 18 receiptNum string 18 N 팝빌에서 할당한 접수번호 19 requestnum string 36 N 파트너가 할당한 요청번호 20 interOPRefKey string 20 N 파트너 지정키 → 팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값 21 chargePageCnt integer - N 과금 페이지수 22 refundPageCnt integer - N 환불 페이지수 23 tiffFileSize string - N 변환파일용량 → 단위 : byte

응답

faxresult[ ] - 요청 파라미터의 ref_result 확인

예외

PopbillException

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

2. Getfaxresultrn - 전송내역 확인 (요청번호)

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

subroutine getfaxresultrn(string corpnum, string requestnum, ref faxresult ref_result[]) throws popbillexception

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	requestnum	string	36	Y	파트너가 할당한 요청번호
3	ref_result	ref FaxResult[ ]	-	Y	서브루틴 반환 결과값
ref FaxResult[ ] 순번 변수명 타입 길이 필수 설명 1 state integer 1 N 상태코드 → [참고] 팝빌 상태코드 2 result integer 3 N 결과코드 → [참고] 통신사 결과코드 ✓ {state} = 3 경우 팩스 전송결과 확인 가능 3 sendNum string 20 N 발신번호 4 senderName string 30 N 발신자명 5 receiveNum string 20 N 수신번호 6 receiveNumType string 2 N 수신번호 유형 일반 일반망 (지능망을 제외한 번호) 지능 지능망 (030*, 050*, 070*, 080*, 대표번호) 7 receiveName string 30 N 수신자명 8 title string 100 N 팩스제목 9 sendPageCnt integer - N 전체 페이지수 10 successPageCnt integer - N 성공 페이지수 11 failPageCnt integer - N 실패 페이지수 12 cancelPageCnt integer - N 취소 페이지수 13 reserveDT string 14 N 예약일시 → 형식 : yyyyMMddHHmmss 14 receiptDT string 14 N 접수일시 → 형식 : yyyyMMddHHmmss 15 sendDT string 14 N 전송일시 → 형식 : yyyyMMddHHmmss 16 resultDT string 14 N 전송결과 수신일시 → 형식 : yyyyMMddHHmmss 17 fileNames string[ ] - N 전송 파일명 리스트 → 최대 : 30개 18 receiptNum string 18 N 팝빌에서 할당한 접수번호 19 requestnum string 36 N 파트너가 할당한 요청번호 20 interOPRefKey string 20 N 파트너 지정키 → 팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값 21 chargePageCnt integer - N 과금 페이지수 22 refundPageCnt integer - N 환불 페이지수 23 tiffFileSize string - N 변환파일용량 → 단위 : byte

응답

faxresult[ ] - 요청 파라미터의 ref_result 확인

예외

PopbillException

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

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

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

• 팩스 접수일시로부터 6개월 이내 접수건만 조회할 수 있습니다.

function faxsearchresult search(string corpnum, string sdate, string edate, string state[], boolean reserveyn, boolean senderonly, string order, int page, int perpage, string qstring) throws popbillexception

매개변수 Page, PerPage, Order를 이용하여 페이징 기능을 구현할 수 있습니다.

요청

Parameters

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

응답

FAXSearchResult

순번	변수명	타입	길이	설명
1	code	string	-	API 처리에 대한 응답코드 1 성공
2	message	string	-	API 처리에 대한 응답메시지
3	total	string	-	총 검색결과 건수
4	perPage	string	-	페이지당 목록 건수
5	pageNum	string	-	페이지 번호
6	pageCount	string	-	페이지 개수
7	list	FaxResult[ ]	-	전송결과 정보 → 최대 : 1,000건
FaxResult[ ] 순번 변수명 타입 길이 설명 1 state integer 1 상태코드 → [참고] 팝빌 상태코드 2 result integer 3 결과코드 → [참고] 통신사 결과코드 ✓ {state} = 3 경우 팩스 전송결과 확인 가능 3 sendNum string 20 발신번호 4 senderName string 30 발신자명 5 receiveNum string 20 수신번호 6 receiveNumType string 2 수신번호 유형 일반 일반망 (지능망을 제외한 번호) 지능 지능망 (030*, 050*, 070*, 080*, 대표번호) 7 receiveName string 30 수신자명 8 title string 100 팩스제목 9 sendPageCnt integer - 전체 페이지수 10 successPageCnt integer - 성공 페이지수 11 failPageCnt integer - 실패 페이지수 12 cancelPageCnt integer - 취소 페이지수 13 reserveDT string 14 예약일시 → 형식 : yyyyMMddHHmmss 14 receiptDT string 14 접수일시 → 형식 : yyyyMMddHHmmss 15 sendDT string 14 전송일시 → 형식 : yyyyMMddHHmmss 16 resultDT string 14 전송결과 수신일시 → 형식 : yyyyMMddHHmmss 17 fileNames string[ ] - 전송 파일명 리스트 → 최대 : 30개 18 receiptNum string 18 팝빌에서 할당한 접수번호 19 requestnum string 36 파트너가 할당한 요청번호 20 interOPRefKey string 20 파트너 지정키 → 팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값 21 chargePageCnt integer - 과금 페이지수 22 refundPageCnt integer - 환불 페이지수 23 tiffFileSize string - 변환파일용량 → 단위 : byte

예외

PopbillException

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

4. GetSentListURL - 팩스 전송내역 팝업 URL

미리보기

팩스 전송내역 팝업 URL을 반환합니다.

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

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

요청

Parameters

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

응답

string - 요청에 대한 응답 URL

예외

PopbillException

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

5. GetPreviewURL - 팩스 변환파일 확인 팝업 URL

미리보기

팩스 1건의 변환파일을 확인하는 팝업 URL을 반환합니다.

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

function string getpreviewurl(string corpnum, string receiptnum, string userid) throws popbillexception

요청

Parameters

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

응답

string - 요청에 대한 응답 URL

예외

PopbillException

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