팩스전송

1. SendFAX - 팩스 전송

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

POST https://popbill.linkhub.co.kr/FAX

팩스 1건을 전송합니다. (최대 전송파일 개수: 30개)

Request

요청 헤더

변수명	필수	설명
Authorization	Y	인증 토큰 [참고] 인증 및 헤더 설정
Content-Type	Y	요청 본문 형식 multipart/form-data
Accept-Language	N	응답 언어 설정 ko-KR: 기본값 en-US
Accept-Encoding	N	응답 압축 방식 gzip
X-PB-UserID	N	팝빌회원 아이디

요청 본문

순번

변수명

타입

길이

필수

설명

form

object

팩스 정보

순번

변수명

타입

길이

필수

설명

snd

string

발신번호

팝빌에 사전등록되지 않은 발신번호를 입력시 '원발신번호'로 전송됨

rcvs

array

수신자 정보

순번	변수명	타입	길이	필수	설명
	rcv	string	20	Y	수신번호
	rcvnm	string	30	N	수신자명

sndDT

string

전송 예약일시

형식 : yyyyMMddHHmmss

기본값 : 즉시전송

adsYN

boolean

광고팩스 전송 여부

true광고

false일반 : 기본값

fCnt

number

파일 개수

requestNum

string

요청번호

파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

file

파일

최대 : 30개

[참고] 권장 파일 확장자

요청 예시

curl --request POST \
  --url 'https://{domain}/FAX' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: multipart/form-data' \
  --form 'form="{ \"snd\": \"16008536\", \"rcvs\": [{ \"rcv\": \"16008536\", \"rcvnm\": \"수신자명\" }], \"fCnt\": \"2\" }"' \
  --form 'file=@"/path/test1.pdf"' \
  --form 'file=@"/path/test2.pdf"'

Response

응답 본문

순번	변수명	타입	길이	설명
	receiptNum	string	18	접수번호

응답 예시

{
    "receiptNum": "025102015544100001"
}

2. SendFAX - 팩스 전송 (동보전송)

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

POST https://popbill.linkhub.co.kr/FAX

동일한 팩스파일을 다수의 수신자에게 전송하기 위해 팝빌에 접수합니다. (최대 전송파일 개수 : 30개) (최대 1,000건)

Request

요청 헤더

변수명	필수	설명
Authorization	Y	인증 토큰 [참고] 인증 및 헤더 설정
Content-Type	Y	요청 본문 형식 multipart/form-data
Accept-Language	N	응답 언어 설정 ko-KR: 기본값 en-US
Accept-Encoding	N	응답 압축 방식 gzip
X-PB-UserID	N	팝빌회원 아이디

요청 본문

순번

변수명

타입

길이

필수

설명

form

object

팩스 정보

순번

변수명

타입

길이

필수

설명

snd

string

발신번호

팝빌에 사전등록되지 않은 발신번호를 입력시 '원발신번호'로 전송됨

sndnm

string

100

발신자명

rcvs

array

수신자 정보

변수명	타입	길이	필수	설명
rcv	string	20	Y	수신번호
rcvnm	string	30	N	수신자명
interOPRefKey	string	20	N	파트너 지정키 팩스 동보전송시 파트너가 개별건마다 입력할 수 있는 값

sndDT

string

전송 예약일시

형식 : yyyyMMddHHmmss

기본값 : 즉시전송

adsYN

boolean

광고팩스 전송 여부

true광고

false일반 : 기본값

fCnt

number

파일 개수

requestNum

string

요청번호

파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

file

파일

최대 : 30개

[참고] 권장 파일 확장자

요청 예시

curl --request POST \
  --url 'https://{domain}/FAX' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: multipart/form-data' \
  --form 'form="{ \"snd\": \"16008536\", \"rcvs\": [{ \"rcv\": \"16008536\", \"rcvnm\": \"수신자명\" }], \"fCnt\": \"2\" }"' \
  --form 'file=@"/path/test1.pdf"' \
  --form 'file=@"/path/test2.pdf"'

Response

응답 본문

순번	변수명	타입	길이	설명
	receiptNum	string	18	접수번호

응답 예시

{
    "receiptNum": "025102015544100001"
}

