POPBill Developers
가이드

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

API Reference

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

SDK

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

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

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

API Reference
문자
.NET Core
API Reference 문자 .NET Core 객체정보

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 메모

MessageType

순번변수명타입길이설명
SMS enum - 단문
LMS enum - 장문
MMS enum - 포토
XMS enum - 단문/장문

Message

순번변수명타입길이필수설명
receiveNum string 20 Y 수신번호
receiveName string 70 N 수신자명
sendNum string 20 N 발신번호
대량전송 경우 사용
senderName string 70 N 발신자명
대량전송 경우 사용
content string - 조건부 메시지 내용
대량전송 경우 필수
단문 : 90byte 이하, 장문 : 2,000byte 이하
한글, 한자, 특수문자 2byte / 영문, 숫자, 공백 1byte
subject string 40 N 메시지 제목
대량전송 경우 사용
메시지 길이가 90byte 이상인 경우에만 적용
interOPRefKey string 20 N 파트너 지정키
문자 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

MSGSearchResult

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

MessageResult

순번변수명타입길이설명
subject string 40 메시지 제목
content string - 메시지 내용
단문 : 90byte 이하, 장문 : 2,000byte 이하
한글, 한자, 특수문자 2byte / 영문, 숫자, 공백 1byte
sendNum string 20 발신번호
senderName string 70 발신자명
receiveNum string 20 수신번호
receiveName string 70 수신자명
receiptDT string 14 접수일시
형식 : yyyyMMddHHmmss
sendDT string 14 전송일시
형식 : yyyyMMddHHmmss
resultDT string 14 전송결과 수신일시
형식 : yyyyMMddHHmmss
reserveDT string 14 예약일시
형식 : yyyyMMddHHmmss
state string 1 팝빌 상태코드
[참고] 팝빌 상태코드
result string 3 통신사 결과코드
[참고] 통신사 결과코드
type string 3 메시지 타입
tranNet string 3 전송처리 이동통신사명
receiptNum string 18 접수번호
requestNum string 36 요청번호
interOPRefKey string 20 파트너 지정키
문자 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

AutoDeny

순번변수명타입길이설명
number string 20 수신거부번호
regDT string 14 등록일시
형식 : yyyyMMddHHmmss

AutoDenyNumberInfo

순번변수명타입길이설명
smsdenyNumber string 20 전용 080 번호
regDT string 14 등록일시
형식 : yyyyMMddHHmmss

UseHistoryResult

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

UseHistory

순번변수명타입길이설명
itemCode int 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 int 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회사권한 : 기본값

Contact - 출력부

순번변수명타입길이설명
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 int 1 계정상태
1사용중