POPBill Developers
API Reference

2. 팩스전송

2.1. SendFAX - 팩스 전송

  • 팩스 1건을 전송합니다. (최대 전송파일 개수: 20개)
def sendFax(corpNum, senderNum, senderName, receiverNum, receiverName, filePath, reserveDT = '', userID = '', adsYN = false, title = '', requestNum = '')
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
senderNum String 20 Y 발신번호
팝빌에 사전등록되지 않은 발신번호를 입력시 '원발신번호'로 전송됨
senderName String 70 N 발신자명
receiverNum String 20 Y 수신번호
receiverName String 30 N 수신자명
filePath Array Y 전송파일
최대 : 20개
reserveDT String 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
userID String 50 N 팝빌회원 아이디
adsYN Boolean - N 광고팩스 전송여부
true광고
false일반 : 기본값
title String 100 N 팩스제목
requestNum String 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
Return

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

Throws

PopbillException

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

  • 동일한 팩스파일을 다수의 수신자에게 전송하기 위해 팝빌에 접수합니다. (최대 전송파일 개수 : 20개) (최대 1,000건)
def sendFax_multi(corpNum, senderNum, senderName, receivers, filePaths, reserveDT = '', userID = '', adsYN = false, title = '', requestNum = '')
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
senderNum String 20 Y 발신번호
팝빌에 사전등록되지 않은 발신번호를 입력시 '원발신번호'로 전송됨
senderName String 70 Y 발신자명
receivers FaxReceiver[ ] Y 수신자 정보
최대 : 1,000건
filePaths Array Y 전송파일
최대 : 20개
reserveDT String 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
userID String 50 N 팝빌회원 아이디
adsYN Boolean - N 광고팩스 전송여부
true광고
false일반 : 기본값
title String 100 N 팩스제목
RequestNum String 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
Return

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

Throws

PopbillException

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

  • 전송할 파일의 바이너리 데이터로 팩스 1건을 팝빌에 접수합니다. (최대 전송파일 개수: 20개)
def sendFaxBinary(corpNum, senderNum, senderName, receiverNum, receiverName, fileDatas, reserveDT = '', userID = '', adsYN = false, title = '', requestNum = '')
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
senderNum String 20 Y 발신번호
팝빌에 사전등록되지 않은 발신번호를 입력시 '원발신번호'로 전송됨
senderName String 70 N 발신자명
receiverNum String 20 Y 수신번호
receiverName String 30 N 수신자명
fileDatas FileData[ ] Y 전송할 파일의 객체정보
최대 : 20개
reserveDT String 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
userID String 50 N 팝빌회원 아이디
adsYN Boolean - N 광고팩스 전송여부
true광고
false일반 : 기본값
title String 100 N 팩스제목
requestNum String 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
Return

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

Throws

PopbillException

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

  • 전송할 파일의 바이너리 데이터로 다수의 수신자에게 팩스를 전송하기 위해 팝빌에 접수합니다. (최대 전송파일 개수 : 20개) (최대 1,000건)
def sendFaxBinary_multi(corpNum, senderNum, senderName, receivers, fileDatas, reserveDT = '', userID = '', adsYN = false, title = '', requestNum = '')
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
senderNum String 20 Y 발신번호
팝빌에 사전등록되지 않은 발신번호를 입력시 '원발신번호'로 전송됨
senderName String 70 Y 발신자명, 전송정보에 발신자명 없는 경우 적용
receivers FaxReceiver[ ] Y 수신자 정보
최대 : 1,000건
fileDatas FileData[ ] Y 전송할 파일의 객체정보
최대 : 20개
reserveDT String 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
userID String 50 N 팝빌회원 아이디
adsYN Boolean - N 광고팩스 전송여부
true광고
false일반 : 기본값
title String 100 N 팩스제목
RequestNum String 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
Return

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

Throws

PopbillException

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

  • 팝빌에서 반환받은 접수번호를 통해 팩스 1건을 재전송합니다.
  • 발신/수신 정보 미입력시 기존과 동일한 정보로 팩스가 전송되고, 접수일 기준 최대 60일이 경과되지 않는 건만 재전송이 가능합니다.
def resendFax(corpNum, receiptNum, senderNum, senderName, receiveNum, receiveName, reserveDT = '', userID = '', title = '', requestNum = '')
  • 변환실패 사유로 전송실패한 팩스 접수건은 재전송이 불가합니다.
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
receiptNum String 18 Y 원본 팩스 접수번호
senderNum String 20 Y 발신번호
발신번호를 변경해야할 경우 사용
기본값 : 원본 팩스 발신번호
senderName String 30 N 발신자명
발신자명을 변경해야할 경우 사용
기본값 : 원본 팩스 발신자명
receiveNum String 20 Y 수신번호
수신번호를 변경해야할 경우 사용
기본값 : 원본 팩스 수신번호
receiveName String 30 Y 수신자명
수신자명을 변경해야할 경우 사용
기본값 : 원본 팩스 수신자명
reserveDT String 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
userID String 50 N 팝빌회원 아이디
title String 100 N 팩스제목
requestNum String 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
Return

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

