POPBill Developers
API Reference

A. 객체정보

PBResponse

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

Err (Property)

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

PBFaxSenderNumber

순번 변수명 타입 길이 비고
number String 20 발신번호
representYN Boolean - 대표번호 지정여부 : True / False 중 반환
└ True : 대표번호
└ False : 일반번호
state Integer 1 등록상태 : 0 / 1 / 2 중 반환
└ 0 : 대기
└ 1 : 승인
└ 2 : 취소

PBReceiver

순번 변수명 타입 길이 필수 비고
receiveNum String 20 O 팩스 단말기 번호 또는 인터넷 팩스 번호
receiveName String 30 - 수신자명
interOPRefKey String 20 - 파트너 지정 키
└ 팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

PBFaxSearchList

순번 변수명 타입 길이 비고
code Integer - API 처리에 대한 응답코드
message String - API 처리에 대한 응답메시지
total Integer - 총 검색결과 건수
perPage Integer - 페이지당 검색개수
pageNum Integer - 페이지 번호
pageCount Integer - 페이지 개수
list PBFaxInfo[ ] 전송결과 정보 (최대 1,000건)
[GetMessages - 전송내역 확인] 응답전문의 구성과 동일

PBFaxInfo

순번 변수명 타입 길이 비고
state Integer 1 전송상태 코드
[참고] 전송 상태 및 결과 코드
result Integer 3 전송결과 코드
sendNum String 20 발신번호
senderName String 30 발신자명
receiveNum String 20 수신번호
receiveNumType String 2 수신번호 유형
└ "일반" / "지능" 중 반환
receiveName String 30 수신자명
title String 100 팩스제목
sendPageCnt Integer - 전체 페이지수
successPageCnt Integer - 성공 페이지수
failPageCnt Integer - 실패 페이지수
cancelPageCnt Integer - 취소 페이지수
reserveDT String 14 예약일시 (형식 : yyyyMMddHHmmss)
receiptDT String 14 접수일시 (형식 : yyyyMMddHHmmss)
sendDT String 14 전송일시 (형식 : yyyyMMddHHmmss)
resultDT String 14 전송결과 수신일시 (형식 : yyyyMMddHHmmss)
fileNames Collection 20 전송 파일명 리스트
receiptNum String 18 접수번호
└ 팩스 전송요청시 팝빌로부터 반환 받은 값
requestNum String 36 요청번호
└ 팩스 전송요청시 파트너가 할당한 고유한 식별값
interOPRefKey String 20 파트너 지정 키
└ 팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
chargePageCnt Integer - 과금 페이지수
refundPageCnt Integer - 환불 페이지수
tiffFileSize String - 변환파일용량
└ 단위 : byte

PBChargeInfo

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

PBJoinForm

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

PBCorpInfo

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

PBContactInfo

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