POPBill Developers
API Reference

A. 객체정보

Response

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

PopbillException

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

SenderNumber

순번변수명타입길이설명
number String 20 발신번호
representYN Boolean - 대표번호 지정여부
true대표번호
false일반번호
state Integer 1 등록상태
0대기
1승인
2취소
memo String 200 메모

FaxReceiver

순번변수명타입길이필수설명
receiveNum String 20 Y 팩스 단말기 번호 또는 인터넷 팩스 번호
receiveName String 30 N 수신자명

FileData

순번변수명타입길이필수설명
fileName String - Y 팩스로 전송할 파일명
fileData String - Y 팩스로 전송할 파일의 바이너리 데이터

FAXSearchResult

순번변수명타입길이설명
code Integer - API 처리에 대한 응답코드
1성공
message String - API 처리에 대한 응답메시지
total Integer - 총 검색결과 건수
perPage Integer - 페이지당 목록 건수
pageNum Integer - 페이지 번호
pageCount Integer - 페이지 개수
list FaxResult[ ] 전송결과 정보
최대 : 1,000건

FaxResult

순번변수명타입길이설명
state Integer 1 팝빌 상태코드
result Integer 3 통신사 결과코드
{state} = 3 경우 팩스 전송결과 확인 가능
sendNum String 20 발신번호
senderName String 30 발신자명
receiveNum String 20 수신번호
receiveNumType String 2 수신번호 유형
일반일반망 (지능망을 제외한 번호)
지능지능망 (030*, 050*, 070*, 080*, 대표번호)
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 Array 20 전송 파일명 리스트
receiptNum String 18 팩스 전송요청시 팝빌로부터 반환 받은 접수번호
requestNum String 36 팩스 전송요청시 파트너가 할당한 요청번호
chargePageCnt Integer - 과금 페이지수
refundPageCnt Integer - 환불 페이지수
tiffFileSize String - 변환파일용량
단위 : byte

ChargeInfo

순번변수명타입길이설명
unitCost String 12 전송단가
chargeMethod String 3 과금유형
연동
파트너
rateSystem String 3 과금제도
종량제

JoinForm

순번변수명타입길이필수설명
ID String 50 Y 아이디
6자 이상 50자 이하
Password String 20 Y 비밀번호
8자 이상 20자 이하
영문, 숫자, 특수문자(~!@#$%^&*()_+) 포함
LinkID String 20 Y 파트너 링크아이디
팝빌에서 발급한 링크아이디
CorpNum String 10 Y 사업자번호 ('-' 제외)
CEOName String 100 Y 대표자 성명
CorpName String 200 Y 회사명
Addr String 300 Y 사업장 주소
BizType String 100 Y 업태
BizClass String 100 Y 종목
ContactName String 100 Y 담당자 성명
ContactEmail String 100 Y 담당자 이메일
ContactTEL String 20 Y 담당자 휴대폰

CorpInfo

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

ContactInfo - 입력부

순번변수명타입길이필수설명
id String 50 Y 아이디
6자 이상 50자 이하
password String 20 조건부 비밀번호
8자 이상 20자 이하
영문, 숫자, 특수문자(~!@#$%^&*()_+) 포함
함수 [RegistContact - 담당자 추가]호출을 위한 필수값
personName String 100 Y 담당자 성명
tel String 20 Y 담당자 휴대폰
email String 100 Y 담당자 이메일
searchRole String 1 N 담당자 권한
1개인권한
2읽기권한
3회사권한 : 기본값

ContactInfo - 출력부

순번변수명타입길이설명
id String 50 아이디
personName String 100 담당자 성명
tel String 20 담당자 휴대폰
email String 100 담당자 이메일
regDT String 14 등록일시
형식 : yyyyMMddHHmmss
searchRole Integer 1 담당자 권한
1개인권한
2읽기권한
3회사권한
mgrYN Boolean - 관리자 여부
true관리자
false담당자
팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
state Integer 1 계정상태
1사용중