전송결과

1. GetFaxResult - 전송내역 확인 (접수번호)

GET https://popbill-test.linkhub.co.kr/FAX/{receiptNum}

팝빌에서 반환 받은 접수번호를 통해 팩스 전송상태 및 결과를 확인합니다.

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
3	`Accept-Encoding`	N	응답 압축 방식 `gzip`
4	`X-PB-UserID`	N	팝빌회원 아이디

Path 파라미터

순번	변수명	타입	길이	필수	설명
1	`receiptNum`	string	18	Y	팝빌에서 할당한 접수번호

요청 예시

curl --request GET \
  --url 'https://{domain}/FAX/{receiptNum}' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번	변수명	타입	길이	설명
1	`state`	number	1	상태코드 [참고] 팝빌 상태코드
2	`result`	number	3	결과코드 [참고] 통신사 결과코드 {state} = 3 경우 팩스 전송결과 확인 가능
3	`sendNum`	string	20	발신번호
4	`senderName`	string	100	발신자명
5	`receiveNum`	string	20	수신번호
6	`receiveNumType`	string	2	수신번호 유형 `일반` 일반망 (지능망을 제외한 번호) : 기본값 `지능` 지능망 (030, 050, 070, 080, 대표번호)
7	`receiveName`	string	30	수신자명
8	`title`	string	100	팩스제목
9	`sendPageCnt`	number	-	전체 페이지수
10	`successPageCnt`	number	-	성공 페이지수
11	`failPageCnt`	number	-	실패 페이지수
12	`cancelPageCnt`	number	-	취소 페이지수
13	`reserveDT`	string	14	예약일시 형식 : yyyyMMddHHmmss
14	`receiptDT`	string	14	접수일시 형식 : yyyyMMddHHmmss
15	`sendDT`	string	14	전송일시 형식 : yyyyMMddHHmmss
16	`resultDT`	string	14	전송결과 수신일시 형식 : yyyyMMddHHmmss
17	`fileNames`	array	-	전송 파일명 리스트 최대 : 30개
18	`receiptNum`	string	18	팝빌에서 할당한 접수번호
19	`requestNum`	string	36	파트너가 할당한 요청번호
20	`interOPRefKey`	string	20	파트너 지정키 팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
21	`chargePageCnt`	number	-	과금 페이지수
22	`refundPageCnt`	number	-	환불 페이지수
23	`tiffFileSize`	string	-	변환파일용량 단위 : byte

응답 예시

[
    {
        "state": 1,
        "sendNum": "16008536",
        "receiveNum": "02-6442-9700",
        "receiveName": "링크허브",
        "receiptDT": "20251022151211",
        "fileNames": [
            "test.pdf"
        ],
        "receiptNum": "025102215121100001",
        "receiveNumType": "일반"
    }
]

2. GetFaxResultRN - 전송내역 확인 (요청번호)

GET https://popbill-test.linkhub.co.kr/FAX/Get/{requestNum}

파트너가 할당한 요청번호를 통해 팩스 전송상태 및 결과를 확인합니다.

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
3	`Accept-Encoding`	N	응답 압축 방식 `gzip`
4	`X-PB-UserID`	N	팝빌회원 아이디

Path 파라미터

순번	변수명	타입	길이	필수	설명
1	`requestNum`	string	36	Y	파트너가 할당한 요청번호

요청 예시

curl --request GET \
  --url 'https://{domain}/FAX/Get/{requestNum}' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번	변수명	타입	길이	설명
