Index

1. 발신번호 관리

1.1. CheckSenderNumber - 발신번호 등록여부 확인

ㆍ팩스 발신번호 등록여부를 확인합니다.

ㆍ발신번호 상태가 '승인'인 경우에만 리턴값 'Response'의 변수 'code'가 1로 반환됩니다.

String checkSenderNumber(String CorpNum, String SenderNumber, String UserID) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 SenderNumber String 20 O 확인할 발신번호
3 UserID String 50 - 팝빌회원 아이디

Return

Response - code : 0 (미등록) / code : 1 (등록)

Throws

PopbillException

1.2. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL

ㆍ발신번호를 등록하고 내역을 확인하는 팩스 발신번호 관리 페이지 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

String getSenderNumberMgtURL(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

1.3. GetSenderNumberList - 발신번호 목록 확인

ㆍ팝빌에 등록한 연동회원의 팩스 발신번호 목록을 확인합니다.

SenderNumber[] getSenderNumberList(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

SenderNumber[ ]

Throws

PopbillException

2. 팩스전송

접수번호(recieptNum)

  • 작업(접수) 단위를 나타내는 고유한 식별정보로 팩스 전송 함수 호출시 팝빌로부터 반환받는 값
  • 예약접수 건을 취소하거나, 전송내역 및 실패사유를 확인하기 위한 값

cf. 다건접수(동보) 경우에도 하나의 접수번호만을 반환

2.1. SendFAX - 팩스 전송

ㆍ팩스 1건을 전송합니다. (최대 전송파일 개수: 20개)

String sendFAX(String corpNum, String sendNum, String receiveNum, String receiveName, File[] files, Date reserveDT, String userID, Boolean adsYN, String title, String requestNum) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 sendNum String 20 O 발신번호
└ 함수 [1.2. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL] 또는 [1.3. GetSenderNumberList - 발신번호 목록 확인] 호출하여 등록 내역 확인 가능
※ 팝빌에 등록되지 않은 번호를 입력하는 경우 '원발신번호'로 팩스 전송됨
3 receiveNum String 20 O 수신번호
4 receiveName String 30 O 수신자명
5 files File[ ] 20 O [배열] 전송파일 (최대 20개)
6 reserveDT Date 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
7 userID String 50 - 팝빌회원 아이디
8 adsYN Boolean - - 광고메시지 전송여부 : true / false 중 택 1
└ true = 광고, false = 일반
※ 미입력시 기본값 false 처리
9 title String 100 - 팩스제목
10 requestNum String 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 부여하는 식별번호
└ 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

Return

String - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.2. SendFAX - 팩스 전송 (동보전송)

ㆍ동일한 팩스파일을 다수의 수신자에게 전송하기 위해 팝빌에 접수합니다. (최대 전송파일 개수 : 20개) (최대 1,000건)

String sendFAX(String corpNum, String sendNum, String senderName, Receiver[] receivers, File[] files, Date reserveDT, String userID, Boolean adsYN, String title, String requestNum) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 sendNum String 20 O 발신번호
└ 함수 [1.2. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL] 또는 [1.3. GetSenderNumberList - 발신번호 목록 확인] 호출하여 등록 내역 확인 가능
※ 팝빌에 등록되지 않은 번호를 입력하는 경우 '원발신번호'로 팩스 전송됨
3 senderName String 100 - 발신자명
4 receivers Receiver[ ] 1000 O [배열] 수신자 정보 (최대 1,000건)
5 files File[ ] 20 O [배열] 전송파일 (최대 20개)
6 reserveDT Date 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
7 userID String 50 - 팝빌회원 아이디
8 adsYN Boolean - - 광고메시지 전송여부 : true / false 중 택 1
└ true = 광고, false = 일반
※ 미입력시 기본값 false 처리
9 title String 100 - 팩스제목
10 requestNum String 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 부여하는 식별번호
└ 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

Return

String - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.3. SendFAXBinary - 팩스 전송 (바이너리)

ㆍ전송할 파일의 바이너리 데이터를 팩스 1건 전송합니다. (최대 전송파일 개수: 20개)

String sendFAXBinary(String corpNum, String sendNum, String receiveNum, String receiveName, FaxUploadFile[] files, Date reserveDT, String userID, Boolean adsYN, String title, String requestNum) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 sendNum String 20 O 발신번호
└ 함수 [1.2. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL] 또는 [1.3. GetSenderNumberList - 발신번호 목록 확인] 호출하여 등록 내역 확인 가능
※ 팝빌에 등록되지 않은 번호를 입력하는 경우 '원발신번호'로 팩스 전송됨
3 receiveNum String 20 O 수신번호
4 receiveName String 30 O 수신자명
5 files FaxUploadFile[ ] 20 O [배열] 전송할 파일의 객체정보 (최대 20개)
6 reserveDT Date 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
7 userID String 50 - 팝빌회원 아이디
8 adsYN boolean - - 광고메시지 전송여부 : true (광고) / false (일반) 중 택 1
※ 미입력시 기본값 false 처리
9 Title String 100 - 팩스제목
10 RequestNum String 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 부여하는 식별번호
└ 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

Return

String - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.4. SendFAXBinary - 팩스 전송 (바이너리 동보전송)

ㆍ동일한 파일의 바이너리 데이터를 다수의 수신자에게 전송하기 위해 팝빌에 접수합니다. (최대 전송파일 개수 : 20개) (최대 1,000건)

String sendFAXBinary(String corpNum, String sendNum, String senderName, Receiver[] receivers, FaxUploadFile[] files, Date reserveDT, String userID, Boolean adsYN, String title, String requestNum) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 sendNum String 20 O 발신번호
└ 함수 [1.2. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL] 또는 [1.3. GetSenderNumberList - 발신번호 목록 확인] 호출하여 등록 내역 확인 가능
※ 팝빌에 등록되지 않은 번호를 입력하는 경우 '원발신번호'로 팩스 전송됨
3 senderName String 100 - 발신자명
4 receivers Receiver[ ] 1000 O [배열] 수신자 정보 (최대 1,000건)
5 files FaxUploadFile[ ] 20 O [배열] 전송할 파일의 객체정보 (최대 20개)
6 reserveDT Date 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
7 userID String 50 - 팝빌회원 아이디
8 adsYN Boolean - - 광고메시지 전송여부 : true (광고) / false (일반) 중 택 1
※ 미입력시 기본값 false 처리
9 title String 100 - 팩스제목
10 requestNum String 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 부여하는 식별번호
└ 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

Return

String - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.5. ResendFAX - 팩스 재전송 (접수번호)

ㆍ팝빌에서 반환받은 접수번호를 통해 팩스 1건을 재전송합니다.

ㆍ발신/수신 정보 미입력시 기존과 동일한 정보로 팩스가 전송되고, 접수일 기준 최대 60일이 경과되지 않는 건만 재전송이 가능합니다.

String resendFAX(String corpNum, String receiptNum, String sendNum, String senderName, String receiveNum, String receiveName, Date reserveDT, String userID, String title, String requestNum) throws PopbillException

ㆍ변환실패 사유로 전송실패한 팩스 접수건은 재전송이 불가합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 receiptNum String 18 O 원본 팩스 접수번호
3 sendNum String 20 - 발신번호
※ 미입력시 원본 팩스 전송정보로 전송
4 senderName String 30 - 발신자명
※ 미입력시 원본 팩스 전송정보로 전송
5 receiveNum String 20 - 수신번호
※ 미입력시 원본 팩스 전송정보로 전송
6 receiveName String 30 - 수신자명
※ 미입력시 원본 팩스 전송정보로 전송
7 reserveDT Date 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
8 userID String 50 - 팝빌회원 아이디
9 title String 100 - 팩스제목
10 requestNum String 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 부여하는 식별번호
└ 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

Return

String - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.6. ResendFAX - 팩스 재전송 (접수번호 동보전송)

ㆍ동일한 팩스파일을 다수의 수신자에게 전송하기 위해 팝빌에 접수합니다. (최대 전송파일 개수: 20개) (최대 1,000건)

ㆍ발신/수신 정보 미입력시 기존과 동일한 정보로 팩스가 전송되고, 접수일 기준 최대 60일이 경과되지 않는 건만 재전송이 가능합니다.

String resendFAX(String corpNum, String receiptNum, String sendNum, String senderName, Receiver[] receivers, Date reserveDT, String userID, String title, String requestNum) throws PopbillException

ㆍ변환실패 사유로 전송실패한 팩스 접수건은 재전송이 불가합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 receiptNum String 18 O 원본 팩스 접수번호
3 sendNum String 20 - 발신번호
※ 미입력시 원본 팩스 전송정보로 전송
4 senderName String 30 - 발신자명
※ 미입력시 원본 팩스 전송정보로 전송
5 receivers Receiver[ ] 1000 - [배열] 수신자 정보 (최대 1,000건)
6 reserveDT Date 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
7 userID String 50 - 팝빌회원 아이디
8 title String 100 - 팩스제목
9 requestNum String 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 부여하는 식별번호
└ 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

Return

String - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.7. ResendFAXRN - 팩스 재전송 (전송요청번호)

ㆍ파트너가 할당한 전송요청 번호를 통해 팩스 1건을 재전송합니다.

ㆍ발신/수신 정보 미입력시 기존과 동일한 정보로 팩스가 전송되고, 접수일 기준 최대 60일이 경과되지 않는 건만 재전송이 가능합니다.

String resendFAXRN(String corpNum, String requestNum, String sendNum, String senderName, String receiveNum, String receiveName, Date reserveDT, String userID, String title, String originalFAXrequestNum) throws PopbillException

ㆍ변환실패 사유로 전송실패한 팩스 접수건은 재전송이 불가합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 requestNum String 36 O 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 부여하는 식별번호
└ 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
3 sendNum String 20 - 발신번호
※ 미입력시 원본 팩스 전송정보로 전송
4 senderName String 30 - 발신자명
※ 미입력시 원본 팩스 전송정보로 전송
5 receiveNum String 20 - 수신번호
※ 미입력시 원본 팩스 전송정보로 전송
6 receiveName String 30 - 수신자명
※ 미입력시 원본 팩스 전송정보로 전송
7 reserveDT Date 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
8 userID String 50 - 팝빌회원 아이디
9 title String 100 - 팩스제목
10 orgRequestNum String 36 O 원본 팩스 전송시 파트너가 할당한 전송요청 번호(requestNum)

Return

String - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.8. ResendFAXRN - 팩스 재전송 (전송요청번호 동보전송)

ㆍ파트너가 할당한 전송요청 번호를 통해 다수건의 팩스를 재전송합니다. (최대 전송파일 개수: 20개) (최대 1,000건)

ㆍ발신/수신 정보 미입력시 기존과 동일한 정보로 팩스가 전송되고, 접수일 기준 최대 60일이 경과되지 않는 건만 재전송이 가능합니다.

String resendFAXRN(String corpNum, String requestNum, String sendNum, String senderName, Receiver[] receivers, Date reserveDT, String userID, String title, String originalFAXrequestNum) throws PopbillException

ㆍ변환실패 사유로 전송실패한 팩스 접수건은 재전송이 불가합니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 requestNum String 36 O 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 할당한 식별번호
└ 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
3 sendNum String 20 - 발신번호
※ 미입력시 기존 전송정보로 전송
4 senderName String 30 - 발신자명
※ 미입력시 기존 전송정보로 전송
5 receivers Receiver[ ] 1000 - [배열] 수신자 정보 (최대 1,000건)
※ 미입력시 기존 전송정보로 전송
6 reserveDT Date 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
7 userID String 50 - 팝빌회원 아이디
8 title String 100 - 팩스제목
9 orgRequestNum String 36 O 원본 팩스 전송시 파트너가 할당한 전송요청 번호(requestNum)

Return

String - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.9. CancelReserve - 예약전송 취소 (접수번호)

ㆍ팝빌에서 반환받은 접수번호를 통해 예약접수된 팩스 전송을 취소합니다. (예약시간 10분 전까지 가능)

Response cancelReserve(String CorpNum, String receiptNum, String UserID) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 receiptNum String 18 O 예약팩스 전송요청시 팝빌로부터 반환 받은 접수번호
3 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

2.10. CancelReserveRN - 예약전송 취소 (전송요청번호)

ㆍ파트너가 할당한 전송요청 번호를 통해 예약접수된 팩스 전송을 취소합니다. (예약시간 10분 전까지 가능)

Response cancelReserveRN(String CorpNum, String requestNum, String UserID) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 requestNum String 36 O 예약팩스 전송요청시 파트너가 할당한 전송요청번호
3 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

3. 정보확인

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

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

FaxResult[] getFaxResult(String corpNum, String receiptNum) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 receiptNum String 18 O 팩스 전송요청시 발급받은 접수번호

Return

FaxResult[ ]

Throws

PopbillException

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

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

FaxResult[] getFaxResultRN(String corpNum, String requestNum) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 requestNum String 36 O 팩스 전송요청시 파트너가 할당한 전송요청번호

Return

FaxResult[ ]

Throws

PopbillException

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

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

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

FAXSearchResult search(String corpNum, String sDate, String eDate, String[] state, Boolean reserveYN, Boolean senderOnly, int page, int perPage, String order, String qString) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 sDate String 8 O 조회 기간의 시작일자 (형식 : yyyyMMdd)
3 eDate String 8 O 조회 기간의 종료일자 (형식 : yyyyMMdd)
4 state String[ ] - - [배열] 전송상태 : "1" / "2" / "3" / "4" 중 선택 (다중 선택 가능)
└ 1 = 대기, 2 = 성공, 3 = 실패, 4 = 취소
※ 미입력시 전체조회
5 reserveYN Boolean - - 예약여부 : true (예약전송건) / false (전체조회) 중 택 1
※ 미입력시 기본값 false 처리
6 senderOnly Boolean - - 개인조회 여부 : true / false 중 택 1
└ true = 해당 담당자 계정으로 접수한 팩스만 조회 (개인권한), false = 접수한 팩스 전체 조회 (관리자권한)
※ 미입력시 기본값 false 처리
7 page int - O 목록 페이지번호
8 perPage int - O 페이지당 표시할 목록 개수 (최대 1,000)
9 order String 1 - 팩스 접수일시를 기준으로 하는 목록 정렬 방향 : "D" / "A" 중 택 1
└ D = 내림차순(기본값), A = 오름차순
10 qString String - - 조회하고자 하는 발신자명 또는 수신자명
※ 미입력시 전체조회

Return

FAXSearchResult

Throws

PopbillException

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

ㆍ팩스 전송내역 확인 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

String getSentListURL(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

3.5. GetPreviewURL - 팩스 미리보기 팝업 URL

ㆍ팩스 미리보기 팝업 URL을 반환하며, 팩스전송을 위한 TIF 포맷 변환 완료 후 호출 할 수 있습니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

String getPreviewURL(String corpNum, String receiptNum, String userID) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 receiptNum String 18 O 팩스 전송요청시 팝빌로부터 반환 받은 접수번호
3 userID String 50 - 팝빌회원 아이디

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

4. 포인트 관리

4.1. GetBalance - 연동회원 잔여포인트 확인

ㆍ연동회원의 잔여포인트를 확인합니다.

double getBalance(String CorpNum) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

double - 연동회원 잔여포인트

Throws

PopbillException

4.2. GetChargeURL - 연동회원 포인트 충전 팝업 URL

ㆍ연동회원 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

String getChargeURL(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

4.3. GetPaymentURL - 연동회원 포인트 결제내역 팝업 URL

ㆍ연동회원 포인트 결제내역 확인을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

String getPaymentURL(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

4.4. GetUseHistoryURL - 연동회원 포인트 사용내역 팝업 URL

ㆍ연동회원 포인트 사용내역 확인을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

String getUseHistoryURL(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

4.5. GetPartnerBalance - 파트너 잔여포인트 확인

ㆍ파트너의 잔여포인트를 확인합니다.

double getPartnerBalance(String CorpNum) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

double - 파트너 잔여포인트

Throws

PopbillException

4.6. GetPartnerURL - 파트너 포인트충전 팝업 URL

ㆍ파트너 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

String getPartnerURL(String CorpNum, String TOGO) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 TOGO String - O "CHRG" 입력

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

4.7. GetUnitCost - 전송 단가 확인

ㆍ팩스 전송시 과금되는 포인트 단가를 확인합니다.

float getUnitCost(String CorpNum) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

float - 팩스 전송 단가

Throws

PopbillException

4.8. GetChargeInfo - 과금정보 확인

ㆍ팝빌 팩스 API 서비스 과금정보를 확인합니다.

ChargeInfo getChargeInfo(String CorpNum) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

ChargeInfo

Throws

PopbillException

5. 회원정보

5.1. CheckIsMember - 연동회원 가입여부 확인

ㆍ사업자번호를 조회하여 연동회원 가입여부를 확인합니다.

Response checkIsMember(String CorpNum, String LinkID) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 LinkID String - O 연동신청시 팝빌에서 발급받은 링크아이디

Return

Response - code : 0 (미가입) / code : 1 (가입)

Throws

PopbillException

5.2. CheckID - 아이디 중복 확인

ㆍ사용하고자 하는 아이디의 중복여부를 확인합니다.

Response checkID(String CheckID) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 CheckID String 50 O 중복여부를 확인할 아이디

Return

Response - code : 0 (미사용중) / code : 1 (사용중)

Throws

PopbillException

5.3. JoinMember - 연동회원 신규가입

ㆍ사용자를 연동회원으로 가입처리합니다.

Response joinMember(JoinForm joinInfo) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 joinInfo JoinForm - O 연동회원 객체정보

Return

Response

Throws

PopbillException

5.4. GetAccessURL - 팝빌 로그인 팝업 URL

ㆍ팝빌 사이트에 로그인 상태로 접근할 수 있는 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

String getAccessURL(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

5.5. GetCorpInfo - 회사정보 확인

ㆍ연동회원의 회사정보를 확인합니다.

CorpInfo getCorpInfo(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

CorpInfo

Throws

PopbillException

5.6. UpdateCorpInfo - 회사정보 수정

ㆍ연동회원의 회사정보를 수정합니다.

Response updateCorpInfo(String CorpNum, CorpInfo corpInfo, String UserID) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 corpInfo CorpInfo - O 회사 객체정보
3 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

5.7. RegistContact - 담당자 추가

ㆍ연동회원 사업자번호에 담당자(팝빌 로그인 계정)를 추가합니다.

Response registContact(String CorpNum, ContactInfo contactInfo, String UserID) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 contactInfo ContactInfo - O 담당자 객체정보
3 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

5.8. GetContactInfo - 담당자 정보 확인

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 정보를 확인합니다.

ContactInfo getContactInfo(String CorpNum, String ContactID, String UserID) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ContactID String 50 O 담당자 아이디
3 UserID String 50 - 팝빌회원 아이디

Return

ContactInfo

Throws

PopbillException

5.9. ListContact - 담당자 목록 확인

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 목록을 확인합니다.

ContactInfo[] listContact(String CorpNum, String UserID) throws PopbillException

Parameters

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

Return

ContactInfo[ ]

Throws

PopbillException

5.10. UpdateContact - 담당자 정보 수정

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 정보를 수정합니다.

Response updateContact(String CorpNum, ContactInfo contactInfo, String UserID) throws PopbillException

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 contactInfo ContactInfo - O 담당자 객체정보
3 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

A. 객체정보

A.1. Response

순번 변수명 항목명 타입 길이 비고
1 code 코드 long - API 처리에 대한 응답코드
2 message 메시지 String - API 처리에 대한 응답메시지

A.2. PopbillException

순번 변수명 항목명 타입 길이 비고
1 code 코드 long - API 처리 실패에 대한 오류코드("-"로 시작하는 8자리 숫자값)
[참고] 오류코드
2 message 메시지 String - API 처리 실패에 대한 오류메시지

A.3. SenderNumber

순번 변수명 항목명 타입 길이 비고
1 number 발신번호 String 20
2 representYN 대표번호 지정여부 Boolean - true : (대표번호) / false : (일반번호) 중 반환
3 state 등록상태 Integer 1 0 : (대기) / 1 : (승인) / 2 : (취소) 중 반환
4 memo 메모 String -

A.4. Receiver

순번 변수명 항목명 타입 길이 필수 비고
1 receiveNum 수신번호 String 20 - 팩스 단말기 번호 또는 인터넷 팩스 번호
2 receiveName 수신자명 String 30 -

A.5. FaxUploadFile

순번 변수명 항목명 타입 길이 필수 비고
1 fileName 파일명 String - - 팩스로 전송할 파일명
2 fileData 파일데이터 InputStream - - 팩스로 전송할 파일의 바이너리 데이터

A.6. FAXSearchResult

순번 변수명 항목명 타입 길이 비고
1 code 코드 long - API 처리에 대한 응답코드
2 message 메시지 String - API 처리에 대한 응답메시지
3 total 총 검색결과 건수 String -
4 perPage 페이지당 검색개수 String -
5 pageNum 페이지 번호 String -
6 pageCount 페이지 개수 String -
7 list 전송결과 정보 List<FaxResult> [리스트] 최대 1,000개, [3.1 GetFaxResult - 전송내역 및 전송상태 확인] 응답전문의 구성과 동일

A.7. FaxResult

순번 변수명 항목명 타입 길이 비고
1 state 전송상태 코드 Integer 1 [참고] 전송 상태 및 결과 코드
2 result 전송결과 코드 Integer 3
3 sendNum 발신번호 String 20
4 senderName 발신자명 String 30
5 receiveNum 수신번호 String 20
6 receiveNumType 수신번호 유형 String 2 "일반" / "지능" 중 반환
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[ ] 20
18 receiptNum 접수번호 String 18 팩스 전송요청시 팝빌로부터 반환 받은 값
19 requestNum 요청번호 String 36 팩스 전송요청시 파트너가 할당한 고유한 식별값
20 chargePageCnt 과금 페이지수 Integer -
21 refundPageCnt 환불 페이지수 Integer -
22 tiffFileSize 변환파일용량 String - 단위 : byte

A.8. ChargeInfo

순번 변수명 항목명 타입 길이 비고
1 unitCost 전송단가 String -
2 chargeMethod 과금유형 String - "연동" / "파트너" 중 반환
3 rateSystem 과금제도 String - "종량제" 반환

A.9. JoinForm

순번 변수명 항목명 타입 길이 필수 비고
1 ID 아이디 String 50 O 6자 이상 50자 이하
2 Password 비밀번호 String 20 O 8자 이상 20자 이하
└ 영문, 숫자, 특수문자 조합
3 LinkID 파트너 링크아이디 String 20 O 연동신청시 팝빌에서 발급받은 링크아이디
4 CorpNum 사업자번호 String 10 O 하이픈 '-' 제외 10자리 숫자값
5 CEOName 대표자 성명 String 100 O
6 CorpName 회사명 String 200 O
7 Addr 사업장 주소 String 300 O
8 BizType 업태 String 100 O
9 BizClass 종목 String 100 O
10 ContactName 담당자 성명 String 100 O
11 ContactEmail 담당자 이메일 String 100 O
12 ContactTEL 담당자 연락처(전화번호) String 20 O

A.10. CorpInfo

순번 변수명 항목명 타입 길이 필수 비고
1 ceoname 대표자 성명 String 100 O
2 corpName 회사명 String 200 O
3 addr 주소 String 300 O
4 bizType 업태 String 100 O
5 bizClass 종목 String 100 O

A.11. ContactInfo

순번 변수명 항목명 타입 길이 필수 비고
1 id 아이디 String 50 O 6자 이상 50자 이하
2 Password 비밀번호 String 20 8자 이상 20자 이하
└ 영문, 숫자, 특수문자 조합
3 personName 담당자 성명 String 100 O
4 tel 담당자 연락처(전화번호) String 20 O
5 email 담당자 이메일 String 100 O
6 regDT 등록일시 String 14 X 형식 : yyyyMMddHHmmss
7 searchRole 담당자 권한 Integer 1 - 1 : (개인권한) / 2 : (읽기권한) / 3 : (회사권한)
8 mgrYN 관리자 여부 Boolean - X true : (관리자) / false : (담당자) 중 반환
※ 팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
9 state 계정상태 Integer 1 X 0 : (승인대기 - 관리자의 승인 후 이용가능) / 1 : (사용중) 중 반환