전송결과

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

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

Function GetMessages(CorpNum As String, receiptNum As String, Optional UserID As String = "") As Collection

요청

Parameters

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

응답

PBFaxInfo

순번	변수명	타입	길이	설명
1	state	Integer	1	상태코드 → [참고] 팝빌 상태코드
2	result	Integer	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	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	Collection	30	전송 파일명 리스트
18	receiptNum	String	18	팝빌에서 할당한 접수번호
19	requestNum	String	36	파트너가 할당한 요청번호
20	interOPRefKey	String	20	파트너 지정키 → 팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
21	chargePageCnt	Integer	-	과금 페이지수
22	refundPageCnt	Integer	-	환불 페이지수
23	tiffFileSize	String	-	변환파일용량 → 단위 : byte

예외

Err

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

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

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

Function GetMessagesRN(CorpNum As String, requestNum As String, Optional UserID As String = "") As Collection

요청

Parameters

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

응답

PBFaxInfo

순번	변수명	타입	길이	설명
1	state	Integer	1	상태코드 → [참고] 팝빌 상태코드
2	result	Integer	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	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	Collection	30	전송 파일명 리스트
18	receiptNum	String	18	팝빌에서 할당한 접수번호
19	requestNum	String	36	파트너가 할당한 요청번호
20	interOPRefKey	String	20	파트너 지정키 → 팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
21	chargePageCnt	Integer	-	과금 페이지수
22	refundPageCnt	Integer	-	환불 페이지수
23	tiffFileSize	String	-	변환파일용량 → 단위 : byte

예외

Err

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

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

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

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

Function Search(CorpNum As String, SDate As String, EDate As String, state As Collection, ReserveYN As Boolean, SenderOnly As Boolean, Page As Integer, PerPage As Integer, Order As String, Optional QString As String = "") As PBFaxSearchList

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

요청

Parameters

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

응답

PBFaxSearchList

순번	변수명	타입	길이	설명
1	code	Integer	-	API 처리에 대한 응답코드 1 성공
2	message	String	-	API 처리에 대한 응답메시지
3	total	Integer	-	총 검색결과 건수
4	perPage	Integer	-	페이지당 목록 건수
5	pageNum	Integer	-	페이지 번호
6	pageCount	Integer	-	페이지 개수
7	list	PBFaxInfo[ ]	-	전송결과 정보 → 최대 : 1,000건
PBFaxInfo[ ] 순번 변수명 타입 길이 설명 1 state Integer 1 상태코드 → [참고] 팝빌 상태코드 2 result Integer 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 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 Collection 30 전송 파일명 리스트 18 receiptNum String 18 팝빌에서 할당한 접수번호 19 requestNum String 36 파트너가 할당한 요청번호 20 interOPRefKey String 20 파트너 지정키 → 팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값 21 chargePageCnt Integer - 과금 페이지수 22 refundPageCnt Integer - 환불 페이지수 23 tiffFileSize String - 변환파일용량 → 단위 : byte

예외

Err

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

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

미리보기

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

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

Function GetSentListURL(CorpNum As String, UserID As String) As String

요청

Parameters

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

응답

String - 요청에 대한 응답 URL

예외

Err

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

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

미리보기

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

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

Function GetPreviewURL(CorpNum As String, receiptNum As String, UserID As String) As String

요청

Parameters

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

응답

String - 요청에 대한 응답 URL

예외

Err

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