전송결과

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

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

faxService.getFaxResult(CorpNum, ReceiptNum, UserID, success, error)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ReceiptNum	string	18	Y	팝빌에서 할당한 접수번호
3	UserID	string	50	N	팝빌회원 아이디
4	success	function	-	Y	성공에 대한 콜백 함수
5	error	function	-	Y	실패에 대한 콜백 함수

응답

FaxResult[ ]

순번	변수명	타입	길이	설명
1	state	number	1	상태코드 → [참고] 팝빌 상태코드
2	result	number	3	결과코드 → [참고] 통신사 결과코드 ✓ {state} = 3 경우 팩스 전송결과 확인 가능
3	sendNum	string	20	발신번호
4	senderName	string	100	발신자명
5	receiveNum	string	20	수신번호
6	receiveNumType	string	2	수신번호 유형 일반 일반망 (지능망을 제외한 번호) 지능 지능망 (030*, 050*, 070*, 080*, 대표번호)
7	receiveName	string	30	수신자명
8	title	string	100	팩스제목
9	sendPageCnt	number	-	전체 페이지수
10	successPageCnt	number	-	성공 페이지수
11	failPageCnt	number	-	실패 페이지수
12	cancelPageCnt	number	-	취소 페이지수
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	number	-	과금 페이지수
22	refundPageCnt	number	-	환불 페이지수
23	tiffFileSize	string	-	변환파일용량 → 단위 : byte

예외

PopbillException

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

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

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

faxService.getFaxResultRN(CorpNum, RequestNum, UserID, success, error)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	RequestNum	string	36	Y	파트너가 할당한 요청번호
3	UserID	string	50	N	팝빌회원 아이디
4	success	function	-	Y	성공에 대한 콜백 함수
5	error	function	-	Y	실패에 대한 콜백 함수

응답

FaxResult[ ]

순번	변수명	타입	길이	설명
1	state	number	1	상태코드 → [참고] 팝빌 상태코드
2	result	number	3	결과코드 → [참고] 통신사 결과코드 ✓ {state} = 3 경우 팩스 전송결과 확인 가능
3	sendNum	string	20	발신번호
4	senderName	string	100	발신자명
5	receiveNum	string	20	수신번호
6	receiveNumType	string	2	수신번호 유형 일반 일반망 (지능망을 제외한 번호) 지능 지능망 (030*, 050*, 070*, 080*, 대표번호)
7	receiveName	string	30	수신자명
8	title	string	100	팩스제목
9	sendPageCnt	number	-	전체 페이지수
10	successPageCnt	number	-	성공 페이지수
11	failPageCnt	number	-	실패 페이지수
12	cancelPageCnt	number	-	취소 페이지수
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	number	-	과금 페이지수
22	refundPageCnt	number	-	환불 페이지수
23	tiffFileSize	string	-	변환파일용량 → 단위 : byte

예외

PopbillException

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

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

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

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

faxService.search(CorpNum, SDate, EDate, State, ReserveYN, SenderOnly, Order, Page, PerPage, QString, UserID, success, error)

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

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	SDate	string	8	Y	검색 시작일자 → 형식 : yyyyMMdd
3	EDate	string	8	Y	검색 종료일자 → 형식 : yyyyMMdd
4	State	Array	-	N	전송상태 (다중 선택 가능) 1 대기 2 성공 3 실패 4 취소 ※ 기본값 : 전체조회
5	ReserveYN	boolean	-	N	예약여부 true 예약전송건 false 즉시전송건 ※ 기본값 : 전체조회
6	SenderOnly	boolean	-	N	개인조회 여부 true 팝빌회원 아이디(userID)로 전송한 팩스만 조회 false 전송한 팩스 전체 조회 : 기본값
7	Order	string	1	N	팩스 접수일시를 기준으로 하는 목록 정렬 방향 D 내림차순 : 기본값 A 오름차순
8	Page	number	-	N	목록 페이지번호 ※ 기본값 : 1
9	PerPage	number	-	N	페이지당 표시할 목록 건수 → 최대 : 1,000건 ※ 기본값 : 500건
10	QString	string	-	N	조회 검색어(발신자명, 수신자명, 수신번호) ※ 기본값 : 전체조회
11	UserID	string	50	N	팝빌회원 아이디
12	success	function	-	Y	성공에 대한 콜백 함수
13	error	function	-	Y	실패에 대한 콜백 함수

응답

FAXSearchResult

순번	변수명	타입	길이	설명
1	code	number	-	API 처리에 대한 응답코드 1 성공
2	message	string	-	API 처리에 대한 응답메시지
3	total	number	-	총 검색결과 건수
4	perPage	number	-	페이지당 목록 건수
5	pageNum	number	-	페이지 번호
6	pageCount	number	-	페이지 개수
7	list	FaxResult[]	1,000	전송결과 정보 → 최대 : 1,000건
FaxResult[] 순번 변수명 타입 길이 설명 1 state number 1 상태코드 → [참고] 팝빌 상태코드 2 result number 3 결과코드 → [참고] 통신사 결과코드 ✓ {state} = 3 경우 팩스 전송결과 확인 가능 3 sendNum string 20 발신번호 4 senderName string 100 발신자명 5 receiveNum string 20 수신번호 6 receiveNumType string 2 수신번호 유형 일반 일반망 (지능망을 제외한 번호) 지능 지능망 (030*, 050*, 070*, 080*, 대표번호) 7 receiveName string 30 수신자명 8 title string 100 팩스제목 9 sendPageCnt number - 전체 페이지수 10 successPageCnt number - 성공 페이지수 11 failPageCnt number - 실패 페이지수 12 cancelPageCnt number - 취소 페이지수 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 number - 과금 페이지수 22 refundPageCnt number - 환불 페이지수 23 tiffFileSize string - 변환파일용량 → 단위 : byte

예외

PopbillException

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

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

미리보기

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

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

faxService.getSentListURL(CorpNum, UserID, success, error)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	UserID	string	50	N	팝빌회원 아이디
3	success	function	-	Y	성공에 대한 콜백 함수
4	error	function	-	Y	실패에 대한 콜백 함수

응답

string - 요청에 대한 응답 URL

예외

PopbillException

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

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

미리보기

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

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

faxService.getPreviewURL(CorpNum, ReceiptNum, UserID, success, error)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpNum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ReceiptNum	string	18	Y	팝빌에서 할당한 접수번호
3	UserID	string	50	N	팝빌회원 아이디
4	success	function	-	Y	성공에 대한 콜백 함수
5	error	function	-	Y	실패에 대한 콜백 함수

응답

string - 요청에 대한 응답 URL

예외

PopbillException

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