3. 정보확인
3.1. GetFaxDetail - 전송내역 확인 (접수번호)
- 팝빌에서 반환 받은 접수번호를 통해 팩스 전송상태 및 결과를 확인합니다.
def getFaxDetail(corpNum, receiptNum, userID = '')Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| receiptNum | String | 18 | Y | 팩스 전송요청시 발급받은 접수번호 | |
| userID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
3.2. GetFaxDetailRN - 전송내역 확인 (요청번호)
- 파트너가 할당한 요청번호를 통해 팩스 전송상태 및 결과를 확인합니다.
def getFaxDetailRN(corpNum, requestNum, userID = '')Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| requestNum | String | 36 | Y | 팩스 전송요청시 파트너가 할당한 요청번호 | |
| userID | String | 50 | N | 팝빌회원 아이디 |
Return
Throws
3.3. Search - 전송내역 목록 조회
-
검색조건에 해당하는 팩스 전송내역 목록을 조회합니다. (조회기간 단위 : 최대 2개월)
※ 팩스 접수일시로부터 2개월 이내 접수건만 조회할 수 있습니다.
def search(corpNum, sDate, eDate, state, reserveYN, senderOnly, page, perPage, order, userID = '', queryString = '')Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| sDate | String | 8 | Y |
조회 기간의 시작일자
형식 : yyyyMMdd
|
|
| eDate | String | 8 | Y |
조회 기간의 종료일자
형식 : yyyyMMdd
|
|
| state | Array | N |
전송상태 (다중 선택 가능)
기본값 : 전체조회
|
||
| reserveYN | Boolean | - | N |
예약여부
True예약전송건
False전체조회 : 기본값
|
|
| senderOnly | Boolean | - | N |
개인조회 여부
true해당 담당자 계정으로 접수한 팩스만 조회 (개인권한)
false접수한 팩스 전체 조회 (관리자권한) : 기본값
|
|
| page | Integer | - | N |
목록 페이지번호
기본값 : 1
|
|
| perPage | Integer | - | N |
페이지당 표시할 목록 건수
최대 : 1,000건
기본값 : 500건
|
|
| order | String | 1 | N |
팩스 접수일시를 기준으로 하는 목록 정렬 방향
D내림차순 : 기본값
A오름차순
|
|
| userID | String | 50 | N | 팝빌회원 아이디 | |
| queryString | String | - | N |
조회하고자 하는 발신자명 또는 수신자명
기본값 : 전체조회
|
|
Return
Throws
3.4. GetSentListURL - 팩스 전송내역 팝업 URL
- 팩스 전송내역 확인 페이지의 팝업 URL을 반환합니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getSentListURL(corpNum, userID)Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| userID | String | 50 | N | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL
Throws
3.5. GetPreviewURL - 팩스 변환결과 확인 팝업 URL
- 팩스 변환결과 확인 팝업 URL을 반환하며, 팩스전송을 위한 TIF 포맷 변환 완료 후 호출 할 수 있습니다.
- 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
def getPreviewURL(corpNum, receiptNum, userID = '')Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| corpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| receiptNum | String | 18 | Y | 팩스 전송요청시 팝빌로부터 반환 받은 접수번호 | |
| userID | String | 50 | N | 팝빌회원 아이디 |
Return
String - 요청에 대한 응답 URL