POPBill Developers
가이드

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

API Reference

서비스에 대한 정확한 이해로
최적의 구현방식을 적용합니다.

SDK

다수 개발자에게 검증받은
SDK Example을 제공합니다.

추가 개발언어는 신청주시면
검토 후 지원합니다.
Webhook(웹훅)

팝빌에서 발생한 이벤트 정보를
고객사 서버로 즉시 전송합니다.

API Reference
팩스
.NET
API Reference 팩스 .NET 객체정보

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일반번호
3 state int? 1 등록상태
0대기
1승인
2취소
memo String 200 메모

FaxReceiver

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

FAXSearchResult

순번변수명타입길이설명
code long - API 처리에 대한 응답코드
1성공
message String - API 처리에 대한 응답메시지
total long - 총 검색결과 건수
perPage long - 페이지당 목록 건수
pageNum long - 페이지 번호
pageCount long - 페이지 개수
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 - 수신번호 유형
일반일반망 (지능망을 제외한 번호)
지능지능망 (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

UseHistoryResult

순번변수명타입길이설명
code long - API 처리에 대한 응답코드
1성공
total long - 총 검색결과 건수
perPage long - 페이지당 목록 건수
pageNum long - 페이지 번호
pageCount long - 페이지 개수
list List<UseHistory> 사용내역

UseHistory

순번변수명타입길이설명
itemCode String 3 서비스 코드
  • 110세금계산서
  • 111홈택스수집(세금)
  • 121거래명세서
  • 122청구서
  • 123견적서
  • 124발주서
  • 125입금표
  • 126영수증
  • 140현금영수증
  • 141홈택스수집(현금)
  • 150문자(SMS)
  • 151문자(LMS)
  • 152문자(MMS)
  • 153알림톡
  • 154친구톡(텍스트)
  • 155친구톡(이미지)
  • 160팩스(일반망)
  • 161팩스(지능망)
  • 170사업자등록상태조회
  • 171기업정보조회
  • 180계좌조회
  • 182계좌성명조회
  • 183계좌실명조회
txType String 2 포인트 증감 유형
포인트 증가
  • 11포인트 충전
  • 12조정
  • 13조정
  • 19분배
  • 31환불
  • 32정액제 해지
포인트 감소
  • 21서비스 사용
  • 22조정
  • 23조정
  • 24포인트 결제
  • 25미수금 결제
  • 26포인트 환불
  • 29회수
  • 41후불누적조정
txPoint String 18 증감 포인트
balance String 18 잔여포인트
txDT String 14 포인트 증감 일시
형식 : yyyyMMddHHmmss
userID String 50 담당자 아이디
userName String 100 담당자명

PaymentHistoryResult

순번변수명타입길이설명
code long - API 처리에 대한 응답코드
1성공
total long - 총 검색결과 건수
perPage long - 페이지당 목록 건수
pageNum long - 페이지 번호
pageCount long - 페이지 개수
list List<PaymentHistory> 결제내역

PaymentHistory

순번변수명타입길이설명
productType String 3 결제 내용
포인트
정액제
미수금
productName String 30 결제 상품명
settleType String 7 결제유형
무통장
신용카드
실시간계좌이체
settlerName String 100 담당자명
settlerEmail String 100 담당자메일
settleCost String 18 결제금액
settlePoint String 18 충전포인트
settleState int 1 결제상태
  • 1대기
  • 2승인
  • 3실패
  • 45취소
regDT String 14 등록일시
형식 : yyyyMMddHHmmss
stateDT String 14 상태일시
형식 : yyyyMMddHHmmss

PaymentForm

순번변수명타입길이필수설명
settlerName String 100 N 담당자명
settlerEmail String 100 N 담당자 이메일
notifyHP String 20 N 담당자 휴대폰
무통장 입금 승인 알림톡이 전송될 번호
paymentName String 70 Y 입금자명
settleCost String 18 Y 결제금액

PaymentResponse

순번변수명타입길이설명
code long - 응답코드
message String - 응답메시지
settleCode String 18 정산코드

RefundHistoryResult

순번변수명타입길이설명
code long - API 처리에 대한 응답코드
1성공
total long - 총 검색결과 건수
perPage long - 페이지당 목록 건수
pageNum long - 페이지 번호
pageCount long - 페이지 개수
list List<RefundHistory> 환불내역

RefundHistory

순번변수명타입길이설명
reqDT String 14 신청일시
형식 : yyyyMMddHHmmss
requestPoint String 18 환불 신청포인트
accountBank String 10 환불계좌 은행명
accountNum String 50 환불계좌번호
accountName String 70 환불계좌 예금주명
state int 1 상태
  • 1 접수대기
  • 2 심사중
  • 3 입금대기
  • 4 환불완료
  • 5 취소
reason String 200 환불사유

RefundForm

순번변수명타입길이필수설명
contactName String 100 Y 담당자명
tel String 20 Y 담당자 연락처
requestPoint String 18 Y 환불 신청 포인트
accountBank String 10 Y 은행명
accountNum String 50 Y 계좌번호
accountName String 70 Y 예금주명
reason String 200 N 환불사유

RefundResponse

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

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 종목

Contact - 입력부

순번변수명타입길이필수설명
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 int? 1 N 담당자 권한
1개인권한
2읽기권한
3회사권한 : 기본값

ContactInfo - 출력부

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