1	`state`	number	1	상태코드 [참고] 팝빌 상태코드
2	`result`	number	3	결과코드 [참고] 통신사 결과코드 {state} = 3 경우 팩스 전송결과 확인 가능
3	`sendNum`	string	20	발신번호
4	`senderName`	string	100	발신자명
5	`receiveNum`	string	20	수신번호
6	`receiveNumType`	string	2	수신번호 유형 `일반` 일반망 (지능망을 제외한 번호) : 기본값 `지능` 지능망 (030, 050, 070, 080, 대표번호)
7	`receiveName`	string	30	수신자명
8	`title`	string	100	팩스제목
9	`sendPageCnt`	number	-	전체 페이지수
10	`successPageCnt`	number	-	성공 페이지수
11	`failPageCnt`	number	-	실패 페이지수
12	`cancelPageCnt`	number	-	취소 페이지수
13	`reserveDT`	string	14	예약일시 형식 : yyyyMMddHHmmss
14	`receiptDT`	string	14	접수일시 형식 : yyyyMMddHHmmss
15	`sendDT`	string	14	전송일시 형식 : yyyyMMddHHmmss
16	`resultDT`	string	14	전송결과 수신일시 형식 : yyyyMMddHHmmss
17	`fileNames`	array	-	전송 파일명 리스트 최대 : 30개
18	`receiptNum`	string	18	팝빌에서 할당한 접수번호
19	`requestNum`	string	36	파트너가 할당한 요청번호
20	`interOPRefKey`	string	20	파트너 지정키 팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
21	`chargePageCnt`	number	-	과금 페이지수
22	`refundPageCnt`	number	-	환불 페이지수
23	`tiffFileSize`	string	-	변환파일용량 단위 : byte

응답 예시

[
    {
        "state": 1,
        "sendNum": "16008536",
        "receiveNum": "02-6442-9700",
        "receiveName": "링크허브",
        "receiptDT": "20251022152215",
        "fileNames": [
            "test.pdf"
        ],
        "receiptNum": "025102215221500001",
        "requestNum": "REQNUM-20251022152214",
        "receiveNumType": "일반"
    }
]

3. Search - 전송내역 목록 조회

GET https://popbill-test.linkhub.co.kr/FAX/Search

검색조건에 해당하는 팩스 전송내역 목록을 조회합니다. (조회기간 단위 : 최대 2개월)
팩스 접수일시로부터 6개월 이내 접수건만 조회할 수 있습니다.

매개변수 Page, PerPage, Order를 이용하여 페이징 기능을 구현할 수 있습니다.

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
3	`Accept-Encoding`	N	응답 압축 방식 `gzip`
4	`X-PB-UserID`	N	팝빌회원 아이디

Query 파라미터

순번	변수명	타입	길이	필수	설명
1	`SDate`	string	8	Y	검색 시작일자 형식 : yyyyMMdd
2	`EDate`	string	8	Y	검색 종료일자 형식 : yyyyMMdd
3	`State`	string	-	N	전송상태 (다중 선택 가능) `1` 대기 `2` 성공 `3` 실패 `4` 취소 다중 선택시 콤마(',')로 구분. 예) 1,2
4	`ReserveYN`	boolean	-	N	예약여부 `true` 예약전송건 `false` 즉시전송건 기본값 : 전체조회
5	`SenderOnly`	boolean	-	N	사용자권한별 조회 `true` 팝빌회원 아이디(UserID)로 전송한 팩스만 조회 `false` 전송한 팩스 전체 조회 : 기본값
6	`Page`	number	-	N	목록 페이지번호 기본값 : 1
7	`PerPage`	number	-	N	페이지당 표시할 목록 건수 최대 : 1,000건 기본값 : 500건
8	`Order`	string	1	N	팩스 접수일시를 기준으로 하는 목록 정렬 방향 `D` 내림차순 : 기본값 `A` 오름차순
9	`QString`	string	-	N	조회 검색어(발신자명, 수신자명, 수신번호) 기본값 : 전체조회

요청 예시

curl --request GET \
  --url 'https://{domain}/FAX/Search?SDate={SDate}&EDate={EDate}' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번 변수명 타입 길이 설명

code

number

API 처리에 대한 응답코드

1 성공

message

string

API 처리에 대한 응답메시지

total

number

총 검색결과 건수

perPage

number

페이지 당 목록 건수

pageNum

number

페이지 번호

pageCount

number

페이지 개수

array

전송결과 정보

최대 : 1,000건

list

