A. 객체정보
Response
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Long | - |
API 처리에 대한 응답코드
1성공
|
|
| message | String | - | API 처리에 대한 응답메시지 |
Err
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| Number | Long | - |
API 처리 실패에 대한 오류코드
음의 정수 8자리 숫자값 [참고] 오류코드
|
|
| Description | String | - | API 처리 실패에 대한 오류메시지 |
SenderNumber
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| number | String | 20 | 발신번호 | |
| representYN | Boolean | - |
대표번호 지정여부
True대표번호
False일반번호
|
|
| state | Integer | 1 |
등록상태
0대기
1승인
2취소
|
|
| memo | String | 200 | 메모 |
FaxReceiver
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| receiverNum | String | 20 | Y | 팩스 단말기 번호 또는 인터넷 팩스 번호 | |
| receiverName | String | 30 | N | 수신자명 | |
| interOPRefKey | String | 20 | N |
파트너 지정키
팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
FAXSearchResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Integer | - |
API 처리에 대한 응답코드
1성공
|
|
| message | String | - | API 처리에 대한 응답메시지 | |
| total | String | - | 총 검색결과 건수 | |
| perPage | String | - | 페이지당 목록 건수 | |
| pageNum | String | - | 페이지 번호 | |
| pageCount | String | - | 페이지 개수 | |
| list | FaxState( ) |
전송결과 정보
최대 : 1,000건
|
||
FaxState
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| state | Integer | 1 | 팝빌 상태코드 | |
| result | Integer | 3 |
통신사 결과코드
{state} = 3 경우 팩스 전송결과 확인 가능
|
|
| sendNum | String | 20 | 발신번호 | |
| senderName | String | 30 | 발신자명 | |
| receiveNum | String | 20 | 수신번호 | |
| receiveName | String | 30 | 수신자명 | |
| receiveNumType | String | 2 |
수신번호 유형
일반일반망 (지능망을 제외한 번호)
지능지능망 (030*, 050*, 070*, 080*, 대표번호)
|
|
| 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 | Arrays | 20 |
전송 파일명 리스트
형식 : yyyyMMddHHmmss
|
|
| receiptNum | String | 18 | 팩스 전송요청시 팝빌로부터 반환 받은 접수번호 | |
| requestNum | String | 36 | 팩스 전송요청시 파트너가 할당한 요청번호 | |
| interOPRefKey | String | 20 |
파트너 지정키
팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
|
| 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 | 조건부 | 비밀번호 | |
| personName | String | 100 | Y | 담당자 성명 | |
| tel | String | 20 | Y | 담당자 휴대폰 | |
| String | 100 | Y | 담당자 이메일 | ||
| searchRole | Integer | 1 | N |
담당자 권한
1개인권한
2읽기권한
3회사권한 : 기본값
|
ContactInfo - 출력부
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| id | String | 50 | 아이디 | |
| personName | String | 100 | 담당자 성명 | |
| tel | String | 20 | 담당자 휴대폰 | |
| String | 100 | 담당자 이메일 | ||
| regDT | String | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
| searchRole | Integer | 1 |
담당자 권한
1개인권한
2읽기권한
3회사권한
|
|
| mgrYN | Boolean | - |
관리자 여부
True관리자
False담당자
팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
|
|
| state | Integer | 1 |
계정상태
1사용중
|
RefundHistory
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| reqDT | String | 14 |
신청일시
형식 : yyyyMMddHHmmss
|
|
| requestPoint | String | 18 | 환불 신청포인트 | |
| accountBank | String | 10 | 환불계좌 은행명 | |
| accountNum | String | 50 | 환불계좌번호 | |
| accountName | String | 70 | 환불계좌 예금주명 | |
| state | Integer | 1 |
상태
|
|
| reason | String | 200 | 환불사유 |
RefundHistoryResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Long | - |
API 처리에 대한 응답코드
1성공
|
|
| total | Long | - | 총 검색결과 건수 | |
| perPage | Long | - | 페이지당 목록 건수 | |
| pageNum | Long | - | 페이지 번호 | |
| pageCount | Long | - | 페이지 개수 | |
| list | List<RefundHistory> | 환불내역 | ||
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 | 환불사유 |
PaymentHistory
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| productType | String | 3 |
결제 내용
포인트
정액제
미수금
|
|
| productName | String | 30 | 결제 상품명 | |
| settleType | String | 7 |
결제유형
무통장
신용카드
실시간계좌이체
|
|
| settlerName | String | 100 | 담당자명 | |
| settlerEmail | String | 100 | 담당자메일 | |
| settleCost | String | 18 | 결제금액 | |
| settlePoint | String | 18 | 충전포인트 | |
| settleState | Integer | 1 |
결제상태
|
|
| regDT | String | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
| stateDT | String | 14 |
상태일시
형식 : yyyyMMddHHmmss
|
PaymentHistoryResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Long | - |
API 처리에 대한 응답코드
1성공
|
|
| total | Long | - | 총 검색결과 건수 | |
| perPage | Long | - | 페이지당 목록 건수 | |
| pageNum | Long | - | 페이지 번호 | |
| pageCount | Long | - | 페이지 개수 | |
| list | List<PaymentHistory> | 결제내역 | ||
UseHistoryResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Long | - |
API 처리에 대한 응답코드
1성공
|
|
| total | Long | - | 총 검색결과 건수 | |
| perPage | Long | - | 페이지당 목록 건수 | |
| pageNum | Long | - | 페이지 번호 | |
| pageCount | Long | - | 페이지 개수 | |
| list | List<UseHistory> | 사용내역 | ||
RefundResponse
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | Long | - |
API 처리에 대한 응답코드
1성공
|
|
| message | String | - | API 처리에 대한 응답메시지 | |
| refundCode | String | 18 | 환불코드 |
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 | 정산코드 |