3. ResendFAX - 팩스 재전송 (접수번호)

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

POST https://popbill.linkhub.co.kr/FAX/{receiptNum}

팝빌에서 반환받은 접수번호를 통해 팩스 1건을 재전송합니다.
발신/수신 정보 미입력시 기존과 동일한 정보로 팩스가 전송되고, 접수일 기준 최대 60일이 경과되지 않는 건만 재전송이 가능합니다.

팩스 재전송이 가능한 상태는 다음과 같습니다.
1. 원본 팩스 접수 후 60일 이내이며, 최초 팩스 전송 시 변환에 성공한 경우
2. 최초 팩스 전송 시 변환에 실패했으나 재전송이 가능한 경우

재전송이 가능한 변환 실패 코드는 아래와 같습니다.
• 414 : 팩스 변환 실패
• 415 : 팩스 변환 시간 초과
• 416 : 팩스 파일 처리 중 오류
• 498 : 기타 오류로 인한 변환 실패

Request

요청 헤더

변수명	필수	설명
Authorization	Y	인증 토큰 [참고] 인증 및 헤더 설정
Content-Type	Y	요청 본문 형식 application/json
Accept-Language	N	응답 언어 설정 ko-KR: 기본값 en-US
Accept-Encoding	N	응답 압축 방식 gzip
X-PB-UserID	N	팝빌회원 아이디

Path 파라미터

순번	변수명	타입	길이	필수	설명
	receiptNum	string	18	Y	원본 팩스 접수번호

요청 본문

순번

변수명

타입

길이

필수

설명

snd

string

발신번호

발신번호를 변경해야할 경우 사용

기본값 : 원본 팩스 발신번호

sndnm

string

발신자명

발신자명을 변경해야할 경우 사용

기본값 : 원본 팩스 발신자명

rcvs

array

수신자 정보

순번	변수명	타입	길이	필수	설명
	rcv	string	20	N	수신번호 수신번호를 변경해야할 경우 사용 기본값 : 원본 팩스 수신번호
	rcvnm	string	30	N	수신자명 수신자명을 변경해야할 경우 사용 기본값 : 원본 팩스 수신자명

sndDT

string

전송 예약일시

형식 : yyyyMMddHHmmss

기본값 : 즉시전송

title

string

100

팩스제목

requestNum

string

요청번호

파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

요청 예시

curl --request POST \
  --url 'https://{domain}/FAX/{receiptNum}' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "rcvs": [
        {
            "rcv": "01012345678"
        }
    ]
}'

Response

응답 본문

순번	변수명	타입	길이	설명
	receiptNum	string	18	접수번호

응답 예시

{
    "receiptNum": "025102015544100001"
}

4. ResendFAX - 팩스 재전송 (접수번호 동보전송)

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

POST https://popbill.linkhub.co.kr/FAX/{receiptNum}

동일한 팩스파일을 다수의 수신자에게 전송하기 위해 팝빌에 접수합니다. (최대 1,000건)
발신/수신 정보 미입력시 기존과 동일한 정보로 팩스가 전송되고, 접수일 기준 최대 60일이 경과되지 않는 건만 재전송이 가능합니다.

팩스 재전송이 가능한 상태는 다음과 같습니다.
1. 원본 팩스 접수 후 60일 이내이며, 최초 팩스 전송 시 변환에 성공한 경우
2. 최초 팩스 전송 시 변환에 실패했으나 재전송이 가능한 경우

재전송이 가능한 변환 실패 코드는 아래와 같습니다.
• 414 : 팩스 변환 실패
• 415 : 팩스 변환 시간 초과
• 416 : 팩스 파일 처리 중 오류
• 498 : 기타 오류로 인한 변환 실패

Request

요청 헤더

변수명	필수	설명
Authorization	Y	인증 토큰 [참고] 인증 및 헤더 설정
Content-Type	Y	요청 본문 형식 application/json
Accept-Language	N	응답 언어 설정 ko-KR: 기본값 en-US
Accept-Encoding	N	응답 압축 방식 gzip
X-PB-UserID	N	팝빌회원 아이디

Path 파라미터

순번	변수명	타입	길이	필수	설명
	receiptNum	string	18	Y	원본 팩스 접수번호

요청 본문

순번

