Fax

Fax 발송 API입니다.

Fax 발송 API

캐릭터 인코딩은 UTF-8 을 기본으로 합니다.

multipart/form-data 형식으로 전송하되, 전송파일 외에 JSON Request Data 의 Content-Type 을 “application/json” 으로 명시해주어야 합니다.

Fax 발송 API

POST https://571bv9t3z5.apigw.ntruss.com/fax/v1/send

Headers

Name	Type	Description
Authorization*	string	사용자ID;secret_key
Content-Type*	string	multipart/form-data

Request Body

Name	Type	Description
form	object	Fax 내용(Fax 내용 상세 참조)
file	file	파일(최대 3개, 각 파일 7MB 이하)

201: Created 정상적으로 등록됨

400: Bad Request 파라미터가 형식에 맞지 않음

500: Internal Server Error 파일 업로드 실패

501 NOT_IMPLEMENTED : DB 등록 실패

Fax 내용 상세

키	타입	필수	설명
cid	string	Y	발신번호
coverType	string	Y	팩스 커버 타입 (‘1’ 고정)
coverSubject	string	N	팩스 커버 제목
coverContent	string	N	팩스 커버 내용
coverSendDate	string	N	팩스 커버 보낸일자 (yyyyMMddHHmm)
coverSendName	string	N	팩스 커버 이름
subject	string	N	제목
desFax	string	Y	수신자 팩스 번호
callback	string	N	회신 번호
desName	string	N	수신자 이름

Response Body

{
    "jobId": "string",
    "code": "string",
    "desc": "string"
}

키	타입	설명
jobId	string	전송 건별 유일키 (원천 서비스에서 생성)
code	string	결과 코드 (http헤더 값과 동일)
desc	string	결과 message (http헤더 값과 동일)

메세지 발송 결과(Webhook)

고객사가 요청한 메시지에 대한 처리 결과를 고객사의 callback URL로 전달합니다. (API PLEX Gateway -> 고객사 URL)

고객사 callback URL 정보는 서비스 신청 시 입력 합니다.

고객사 callback URL에 대한 CJ API GATEWAY의 접근을 허용해야 합니다. (IP, PORT)

Fax WebHook API

POST {Callback URL}

200: OK 응답 반환 완료

Webhook Body (API PLEX ➡ 고객사)

{
    "jobId": "string",
    "sendStatus": "string",
    "sendNum": "string",
    "sendName": "string",
    "recvNum": "string",
    "desName": "string",
    "pageCnt": 1,
    "insertDate": "string",
    "sentDate": "string",
    "startDate": "string",
    "endDate": "string",
    "termDate": "string",
    "reqDate": "string",
    "result": "string"
}

키	타입	설명
jobId	string	건별 유일키
sendStatus	string	전송상태 (전송상태 코드 참조)
sendNum	string	팩스 발송 전화번호
recvNum	string	팩스 수신 전화번호
pageCnt	number	전송된 팩스 페이지 수
sentDate	string	발송 완료 시간 (yyyyMMddHHmmSS)
startDate	string	팩스 발송 시도 시간 (서버) (yyyyMMddHHmmSS)
endDate	string	팩스 발송 완료 시간 (서버) (yyyyMMddHHmmSS)
termDate	string	메시지 처리가 완료된 시간 (yyyyMMddHHmmSS)
reqDate	string	팩스 발송 요청 시간 (yyyyMMddHHmmSS)
result	string	팩스 발송 결과 (팩스 발송결과 코드 참조)

Response Body (고객사 ➡ API PLEX)

{
    "code": "string",
    "desc": "string"
}

키	타입	필수	설명
code	string	Y	접수결과코드 (정상 수신시 "100")
desc	string	Y	접수결과코드상세 (ex: "desc":"Success")

참조 코드

GATEWAY 오류코드

CODE	설명
G110	서비스 ID가 잘못되었습니다.
G120	유효한 사용자가 존재하지 않습니다.
G130	서비스 KEY가 잘못되었습니다.
G140	유효한 발신번호가 아닙니다.
G150	여신이 부족합니다.
G160	1회 발송 최대 수를 초과했습니다.
G180	필수항목이 누락되었습니다. 항목명: %s
G200	project-key 정보가 잘못되었습니다.
G210	요청 JSON 변환중 오류가 발생했습니다.
G410	원천서비스 서비스 오류 발생
G420	사용자 callback api 호출 오류입니다.
G900	Gateway 시스템 오류가 발생했습니다.
G910	사용자 인증에 실패했습니다.

전송 상태 코드

code	코드설명
0	전송대기
1	송신 중
2	송신완료
3	결과수신
5	팩스수신
6	예약취소

팩스발송결과 코드

팩스발송 결과 코드가 ‘G’ 일 경우만 성공 처리합니다.

code	코드설명
G	성공
D	통화중실패
N	무응답
E	팩스실패
S	발신중
R	수신중
X	Com error
Q	변환실패
A	재발신
Z	파일명혹은수신번호실패
0	성공
1	CID 오류
2	FAX 내선번호오류
3	패스워드오류
4	시스템오류
5	기타에러
6	사용중지된유저
7	건수초과
8	FAX 변환오류
9	기타오류
10	Agent ID 오류
11	Agent Password 오류
12	이미연결되어있음
13	사용중지된ID
91	메시지유효시간초과(오래된메시지)
92	폰넘버오류
93	Fax_numlist에서스팸처리됨
94	팩스전송후응답없음
95	파일사이즈초과
96	파일포맷오류
97	원본파일읽기오류