POPBill Developers
API Reference

A. 객체정보

Response

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

PopbillException

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

SenderNumber

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

FaxReceiver

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

FAXSearchResult

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

FaxResult

순번변수명타입길이설명
state int? 1 상태코드
result int? 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 int? N 전체 페이지수
successPageCnt int? N 성공 페이지수
failPageCnt int? N 실패 페이지수
cancelPageCnt int? N 취소 페이지수
reserveDT string 14 예약일시
형식 : yyyyMMddHHmmss
receiptDT string 14 접수일시
형식 : yyyyMMddHHmmss
sendDT string 14 전송일시
형식 : yyyyMMddHHmmss
resultDT string 14 전송결과 수신일시
형식 : yyyyMMddHHmmss
fileNames string[ ] 전송 파일명 리스트
최대 : 20개
receiptNum string 18 팩스 전송요청시 팝빌로부터 반환 받은 접수번호
requestNum string 36 팩스 전송요청시 파트너가 할당한 요청번호
interOPRefKey string 20 파트너 지정키
팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
chargePageCnt int? N 과금 페이지수
refundPageCnt int? N 환불 페이지수
tiffFileSize string - 변환파일용량
단위 : byte