변수명

타입

길이

필수

설명

snd

string

발신번호

발신번호를 변경해야할 경우 사용

기본값 : 원본 팩스 발신번호

sndnm

string

발신자명

발신자명을 변경해야할 경우 사용

기본값 : 원본 팩스 발신자명

rcvs

array

수신자 정보

최대 : 1,000건

변수명	타입	길이	필수	설명
rcv	string	20	N	수신번호 수신번호를 변경해야할 경우 사용 기본값 : 원본 팩스 수신번호
rcvnm	string	30	N	수신자명 수신자명을 변경해야할 경우 사용 기본값 : 원본 팩스 수신자명
interOPRefKey	string	20	N	파트너 지정키 팩스 동보전송시 파트너가 개별건마다 입력할 수 있는 값

sndDT

string

전송 예약일시

형식 : yyyyMMddHHmmss

기본값 : 즉시전송

title

string

100

팩스제목

requestNum

string

요청번호

파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

요청 예시

curl --request POST \
  --url 'https://{domain}/FAX/{receiptNum}' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "rcvs": [
        {
            "rcv": "01012345678"
        }
    ]
}'

Response

응답 본문

순번	변수명	타입	길이	설명
	receiptNum	string	18	접수번호

응답 예시

{
    "receiptNum": "025102015544100001"
}

5. ResendFAXRN - 팩스 재전송 (요청번호)

POST https://popbill-test.linkhub.co.kr/FAX/Resend/{orgRequestNum}

POST https://popbill.linkhub.co.kr/FAX/Resend/{orgRequestNum}

파트너가 할당한 요청번호를 통해 팩스 1건을 재전송합니다.
발신/수신 정보 미입력시 기존과 동일한 정보로 팩스가 전송되고, 접수일 기준 최대 60일이 경과되지 않는 건만 재전송이 가능합니다.

팩스 재전송이 가능한 상태는 다음과 같습니다.
1. 원본 팩스 접수 후 60일 이내이며, 최초 팩스 전송 시 변환에 성공한 경우
2. 최초 팩스 전송 시 변환에 실패했으나 재전송이 가능한 경우

재전송이 가능한 변환 실패 코드는 아래와 같습니다.
• 414 : 팩스 변환 실패
• 415 : 팩스 변환 시간 초과
• 416 : 팩스 파일 처리 중 오류
• 498 : 기타 오류로 인한 변환 실패

Request

요청 헤더

변수명	필수	설명
Authorization	Y	인증 토큰 [참고] 인증 및 헤더 설정
Content-Type	Y	요청 본문 형식 application/json
Accept-Language	N	응답 언어 설정 ko-KR: 기본값 en-US
Accept-Encoding	N	응답 압축 방식 gzip
X-PB-UserID	N	팝빌회원 아이디

Path 파라미터

순번	변수명	타입	길이	필수	설명
	orgRequestNum	string	36	Y	원본 팩스 요청번호

요청 본문

순번

변수명

타입

길이

필수

설명

snd

string

발신번호

발신번호를 변경해야할 경우 사용

기본값 : 원본 팩스 발신번호

sndnm

string

발신자명

발신자명을 변경해야할 경우 사용

기본값 : 원본 팩스 발신자명

rcvs

array

수신자 정보

순번	변수명	타입	길이	필수	설명
	rcv	string	20	N	수신번호 수신번호를 변경해야할 경우 사용 기본값 : 원본 팩스 수신번호
	rcvnm	string	30	N	수신자명 수신자명을 변경해야할 경우 사용 기본값 : 원본 팩스 수신자명

sndDT

string

전송 예약일시

형식 : yyyyMMddHHmmss

기본값 : 즉시전송

title

string

100

팩스제목

requestNum

string

요청번호

파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

요청 예시

curl --request POST \
  --url 'https://{domain}/FAX/Resend/{orgRequestNum}' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "rcvs": [
        {
            "rcv": "01012345678"
        }
    ]
}'

Response

응답 본문

순번	변수명	타입	길이	설명
	receiptNum	string	18	접수번호

응답 예시

{
    "receiptNum": "025102015544100001"
}

6. ResendFAXRN - 팩스 재전송 (요청번호 동보전송)

