@barobill-sdk/fax

바로빌 팩스전송 API TypeScript SDK (비공식)

이 패키지는 바로빌의 공식 SDK가 아닌, 비공식 SDK입니다. 바로빌 API의 공식 문서는 바로빌 API 레퍼런스를 참고해 주세요.

설치

npm i @barobill-sdk/fax

사용법

import { FaxClient } from '@barobill-sdk/fax';

const client = await FaxClient.create({
  certKey: 'your-cert-key',
  corpNum: '1234567890', // 기본 사업자등록번호 (선택)
  test: true,            // true: 테스트 환경 (기본값: false)
});

const result = await client.sendFaxFromFTP({
  // ...
});

• certKey: 바로빌 인증키
• corpNum (선택): 기본 사업자등록번호. 설정하면 API 호출 시 자동 주입됩니다.
• test: true이면 테스트 환경, false이면 운영 환경

주요 메서드

| 분류 | 메서드 | |------|--------| | 전송 | sendFaxFromFTP, sendFaxesFromFTP, sendFaxFromFTPEx, sendFaxesFromFTPEx | | 재전송 | reSendFax, reSendFaxEx | | 예약취소 | cancelReservedFaxMessage | | 조회 | getFaxSendState, getFaxMessage, getFaxSendMessages, getFaxSendMessagesByPaging 등 | | URL | getFaxHistoryURL, getFaxFileURL | | 유틸 | getErrString, ping |

관련 링크

• 전체 패키지 목록 (모노레포)

License

ISC