A. 객체정보
Response
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | int | - |
API 처리에 대한 응답코드
1성공
|
|
message | str | - | API 처리에 대한 응답메시지 |
PopbillException
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | int | - |
API 처리 실패에 대한 오류코드
음의 정수 8자리 숫자값 [참고] 오류코드
|
|
message | str | - | API 처리 실패에 대한 오류메시지 |
SenderNumber
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
number | str | 20 | 발신번호 | |
representYN | bool | - |
대표번호 지정여부
True대표번호
False일반번호
|
|
state | int | 1 |
등록상태
0대기
1승인
2취소
|
|
memo | str | 200 | 메모 |
FaxReceiver
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
receiveNum | str | 20 | Y | 팩스 단말기 번호 또는 인터넷 팩스 번호 | |
receiveName | str | 30 | N | 수신자명 | |
interOPRefKey | str | 20 | N |
파트너 지정키
팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
FileData
순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
---|---|---|---|---|---|
fileName | str | - | Y | 팩스로 전송할 파일명 | |
fileData | bytes | - | Y | 팩스로 전송할 파일의 바이너리 데이터 |
FAXSearchResult
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
code | int | - |
API 처리에 대한 응답코드
1성공
|
|
message | str | - | API 처리에 대한 응답메시지 | |
total | str | - | 총 검색결과 건수 | |
perPage | str | - | 페이지당 목록 건수 | |
pageNum | str | - | 페이지 번호 | |
pageCount | str | - | 페이지 개수 | |
list | List<FaxResult> |
전송결과 정보
최대 : 1,000건
|
FaxResult
순번 | 변수명 | 타입 | 길이 | 설명 |
---|---|---|---|---|
state | int | 1 | 상태코드 | |
result | int | 3 |
결과코드
{state} = 3 경우 팩스 전송결과 확인 가능
|
|
sendNum | str | 20 | 발신번호 | |
senderName | str | 30 | 발신자명 | |
receiveNum | str | 20 | 수신번호 | |
receiveNumType | str | 2 |
수신번호 유형
일반일반망 (지능망을 제외한 번호)
지능지능망 (030*, 050*, 070*, 080*, 대표번호)
|
|
receiveName | str | 30 | 수신자명 | |
title | str | 100 | 팩스제목 | |
sendPageCnt | int | - | 전체 페이지수 | |
successPageCnt | int | - | 성공 페이지수 | |
failPageCnt | int | - | 실패 페이지수 | |
cancelPageCnt | int | - | 취소 페이지수 | |
reserveDT | str | 14 |
예약일시
형식 : yyyyMMddHHmmss
|
|
receiptDT | str | 14 |
접수일시
형식 : yyyyMMddHHmmss
|
|
sendDT | str | 14 |
전송일시
형식 : yyyyMMddHHmmss
|
|
resultDT | str | 14 |
전송결과 수신일시
형식 : yyyyMMddHHmmss
|
|
fileNames | str[ ] | 20 | 전송 파일명 리스트 | |
receiptNum | str | 18 | 팩스 전송요청시 팝빌로부터 반환 받은 접수번호 | |
requestNum | str | 36 | 팩스 전송요청시 파트너가 할당한 요청번호 | |
interOPRefKey | str | 20 |
파트너 지정키
팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
|
chargePageCnt | int | - | 과금 페이지수 | |
refundPageCnt | int | - | 환불 페이지수 | |
tiffFileSize | str | - |
변환파일용량
단위 : byte
|