팩스전송

1. SendFax - 팩스 전송

팩스 1건을 팝빌에 접수합니다. (최대 전송파일 개수: 30개)

def sendFax(CorpNum, SenderNum, ReceiverNum, ReceiverName, FilePath, ReserveDT=None, UserID=None, SenderName=None, adsYN=False, title=None, RequestNum=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	SenderNum	str	20	Y	발신번호 → 팝빌에 사전등록되지 않은 발신번호를 입력시 '원발신번호'로 전송됨
3	ReceiverNum	str	20	Y	수신번호
4	ReceiverName	str	30	N	수신자명
5	FilePath	list	-	Y	파일 목록 → [참고] 권장 파일 확장자 최대 : 30개
6	ReserveDT	str	14	N	전송 예약일시 → 형식 : yyyyMMddHHmmss ※ 기본값 : 즉시전송
7	UserID	str	50	N	팝빌회원 아이디
8	SenderName	str	100	N	발신자명
9	adsYN	bool	-	N	광고팩스 전송 여부 true 광고 false 일반 : 기본값
10	title	str	100	N	팩스제목
11	RequestNum	str	36	N	요청번호 → 파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

응답

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

예외

PopbillException

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

2. SendFax_multi - 팩스 전송 (동보전송)

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

def sendFax_multi(CorpNum, SenderNum, Receiver, FilePath, ReserveDT=None, UserID=None, SenderName=None, adsYN=False, title=None, RequestNum=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	SenderNum	str	20	Y	발신번호 → 팝빌에 사전등록되지 않은 발신번호를 입력시 '원발신번호'로 전송됨
3	Receiver	FaxReceiver[ ]	-	Y	수신자 정보 → 최대 : 1,000건
FaxReceiver[ ] 순번 변수명 타입 길이 필수 설명 1 receiveNum str 20 Y 팩스 단말기 번호 또는 인터넷 팩스 번호 2 receiveName str 30 N 수신자명 3 interOPRefKey str 20 N 파트너 지정키 → 팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
4	FilePath	list	-	Y	파일 목록 → [참고] 권장 파일 확장자 최대 : 30개
5	ReserveDT	str	14	N	전송 예약일시 → 형식 : yyyyMMddHHmmss ※ 기본값 : 즉시전송
6	UserID	str	50	N	팝빌회원 아이디
7	SenderName	str	100	N	발신자명
8	adsYN	bool	-	N	광고팩스 전송 여부 true 광고 false 일반 : 기본값
9	title	str	100	N	팩스제목
10	RequestNum	str	36	N	요청번호 → 파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

응답

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

예외

PopbillException

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

3. SendFaxBinary - 팩스 전송 (바이너리)

전송할 파일의 바이너리 데이터로 팩스 1건을 팝빌에 접수합니다. (최대 전송파일 개수: 30개)

def sendFaxBinary(CorpNum, SenderNum, ReceiverNum, ReceiverName, FileDatas, ReserveDT=None, UserID=None, SenderName=None, adsYN=False, title=None, RequestNum=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	SenderNum	str	20	Y	발신번호 → 팝빌에 사전등록되지 않은 발신번호를 입력시 '원발신번호'로 전송됨
3	ReceiverNum	str	20	Y	수신번호
4	ReceiverName	str	30	N	수신자명
5	FileDatas	FileData[ ]	-	Y	파일 목록 → [참고] 권장 파일 확장자 최대 : 30개
FileData[ ] 순번 변수명 타입 길이 필수 설명 1 fileName str 255 Y 팩스로 전송할 파일명 2 fileData bytes - Y 팩스로 전송할 파일의 바이너리 데이터
6	ReserveDT	str	14	N	전송 예약일시 → 형식 : yyyyMMddHHmmss ※ 기본값 : 즉시전송
7	UserID	str	50	N	팝빌회원 아이디
8	SenderName	str	100	N	발신자명
9	adsYN	bool	-	N	광고팩스 전송 여부 true 광고 false 일반 : 기본값
10	title	str	100	N	팩스제목
11	RequestNum	str	36	N	요청번호 → 파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

응답

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

예외

PopbillException

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

4. SendFaxBinary_multi - 팩스 전송 (바이너리 동보전송)

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

def sendFaxBinary_multi(CorpNum, SenderNum, Receiver, FileDatas, ReserveDT=None, UserID=None, SenderName=None, adsYN=False, title=None, RequestNum=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	SenderNum	str	20	Y	발신번호 → 팝빌에 사전등록되지 않은 발신번호를 입력시 '원발신번호'로 전송됨
3	Receiver	FaxReceiver[ ]	-	Y	수신자 정보 → 최대 : 1,000건
FaxReceiver[ ] 순번 변수명 타입 길이 필수 설명 1 receiveNum str 20 Y 팩스 단말기 번호 또는 인터넷 팩스 번호 2 receiveName str 30 N 수신자명 3 interOPRefKey str 20 N 파트너 지정키 → 팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
4	FileDatas	FileData[ ]	-	Y	파일 목록 → [참고] 권장 파일 확장자 최대 : 30개
FileData[ ] 순번 변수명 타입 길이 필수 설명 1 fileName str 255 Y 팩스로 전송할 파일명 2 fileData bytes - Y 팩스로 전송할 파일의 바이너리 데이터
5	ReserveDT	str	14	N	전송 예약일시 → 형식 : yyyyMMddHHmmss ※ 기본값 : 즉시전송
6	UserID	str	50	N	팝빌회원 아이디
7	SenderName	str	100	N	발신자명
8	adsYN	bool	-	N	광고팩스 전송 여부 true 광고 false 일반 : 기본값
9	title	str	100	N	팩스제목
10	RequestNum	str	36	N	요청번호 → 파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

응답

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

예외

PopbillException

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

5. ResendFax - 팩스 재전송 (접수번호)

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

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

def resendFax(CorpNum, ReceiptNum, SenderNum, SenderName, ReceiverNum, ReceiverName, ReserveDT=None, UserID=None, title=None, RequestNum=None)

팩스 재전송이 가능한 상태는 다음과 같습니다.

1. 원본 팩스 접수 후 60일 이내이며, 최초 팩스 전송 시 변환에 성공한 경우
2. 최초 팩스 전송 시 변환에 실패했으나 재전송이 가능한 경우

재전송이 가능한 변환 실패 코드는 아래와 같습니다.

• 414 : 팩스 변환 실패
• 415 : 팩스 변환 시간 초과
• 416 : 팩스 파일 처리 중 오류
• 498 : 기타 오류로 인한 변환 실패

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ReceiptNum	str	18	Y	원본 팩스 접수번호
3	SenderNum	str	20	N	발신번호 → 발신번호를 변경해야할 경우 사용 ※ 기본값 : 원본 팩스 발신번호
4	SenderName	str	100	N	발신자명 → 발신자명을 변경해야할 경우 사용 ※ 기본값 : 원본 팩스 발신자명
5	ReceiverNum	str	20	N	수신번호 → 수신번호를 변경해야할 경우 사용 ※ 기본값 : 원본 팩스 수신번호
6	ReceiverName	str	30	N	수신자명 → 수신자명을 변경해야할 경우 사용 ※ 기본값 : 원본 팩스 수신자명
7	ReserveDT	str	14	N	전송 예약일시 → 형식 : yyyyMMddHHmmss ※ 기본값 : 즉시전송
8	UserID	str	50	N	팝빌회원 아이디
9	title	str	100	N	팩스제목
10	RequestNum	str	36	N	요청번호 → 파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

응답

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

예외

PopbillException

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

6. ResendFax_multi - 팩스 재전송 (접수번호 동보전송)

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

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

def resendFax_multi(CorpNum, ReceiptNum, SenderNum, SenderName, Receiver, ReserveDT=None, UserID=None, title=None, RequestNum=None)

팩스 재전송이 가능한 상태는 다음과 같습니다.

1. 원본 팩스 접수 후 60일 이내이며, 최초 팩스 전송 시 변환에 성공한 경우
2. 최초 팩스 전송 시 변환에 실패했으나 재전송이 가능한 경우

재전송이 가능한 변환 실패 코드는 아래와 같습니다.

• 414 : 팩스 변환 실패
• 415 : 팩스 변환 시간 초과
• 416 : 팩스 파일 처리 중 오류
• 498 : 기타 오류로 인한 변환 실패

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ReceiptNum	str	18	Y	원본 팩스 접수번호
3	SenderNum	str	20	N	발신번호 → 발신번호를 변경해야할 경우 사용 ※ 기본값 : 원본 팩스 발신번호
4	SenderName	str	100	N	발신자명 → 발신자명을 변경해야할 경우 사용 ※ 기본값 : 원본 팩스 발신자명
5	Receiver	FaxReceiver[ ]	-	N	수신자 정보 → 최대 : 1,000건
FaxReceiver[ ] 순번 변수명 타입 길이 필수 설명 1 receiveNum str 20 Y 팩스 단말기 번호 또는 인터넷 팩스 번호 2 receiveName str 30 N 수신자명 3 interOPRefKey str 20 N 파트너 지정키 → 팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
6	ReserveDT	str	14	N	전송 예약일시 → 형식 : yyyyMMddHHmmss ※ 기본값 : 즉시전송
7	UserID	str	50	N	팝빌회원 아이디
8	title	str	100	N	팩스제목
9	RequestNum	str	36	N	요청번호 → 파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

응답

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

예외

PopbillException

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

7. ResendFaxRN - 팩스 재전송 (요청번호)

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

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

def resendFaxRN(CorpNum, OrgRequestNum, SenderNum, SenderName, ReceiverNum, ReceiverName, ReserveDT=None, UserID=None, title=None, RequestNum=None)

팩스 재전송이 가능한 상태는 다음과 같습니다.

1. 원본 팩스 접수 후 60일 이내이며, 최초 팩스 전송 시 변환에 성공한 경우
2. 최초 팩스 전송 시 변환에 실패했으나 재전송이 가능한 경우

재전송이 가능한 변환 실패 코드는 아래와 같습니다.

• 414 : 팩스 변환 실패
• 415 : 팩스 변환 시간 초과
• 416 : 팩스 파일 처리 중 오류
• 498 : 기타 오류로 인한 변환 실패

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	OrgRequestNum	str	36	Y	원본 팩스 요청번호
3	SenderNum	str	20	N	발신번호 → 발신번호를 변경해야할 경우 사용 ※ 기본값 : 원본 팩스 발신번호
4	SenderName	str	100	N	발신자명 → 발신자명을 변경해야할 경우 사용 ※ 기본값 : 원본 팩스 발신자명
5	ReceiverNum	str	20	N	수신번호 → 수신번호를 변경해야할 경우 사용 ※ 기본값 : 원본 팩스 수신번호
6	ReceiverName	str	30	N	수신자명 → 수신자명을 변경해야할 경우 사용 ※ 기본값 : 원본 팩스 수신자명
7	ReserveDT	str	14	N	전송 예약일시 → 형식 : yyyyMMddHHmmss ※ 기본값 : 즉시전송
8	UserID	str	50	N	팝빌회원 아이디
9	title	str	100	N	팩스제목
10	RequestNum	str	36	N	요청번호 → 파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

응답

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

예외

PopbillException

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

8. ResendFaxRN_multi - 팩스 재전송 (요청번호 동보전송)

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

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

def resendFaxRN_multi(CorpNum, OrgRequestNum, SenderNum, SenderName, Receiver, ReserveDT=None, UserID=None, title=None, RequestNum=None)

팩스 재전송이 가능한 상태는 다음과 같습니다.

1. 원본 팩스 접수 후 60일 이내이며, 최초 팩스 전송 시 변환에 성공한 경우
2. 최초 팩스 전송 시 변환에 실패했으나 재전송이 가능한 경우

재전송이 가능한 변환 실패 코드는 아래와 같습니다.

• 414 : 팩스 변환 실패
• 415 : 팩스 변환 시간 초과
• 416 : 팩스 파일 처리 중 오류
• 498 : 기타 오류로 인한 변환 실패

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	OrgRequestNum	str	36	Y	원본 팩스 요청번호
3	SenderNum	str	20	N	발신번호 → 발신번호를 변경해야할 경우 사용 ※ 기본값 : 원본 팩스 발신번호
4	SenderName	str	100	N	발신자명 → 발신자명을 변경해야할 경우 사용 ※ 기본값 : 원본 팩스 발신자명
5	Receiver	FaxReceiver[ ]	-	N	수신자 정보 → 수신자 정보를 변경해야할 경우 사용 최대 : 1,000건 ※ 기본값 : 원본 팩스 수신자 정보
FaxReceiver[ ] 순번 변수명 타입 길이 필수 설명 1 receiveNum str 20 Y 팩스 단말기 번호 또는 인터넷 팩스 번호 2 receiveName str 30 N 수신자명 3 interOPRefKey str 20 N 파트너 지정키 → 팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
6	ReserveDT	str	14	N	전송 예약일시 → 형식 : yyyyMMddHHmmss ※ 기본값 : 즉시전송
7	UserID	str	50	N	팝빌회원 아이디
8	title	str	100	N	팩스제목
9	RequestNum	str	36	N	요청번호 → 파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

응답

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

예외

PopbillException

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

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

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

def cancelReserve(CorpNum, ReceiptNum, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ReceiptNum	str	18	Y	팝빌에서 할당한 접수번호 → 팩스 예약전송 요청의 반환값
3	UserID	str	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	int	-	API 처리에 대한 응답코드 1 성공
2	message	str	-	API 처리에 대한 응답메시지

예외

PopbillException

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

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

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

def cancelReserveRN(CorpNum, RequestNum, UserID=None)

요청

Parameters

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

응답

Response

순번	변수명	타입	길이	설명
1	code	int	-	API 처리에 대한 응답코드 1 성공
2	message	str	-	API 처리에 대한 응답메시지

예외

PopbillException

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