POST https://popbill-test.linkhub.co.kr/FAX/Resend/{orgRequestNum}

POST https://popbill.linkhub.co.kr/FAX/Resend/{orgRequestNum}

파트너가 할당한 요청번호를 통해 다수건의 팩스를 재전송합니다. (최대 1,000건)
발신/수신 정보 미입력시 기존과 동일한 정보로 팩스가 전송되고, 접수일 기준 최대 60일이 경과되지 않는 건만 재전송이 가능합니다.

팩스 재전송이 가능한 상태는 다음과 같습니다.
1. 원본 팩스 접수 후 60일 이내이며, 최초 팩스 전송 시 변환에 성공한 경우
2. 최초 팩스 전송 시 변환에 실패했으나 재전송이 가능한 경우

재전송이 가능한 변환 실패 코드는 아래와 같습니다.
• 414 : 팩스 변환 실패
• 415 : 팩스 변환 시간 초과
• 416 : 팩스 파일 처리 중 오류
• 498 : 기타 오류로 인한 변환 실패

Request

요청 헤더

변수명	필수	설명
Authorization	Y	인증 토큰 [참고] 인증 및 헤더 설정
Content-Type	Y	요청 본문 형식 application/json
Accept-Language	N	응답 언어 설정 ko-KR: 기본값 en-US
Accept-Encoding	N	응답 압축 방식 gzip
X-PB-UserID	N	팝빌회원 아이디

Path 파라미터

순번	변수명	타입	길이	필수	설명
	orgRequestNum	string	36	Y	원본 팩스 요청번호

요청 본문

순번

변수명

타입

길이

필수

설명

snd

string

발신번호

발신번호를 변경해야할 경우 사용

기본값 : 원본 팩스 발신번호

sndnm

string

발신자명

발신자명을 변경해야할 경우 사용

기본값 : 원본 팩스 발신자명

rcvs

array

수신자 정보

변수명	타입	길이	필수	설명
rcv	string	20	N	수신번호 수신번호를 변경해야할 경우 사용 기본값 : 원본 팩스 수신번호
rcvnm	string	30	N	수신자명 수신자명을 변경해야할 경우 사용 기본값 : 원본 팩스 수신자명
interOPRefKey	string	20	N	파트너 지정키 팩스 동보전송시 파트너가 개별건마다 입력할 수 있는 값

sndDT

string

전송 예약일시

형식 : yyyyMMddHHmmss

기본값 : 즉시전송

title

string

100

팩스제목

requestNum

string

요청번호

파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

요청 예시

curl --request POST \
  --url 'https://{domain}/FAX/Resend/{orgRequestNum}' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "rcvs": [
        {
            "rcv": "01012345678"
        }
    ]
}'

Response

응답 본문

순번	변수명	타입	길이	설명
	receiptNum	string	18	접수번호

응답 예시

{
    "receiptNum": "025102015544100001"
}

7. CancelReserve - 예약전송 취소 (접수번호)

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

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

팝빌에서 반환받은 접수번호로 예약된 팩스를 전송 취소합니다. (예약시간 10분 전까지 가능)

Request

요청 헤더

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

Path 파라미터

순번	변수명	타입	길이	필수	설명
	receiptNum	string	18	Y	팝빌에서 할당한 접수번호 팩스 예약전송 요청의 반환값

요청 예시

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

Response

응답 본문

순번	변수명	타입	길이	설명
	code	number	-	API 처리에 대한 응답코드 0미등록 1등록
	message	string	-	API 처리에 대한 응답메시지

응답 예시

{
    "code": 1,
    "message": "취소 완료"
}

8. CancelReserveRN - 예약전송 취소 (요청번호)

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

GET https://popbill.linkhub.co.kr/FAX/Cancel/{requestNum}

파트너가 할당한 요청번호로 예약된 팩스를 전송 취소합니다. (예약시간 10분 전까지 가능)

Request

요청 헤더

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

Path 파라미터

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

요청 예시

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

Response

응답 본문

순번	변수명	타입	길이	설명
	code	number	-	API 처리에 대한 응답코드 0미등록 1등록
	message	string	-	API 처리에 대한 응답메시지

응답 예시

{
    "code": 1,
    "message": "취소 완료"
}