Index

1. 발신번호 사전등록

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

ㆍ 팩스 발신번호 관리 팝업 URL을 반환합니다.

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

def getSenderNumberMgtURL(corpNum, userID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

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

ㆍ 팝빌에 등록된 팩스 발신번호 목록을 반환합니다.

def getSenderNumberList(corpNum, userID = '')

Parameters

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

Return

SenderNumber[]

Throws

PopbillException

2. 팩스전송

2.1. SendFAX - 팩스 전송

ㆍ 팩스를 전송합니다.

ㆍ 사전등록되지 않은 발신번호 기재시 팝빌이 통신사로부터 부여받은 원발신번호가 발신번호로 기재되어 전송됩니다.

def sendFax(corpNum, senderNum, senderName, receiverNum, receiverName, filePath, reserveDT = '', userID = '', adsYN = false, title = '', requestNum = '')

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 senderNum String 20 O 발신번호
3 senderName String 70 O 발신자명
4 receiverNum String 20 O 수신번호
5 receiverName String 30 O 수신자명
6 filePath Array 20 O [배열] 전송파일 (전송할 파일 개수는 최대 20개까지 가능)
7 reserveDT String 14 - 예약일시, 날짜형식(yyyyMMddHHmmss)
- 빈 문자열 입력시 즉시 전송
8 userID String 50 - 팝빌회원 아이디
9 adsYN Boolean - - 광고팩스 전송여부
10 title String 100 - 팩스제목
11 requestNum String 36 - 전송요청번호 (연동회원 별로 중복없이 번호 할당)
- 영문, 숫자, 하이픈('-'), 언더바('_')를 조합하여 구성

Return

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

Throws

PopbillException

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

ㆍ 다수의 수신자에게 팩스를 전송합니다. (최대 1000건)

ㆍ 사전등록되지 않은 발신번호 기재시 팝빌이 통신사로부터 부여받은 원발신번호가 발신번호로 기재되어 전송됩니다.

ㆍ 팩스전송 파일 개수는 최대 20개까지 가능합니다.

def sendFax_multi(corpNum, senderNum, senderName, receivers, filePaths, reserveDT = '', userID = '', adsYN = false, title = '', requestNum = '')

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 senderNum String 20 O [동보] 발신번호
3 senderName String 70 O [동보] 발신자명, 전송정보에 발신자명 없는 경우 적용
4 receivers FaxReceiver[] 1000 O [배열] 수신자 정보 (최대 1,000건)
5 filePaths Array 20 O [배열] 전송파일 (전송할 파일 개수는 최대 20개까지 가능)
6 reserveDT String 14 - 예약일시, 날짜형식(yyyyMMddHHmmss)
- 빈 문자열 입력시 즉시 전송
7 userID String 50 - 팝빌회원 아이디
8 adsYN Boolean - - 광고팩스 전송여부
9 title String 100 - [동보] 팩스제목
10 RequestNum String 36 - 전송요청번호 (연동회원 별로 중복없이 번호 할당)
- 영문, 숫자, 하이픈('-'), 언더바('_')를 조합하여 구성

Return

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

Throws

PopbillException

2.3. ResendFAX - 팩스 재전송

ㆍ 팝빌을 통해 전송한 팩스를 재전송합니다.

ㆍ 접수일로부터 60일이 경과되지 않은 건만 재전송이 가능합니다.

ㆍ 발신/수신 정보를 미기재하는 경우 기존 팩스전송건의 전송정보로 팩스가 전송됩니다.

def resendFax(corpNum, receiptNum, senderNum, senderName, receiveNum, receiveName, reserveDT = '', userID = '', title = '', requestNum = '')

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 receiptNum String 18 O 원본 팩스 접수번호
3 senderNum String 20 O 발신번호 (미기재 시 기존 전송정보로 전송)
4 senderName String 30 O 발신자명 (미기재 시 기존 전송정보로 전송)
5 receiveNum String 20 O 수신번호
6 receiveName String 30 O 수신자명
7 reserveDT String 14 - 예약일시, 날짜형식(yyyyMMddHHmmss)
- 빈 문자열 입력시 즉시 전송
8 userID String 50 - 팝빌회원 아이디
9 title String 100 - 팩스제목
10 requestNum String 36 - 전송요청번호 (연동회원 별로 중복없이 번호 할당)
- 영문, 숫자, 하이픈('-'), 언더바('_')를 조합하여 구성

Return

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

Throws

PopbillException

2.4. ResendFAX - 팩스 재전송 (동보전송)

ㆍ 다수의 수신자에게 팩스를 재전송합니다. (최대 1000건)

ㆍ 접수일로부터 60일이 경과되지 않은 건만 재전송이 가능합니다.

ㆍ 발신/수신 정보를 미기재하는 경우 기존 팩스전송건의 전송정보로 팩스가 전송됩니다.

def resendFax_multi(corpNum, receiptNum, senderNum = '', senderName = '', receivers = nil, reserveDT = '', userID = '', title = '', requestNum = '')

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 receiptNum String 18 O 원본 팩스 접수번호
3 senderNum String 20 - 발신번호 (미기재 시 기존 전송정보로 전송)
4 senderName String 30 - 발신자명 (미기재 시 기존 전송정보로 전송)
5 receivers FaxReceiver[] 1000 - [배열] 수신자 정보 (최대 1,000건)
6 reserveDT String 14 - 예약일시, 날짜형식(yyyyMMddHHmmss)
- 빈 문자열 입력시 즉시 전송
7 userID String 50 - 팝빌회원 아이디
8 title String 100 - [동보] 팩스제목
9 requestNum String 36 - 전송요청번호 (연동회원 별로 중복없이 번호 할당)
- 영문, 숫자, 하이픈('-'), 언더바('_')를 조합하여 구성

Return

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

Throws

PopbillException

2.5. ResendFAXRN - 팩스 재전송 (요청번호 할당)

ㆍ 팝빌을 통해 전송한 팩스를 재전송합니다.

ㆍ 접수일로부터 60일이 경과되지 않은 건만 재전송이 가능합니다.

ㆍ 발신/수신 정보를 미기재하는 경우 기존 팩스전송건의 전송정보로 팩스가 전송됩니다.

def resendFAXRN(corpNum, orgRequestNum, senderNum, senderName, receiveNum, receiveName, reserveDT = '', userID = '', title = '', requestNum = '')

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 orgRequestNum String 36 O 원본 팩스 전송시 할당한 전송요청번호(requestNum)
3 senderNum String 20 O 발신번호 (미기재 시 기존 전송정보로 전송)
4 senderName String 30 O 발신자명 (미기재 시 기존 전송정보로 전송)
5 receiveNum String 20 O 수신번호
6 receiveName String 30 O 수신자명
7 reserveDT String 14 - 예약일시, 날짜형식(yyyyMMddHHmmss)
- 빈 문자열 입력시 즉시 전송
8 userID String 50 - 팝빌회원 아이디
9 title String 100 - 팩스제목
10 requestNum String 36 - 전송요청번호 (연동회원 별로 중복없이 번호 할당)
- 영문, 숫자, 하이픈('-'), 언더바('_')를 조합하여 구성

Return

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

Throws

PopbillException

2.6. ResendFAXRN - 팩스 재전송 (요청번호 할당 / 동보전송)

ㆍ 다수의 수신자에게 팩스를 재전송합니다. (최대 1000건)

ㆍ 접수일로부터 60일이 경과되지 않은 건만 재전송이 가능합니다.

ㆍ 발신/수신 정보를 미기재하는 경우 기존 팩스전송건의 전송정보로 팩스가 전송됩니다.

def resendFAXRN_multi(corpNum, orgRequestNum, senderNum = '', senderName = '', receivers = nil, reserveDT = '', userID = '', title = '', requestNum = '')

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 orgRequestNum String 36 O 원본 팩스 전송시 할당한 전송요청번호(requestNum)
3 senderNum String 20 - 발신번호 (미기재 시 기존 전송정보로 전송)
4 senderName String 30 - 발신자명 (미기재 시 기존 전송정보로 전송)
5 receivers FaxReceiver[] 1000 - [배열] 수신자 정보 (최대 1,000건)
6 reserveDT String 14 - 예약일시, 날짜형식(yyyyMMddHHmmss)
- 빈 문자열 입력시 즉시 전송
7 userID String 50 - 팝빌회원 아이디
8 title String 100 - [동보] 팩스제목
9 requestNum String 36 - 전송요청번호 (연동회원 별로 중복없이 번호 할당)
- 영문, 숫자, 하이픈('-'), 언더바('_')를 조합하여 구성

Return

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

Throws

PopbillException

2.7. CancelReserve - 예약전송 취소

ㆍ 예약팩스 전송을 취소합니다.

ㆍ 예약취소는 예약시간 10분전까지 가능합니다.

def cancelReserve(corpNum, receiptNum, userID = '')

Parameters

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

Return

Response

Throws

PopbillException

2.8. CancelReserveRN - 예약전송 취소 (요청번호 할당)

ㆍ 예약팩스 전송을 취소합니다.

ㆍ 예약취소는 예약시간 10분전까지 가능합니다.

def cancelReserveRN(corpNum, requestNum, userID = '')

Parameters

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

Return

Response

Throws

PopbillException

3. 정보확인

3.1. GetFaxDetail - 전송내역 및 전송상태 확인

ㆍ 팩스 전송상태 및 결과정보를 확인합니다.

def getFaxDetail(corpNum, receiptNum, userID = '')

Parameters

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

Return

FaxResult[]

Throws

PopbillException

3.2. GetFaxDetailRN - 전송내역 및 전송상태 확인 (요청번호 할당)

ㆍ 팩스 전송상태 및 결과정보를 확인합니다.

def getFaxDetailRN(corpNum, requestNum, userID = '')

Parameters

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

Return

FaxResult[]

Throws

PopbillException

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

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

def search(corpNum, sDate, eDate, state, reserveYN, senderOnly, page, perPage, order, userID = '', queryString = '')

Parameters

순번 변수명 타입 길이 필수 설명
1 corpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 sDate String 8 O 시작일자, 날짜형식(yyyyMMdd)
3 eDate String 8 O 종료일자, 날짜형식(yyyyMMdd)
4 state Array - O [배열] 전송상태 [ 1-대기 / 2-성공 / 3-실패 / 4-취소 ]
5 reserveYN Boolean - O 예약여부 [ false-전체조회, true-예약전송건 조회 ]
6 senderOnly Boolean - O 개인조회 여부 [ false-전체조회, true-개인조회 ]
7 page Integer - O 페이지번호, 기본값 '1'
8 perPage Integer - O 페이지당 검색개수, 기본값 500, 최대 1000
9 order String 1 O 정렬 방향, 기본값 'D' [ D-내림차순, A-오름차순 중 택1 ]
10 userID String 50 - 팝빌회원 아이디
11 queryString String - - 발신자명 또는 수신자명 검색조회, 공백처리시 전체조회

Return

FAXSearchResult[]

Throws

PopbillException

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

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

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

def getSentListURL(corpNum, userID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

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

ㆍ 팩스 미리보기 팝업 URL을 반환합니다.

ㆍ 반환되는 URL은 보안정책상 30초의 유효시간을 갖으며, 유효시간 이후 호출시 정상적으로 페이지가 호출되지 않습니다.

ㆍ 팩스 미리보기는 팩스전송을 위한 TIF 포맷 변환 완료후 호출할 수 있습니다.

def getPreviewURL(corpNum, receiptNum, userID = '')

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 - 연동회원 잔여포인트 확인

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

def getBalance(corpNum)

Parameters

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

Return

Float - 연동회원 잔여포인트

Throws

PopbillException

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

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

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

def getChargeURL(corpNum, userID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

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

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

def getPartnerBalance(corpNum)

Parameters

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

Return

Float - 파트너 잔여포인트

Throws

PopbillException

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

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

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

def getPartnerURL(corpNum, togo)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

4.5. GetUnitCost - 전송 단가 확인

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

def getUnitCost(corpNum, userID = "")

Parameters

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

Return

Float - 팩스 전송 단가

Throws

PopbillException

4.6. GetChargeInfo - 과금정보 확인

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

def getChargeInfo(corpNum, userID = "")

Parameters

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

Return

ChargeInfo

Throws

PopbillException

5. 회원정보

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

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

def checkIsMember(corpNum, linkID)

Parameters

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

Return

Response

Throws

PopbillException

5.2. CheckID - 아이디 중복 확인

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

def checkID(idValue)

Parameters

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

Return

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

Throws

PopbillException

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

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

def joinMember(joinInfo)

Parameters

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

Return

Response

Throws

PopbillException

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

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

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

def getAccessURL(corpNum, userID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

5.5. GetCorpInfo - 회사정보 확인

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

def getCorpInfo(corpNum, userID = "")

Parameters

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

Return

CorpInfo

Throws

PopbillException

5.6. UpdateCorpInfo - 회사정보 수정

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

def updateCorpInfo(corpNum, corpInfo, userID = "")

Parameters

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

Return

Response

Throws

PopbillException

5.7. RegistContact - 담당자 추가

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

def registContact(corpNum, contactInfo, userID = "")

Parameters

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

Return

Response

Throws

PopbillException

5.8. ListContact - 담당자 목록 확인

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

def listContact(corpNum, userID = "")

Parameters

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

Return

ContactInfo[]

Throws

PopbillException

5.9. UpdateContact - 담당자 정보 수정

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

def updateContact(corpNum, contactInfo, userID = "")

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 코드 Integer - API 처리에 대한 응답코드
2 message 메시지 String - API 처리에 대한 응답 메시지

A.2. PopbillException

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

A.3. SenderNumber

순번 변수명 항목명 타입 길이 비고
1 number 발신번호 String 20
2 representYN 대표번호 지정여부 Boolean -
3 state 등록일시 Integer 1 등록상태 [ 0-대기 / 1-승인 / 2-취소 ]

A.4. FaxReceiver

순번 변수명 항목명 타입 길이 필수 비고
1 receiveNum 수신번호 String 20 O
2 receiveName 수신자명 String 30 -

A.5. FAXSearchResult

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

A.6. FaxResult

순번 변수명 항목명 타입 길이 비고
1 state 전송상태 코드 Integer 1 [부록] "전송 코드 테이블"
2 result 전송결과 코드 Integer 3
3 sendNum 발신번호 String 20
4 senderName 발신자명 String 30
5 receiveNum 수신번호 String 20
6 receiveName 수신자명 String 30 -
7 title 팩스제목 String 100
8 sendPageCnt 전체 페이지수 Integer -
9 successPageCnt 성공 페이지수 Integer -
10 failPageCnt 실패 페이지수 Integer -
11 refundPageCnt 환불 페이지수 Integer -
12 cancelPageCnt 취소 페이지수 Integer -
13 reserveDT 예약일시 String 14
14 receiptDT 접수일시 String 14
15 sendDT 전송일시 String 14
16 resultDT 전송결과 수신일시 String 14
17 fileNames 전송 파일명 리스트 Array 20
18 receiptNum 접수번호 String 18
19 requestNum 요청번호 String 36
20 chargePageCnt 과금 페이지수 Integer -
21 tiffFileSize 변환파일용량 String - 단위 : byte

A.7. ChargeInfo

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

A.8. JoinForm

순번 변수명 항목명 타입 길이 필수 비고
1 ID 아이디 String 50 O 6자 이상 50자 미만
2 PWD 비밀번호 String 20 O 6자 이상 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
13 ContactHP 담당자 휴대폰번호 String 20 -
14 ContactFAX 담당자 팩스번호 String 20 -

A.9. 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.10. ContactInfo

순번 변수명 항목명 타입 길이 필수 비고
1 id 아이디 String 50 O 6자 이상 50자 미만
2 pwd 비밀번호 String 20 O 6자 이상 20자 미만
3 personName 담당자 성명 String 100 O
4 tel 담당자 연락처 String 20 -
5 hp 담당자 휴대폰번호 String 20 -
6 fax 담당자 팩스번호 String 20 -
7 email 담당자 이메일 String 100 O
8 regDT 등록일시 String 14 -
9 searchAllAllowYN 담당자 조회권한 설정 Boolean - O 회사조회(true) : 모든 담당자의 팩스 전송내역 조회가능
개인조회(false) : 해당 담당자 계정으로 전송한 팩스 전송내역 조회가능
10 mgrYN 관리자 여부 Boolean - O true-관리자 / false-사용자
11 state 상태 Integer 1 - 0–승인대기 / 1–사용중