Throws

PopbillException

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

  • 동일한 팩스파일을 다수의 수신자에게 전송하기 위해 팝빌에 접수합니다. (최대 전송파일 개수: 20개) (최대 1,000건)
  • 발신/수신 정보 미입력시 기존과 동일한 정보로 팩스가 전송되고, 접수일 기준 최대 60일이 경과되지 않는 건만 재전송이 가능합니다.
def resendFax_multi(corpNum, receiptNum, senderNum = '', senderName = '', receivers = nil, reserveDT = '', userID = '', title = '', requestNum = '')
  • 변환실패 사유로 전송실패한 팩스 접수건은 재전송이 불가합니다.
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
receiptNum String 18 Y 원본 팩스 접수번호
senderNum String 20 N 발신번호
발신번호를 변경해야할 경우 사용
기본값 : 원본 팩스 발신번호
senderName String 30 N 발신자명
발신자명을 변경해야할 경우 사용
기본값 : 원본 팩스 발신자명
receivers FaxReceiver[ ] N 수신자 정보
최대 : 1,000건
reserveDT String 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
userID String 50 N 팝빌회원 아이디
title String 100 N 팩스제목
requestNum String 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
Return

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

Throws

PopbillException

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

  • 파트너가 할당한 요청번호를 통해 팩스 1건을 재전송합니다.
  • 발신/수신 정보 미입력시 기존과 동일한 정보로 팩스가 전송되고, 접수일 기준 최대 60일이 경과되지 않는 건만 재전송이 가능합니다.
def resendFAXRN(corpNum, orgRequestNum, senderNum, senderName, receiveNum, receiveName, reserveDT = '', userID = '', title = '', requestNum = '')
  • 변환실패 사유로 전송실패한 팩스 접수건은 재전송이 불가합니다.
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
orgRequestNum String 36 Y 원본 팩스 전송시 파트너가 할당한 요청번호(requestNum)
senderNum String 20 Y 발신번호
발신번호를 변경해야할 경우 사용
기본값 : 원본 팩스 발신번호
senderName String 30 N 발신자명
발신자명을 변경해야할 경우 사용
기본값 : 원본 팩스 발신자명
receiveNum String 20 Y 수신번호
수신번호를 변경해야할 경우 사용
기본값 : 원본 팩스 수신번호
receiveName String 30 Y 수신자명
수신자명을 변경해야할 경우 사용
기본값 : 원본 팩스 수신자명
reserveDT String 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
userID String 50 N 팝빌회원 아이디
title String 100 N 팩스제목
requestNum String 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
Return

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

Throws

PopbillException

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

  • 파트너가 할당한 요청번호를 통해 다수건의 팩스를 재전송합니다. (최대 전송파일 개수: 20개) (최대 1,000건)
  • 발신/수신 정보 미입력시 기존과 동일한 정보로 팩스가 전송되고, 접수일 기준 최대 60일이 경과되지 않는 건만 재전송이 가능합니다.
def resendFAXRN_multi(corpNum, orgRequestNum, senderNum = '', senderName = '', receivers = nil, reserveDT = '', userID = '', title = '', requestNum = '')
  • 변환실패 사유로 전송실패한 팩스 접수건은 재전송이 불가합니다.
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
orgRequestNum String 36 Y 원본 팩스 전송시 파트너가 할당한 요청번호(requestNum)
senderNum String 20 N 발신번호
발신번호를 변경해야할 경우 사용
기본값 : 원본 팩스 발신번호
senderName String 30 N 발신자명
발신자명을 변경해야할 경우 사용
기본값 : 원본 팩스 발신자명
receivers FaxReceiver[ ] N 수신자 정보
수신자 정보를 변경해야할 경우 사용
최대 : 1,000건
기본값 : 원본 팩스 수신자 정보
reserveDT String 14 N 전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
userID String 50 N 팝빌회원 아이디
title String 100 N 팩스제목
requestNum String 36 N 요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능
Return

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

Throws

PopbillException

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

  • 팝빌에서 반환받은 접수번호로 예약된 팩스를 전송 취소합니다. (예약시간 10분 전까지 가능)
def cancelReserve(corpNum, receiptNum, userID = '')
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
receiptNum String 18 Y 예약팩스 전송요청시 팝빌로부터 반환 받은 접수번호
userID String 50 N 팝빌회원 아이디
Return

Response

Throws

PopbillException

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

  • 파트너가 할당한 요청번호로 예약된 팩스를 전송 취소합니다. (예약시간 10분 전까지 가능)
def cancelReserveRN(corpNum, requestNum, userID = '')
Parameters
순번변수명타입길이필수설명
corpNum String 10 Y 팝빌회원 사업자번호 ('-' 제외)
requestNum String 36 Y 예약팩스 전송요청시 파트너가 할당한 요청번호
userID String 50 N 팝빌회원 아이디
Return

Response

Throws

PopbillException