전송 상태 이벤트

팩스 전송에서 발생하는 웹훅 이벤트입니다.

이벤트 유형	설명
RESULT	팩스 전송결과 (전송완료, 전송실패, 예약취소)

팝빌 사이트에서 “Webhook 실행” 버튼을 클릭하여 웹훅을 전송하는 경우, eventType으로 “MANUAL”이 반환됩니다.

Webhook - Header

필드명	설명	필수	예시
Pb-Webhook-Type	Webhook 유형	Y	FAX.STATE
Pb-Webhook-MID	이벤트 식별값	Y	016120000002-1777d55c2c41492ab06826d
Pb-Webhook-Corpnum	팝빌 사업자번호	Y	6798700433
Content-Type	Webhook 메시지 Body 타입	Y	application/json
Authorization	Base64 인코딩한 BASIC 인증정보	N	Basic VEVTVDoxMjM= HTTP 인증 사용하는 경우 추가 항목
X-Api-Key	API Key 인증정보	N	TESTAPIKEY HTTP 인증 사용하는 경우 추가 항목

팝빌은 기본으로 제공되는 Header 필드 외 프로그램 공급사 운영환경에 맞춘 커스텀 필드 지원이 가능합니다.
커스텀 필드 추가가 필요한 경우 팝빌 기술지원센터(1600-9854)로 문의주시기 바랍니다.

Webhook - Body

필드명	타입	길이	필수	설명
corpNum	String	10	Y	팝빌회원 사업자번호
receiptNum	String	18	Y	접수번호
requestNum	String	36	N	요청번호
serialNum	Number	-	Y	일련번호
state	Number	1	Y	상태코드 [참고] 팝빌 상태코드
result	Number	3	N	결과코드 {state} = 3 경우 팩스 전송결과 확인 가능 [참고] 통신사 결과코드
receiptDT	String	14	Y	접수일시 형식 : yyyyMMddHHmmss
reserveDT	String	14	N	예약일시 형식 : yyyyMMddHHmmss
resultDT	String	14	Y	전송결과 수신일시 형식 : yyyyMMddHHmmss
sendDT	String	14	N	전송일시 형식 : yyyyMMddHHmmss
title	String	100	N	팩스제목
sendNum	String	20	Y	발신번호
receiveNumType	String	2	Y	수신번호 유형 일반 지능
receiveNum	String	20	Y	수신번호
sendPageCnt	Number	-	N	전체 페이지수
successPageCnt	Number	-	Y	성공 페이지수
failPageCnt	Number	-	N	실패 페이지수
cancelPageCnt	Number	-	N	취소 페이지수
chargePageCnt	Number	-	N	과금 페이지수
refundPageCnt	Number	-	N	환불 페이지수
eventType	String	30	Y	이벤트 유형 RESULT
eventDT	String	14	Y	이벤트 실행일시 형식 : yyyyMMddHHmmss
tiffFileSize	String	-	N	변환된 팩스 파일 사이즈 단위 : byte
interOPRefKey	String	20	N	파트너 지정 키 대량/동보전송시 파트너가 개별건마다 입력한 값

이벤트 예시

팩스 웹훅에서 발생하는 이벤트 예시입니다.
각 이벤트 발생시점은 [상태확인]에서 확인 가능합니다.

실제 고객사 서버로 전송된 웹훅 이벤트 정보는 [Webhook 실행내역 확인] 을 참고하여 주시기 바랍니다.

RESULT

전송결과

발신자가 보낸 팩스가 수신자에게 전송완료/전송실패/예약취소 된 시점에 실행됩니다.

1. 전송완료

발신자가 보낸 팩스가 수신자에게 전송에 성공한 시점에 실행됩니다.

{
    "corpNum": "1234567890",
    "receiptNum": "022111414242700001",
    "serialNum": 1,
    "state": 3,
    "result": 100,
    "receiptDT": "20221114142428",
    "resultDT": "20221114142639",
    "sendDT": "20221114142432",
    "title": "",
    "sendNum": "07043042981",
    "receiveNumType": "일반",
    "receiveNum": "0264429700",
    "sendPageCnt": 1,
    "successPageCnt": 1,
    "failPageCnt": 0,
    "chargePageCnt": 1,
    "eventType": "RESULT",
    "eventDT": "20221114142646",
    "tiffFileSize": 92973
}

2. 전송실패

발신자가 보낸 팩스가 수신자에게 전송에 실패한 시점에 실행됩니다.

{
    "corpNum": "1234567890",
    "receiptNum": "022111414222700001",
    "serialNum": 1,
    "state": 3,
    "result": 999,
    "receiptDT": "20221114142228",
    "resultDT": "20221114143027",
    "sendDT": "20221114142232",
    "title": "",
    "sendNum": "0264429700",
    "receiveNumType": "지능",
    "receiveNum": "07043042981",
    "sendPageCnt": 1,
    "successPageCnt": 0,
    "failPageCnt": 1,
    "chargePageCnt": 1,
    "refundPageCnt": 1,
    "eventType": "RESULT",
    "eventDT": "20221114143102",
    "tiffFileSize": 92973
}

3. 예약취소

발신자가 예약한 팩스를 취소한 시점에 실행됩니다.

{
    "corpNum": "1234567890",
    "receiptNum": "022111414334200001",
    "serialNum": 1,
    "state": 4,
    "receiptDT": "20221114143343",
    "reserveDT": "20230114143341",
    "resultDT": "20221114143558",
    "title": "",
    "sendNum": "07043042981",
    "receiveNumType": "일반",
    "receiveNum": "0264429700",
    "sendPageCnt": 1,
    "cancelPageCnt": 1,
    "chargePageCnt": 1,
    "refundPageCnt": 1,
    "eventType": "RESULT",
    "eventDT": "20221114143559",
    "tiffFileSize": 92973
}