순번	변수명	타입	길이	설명
1	`state`	number	1	상태코드 [참고] 팝빌 상태코드
2	`result`	number	3	결과코드 [참고] 통신사 결과코드 {state} = 3 경우 팩스 전송결과 확인 가능
3	`sendNum`	string	20	발신번호
4	`senderName`	string	100	발신자명
5	`receiveNum`	string	20	수신번호
6	`receiveNumType`	string	2	수신번호 유형 `일반` 일반망 (지능망을 제외한 번호) : 기본값 `지능` 지능망 (030, 050, 070, 080, 대표번호)
7	`receiveName`	string	30	수신자명
8	`title`	string	100	팩스제목
9	`sendPageCnt`	number	-	전체 페이지수
10	`successPageCnt`	number	-	성공 페이지수
11	`failPageCnt`	number	-	실패 페이지수
12	`cancelPageCnt`	number	-	취소 페이지수
13	`reserveDT`	string	14	예약일시 형식 : yyyyMMddHHmmss
14	`receiptDT`	string	14	접수일시 형식 : yyyyMMddHHmmss
15	`sendDT`	string	14	전송일시 형식 : yyyyMMddHHmmss
16	`resultDT`	string	14	전송결과 수신일시 형식 : yyyyMMddHHmmss
17	`fileNames`	array	-	전송 파일명 리스트 최대 : 30개
18	`receiptNum`	string	18	팝빌에서 할당한 접수번호
19	`requestNum`	string	36	파트너가 할당한 요청번호
20	`interOPRefKey`	string	20	파트너 지정키 팩스 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
21	`chargePageCnt`	number	-	과금 페이지수
22	`refundPageCnt`	number	-	환불 페이지수
23	`tiffFileSize`	string	-	변환파일용량 단위 : byte

응답 예시

{
    "code": 1,
    "total": 99,
    "perPage": 500,
    "pageNum": 1,
    "pageCount": 1,
    "list": [
        {
            "state": 3,
            "sendNum": "02-6442-9700",
            "receiveNum": "1234",
            "title": "현금영수증 [025092319355600001]",
            "sendPageCnt": 1,
            "successPageCnt": 0,
            "failPageCnt": 1,
            "chargePageCnt": 1,
            "refundPageCnt": 1,
            "receiptDT": "20250929103337",
            "sendDT": "20250929103648",
            "resultDT": "20250929103657",
            "result": 504,
            "fileNames": [
                "025092319355600001.pdf"
            ],
            "tiffFileSize": "10079",
            "receiptNum": "025092910333700001",
            "receiveNumType": "지능"
        }
    ],
    "message": "검색 완료"
}

4. GetSentListURL - 팩스 전송내역 팝업 URL

GET https://popbill-test.linkhub.co.kr/FAX

팩스 전송내역 팝업 URL 미리보기

팩스 전송내역 팝업 URL을 반환합니다.

권장 사이즈 : width = 1,350px (최소 1,000px) / height = 800px
반환되는 URL은 30초 동안만 사용이 가능합니다.
반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
3	`Accept-Encoding`	N	응답 압축 방식 `gzip`
4	`X-PB-UserID`	N	팝빌회원 아이디

Query 파라미터

순번	변수명	타입	길이	필수	설명
1	`TG`	string	-	Y	고정값 : BOX

요청 예시

curl --request GET \
  --url 'https://{domain}/FAX?TG=BOX' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번	변수명	타입	길이	설명
1	`url`	string	-	팩스 전송내역 팝업 URL

응답 예시

{
    "url": "https://test.popbill.com/App/API?T=IRXSGITDREOTPOIRLPUHCB4BSBC4...NX7BMAR3="
}

5. GetPreviewURL - 팩스 변환파일 확인 팝업 URL

GET https://popbill-test.linkhub.co.kr/FAX/Preview/{receiptNum}

팩스 변환파일 확인 팝업 URL 미리보기

팩스 1건의 변환파일을 확인하는 팝업 URL을 반환합니다.

권장 사이즈 : width = 1,250px (최소 900px) / height = 800px
반환되는 URL은 30초 동안만 사용이 가능합니다.
반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
3	`Accept-Encoding`	N	응답 압축 방식 `gzip`
4	`X-PB-UserID`	N	팝빌회원 아이디

Path 파라미터

순번	변수명	타입	길이	필수	설명
1	`receiptNum`	string	18	Y	팝빌에서 할당한 접수번호

요청 예시

curl --request GET \
  --url 'https://{domain}/FAX/Preview/{receiptNum}' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번	변수명	타입	길이	설명
1	`url`	string	-	팩스 변환파일 확인 팝업 URL

응답 예시

{
    "url": "https://test.popbill.com/App/API?T=IRXSGITDREOTPOIRLPUHCB4BSBC4...NX7BMAR3="
}