A. 객체정보
Response
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | long | - |
API 처리에 대한 응답코드
1성공
|
|
message | string | - | API 처리에 대한 응답메시지 |
PopbillException
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | long | - |
API 처리 실패에 대한 오류코드
음의 정수 8자리 숫자값 [참고] 오류코드
|
|
message | string | - | API 처리 실패에 대한 오류메시지 |
SenderNumber
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
number | string | 20 | 발신번호 | |
representYN | boolean | - |
대표번호 지정여부
true대표번호
false일반번호
|
|
state | integer | 1 |
등록상태
0대기
1승인
2취소
|
FaxReceiver
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
receiveNum | string | 20 | Y | 팩스 단말기 번호 또는 인터넷 팩스 번호 | |
receiveName | string | 30 | N | 수신자명 | |
interOPRefKey | string | 20 | N |
파트너 지정키
팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
FAXSearchResult
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | string | - |
API 처리에 대한 응답코드
1성공
|
|
message | string | - | API 처리에 대한 응답메시지 | |
total | string | - | 총 검색결과 건수 | |
perPage | string | - | 페이지당 목록 건수 | |
pageNum | string | - | 페이지 번호 | |
pageCount | string | - | 페이지 개수 | |
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 | string[ ] |
전송 파일명 리스트
최대 : 20개
|
||
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 | 종목 |
Contact - 입력부
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
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회사권한 : 기본값
|
Contact - 출력부
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
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 | string | 1 |
계정상태
1사용중
|