MultiTEL
개발자

GET/v3/fax_file/{type}/{id}

받은 팩스함 또는 보낸 팩스함의 팩스 다운로드

받은 팩스함의 해시로 수신 팩스를 가져오거나 UUID로 이전 발신 문서를 가져오고, 반환된 파일 형식에 맞게 처리합니다.

이 페이지의 내용
  1. 수신 또는 발신 문서 선택
  2. 수신 팩스 다운로드
  3. 발신 팩스 다운로드
  4. 바이트 데이터와 오류를 구분하여 처리
  5. 개인정보 보호 및 파일 이용 가능 여부

수신 또는 발신 문서 선택

이 호환성 유지용 엔드포인트는 사용자 계정에 속한 팩스 문서를 가져옵니다. 활성화된 MultiTEL API 계정을 사용하고, 설정된 인증 정보와 IP 제한에 따라 HTTPS로 접속하세요. 팩스를 보내거나 다시 보내지는 않습니다.

다운로드 경로 매개변수
매개변수필수 여부의미
type예inbound 또는 outbound를 표시된 그대로 사용하세요.
id예inbound에 사용할 hash 값은 fax_inbox에서 반환한 값입니다. outbound에 사용할 uuid 값은 fax_outbox에서 반환한 값입니다.

이 값들은 경로에 지정합니다. 사용할 경로는 /v3/fax_file/{type}/{id}이며, fax_download에 경로 구간을 추가한 형태가 아닙니다. 수신 문서의 해시는 숫자로 된 레코드 ID도, 발신 작업 ID도 아닙니다. 해당 팩스함 목록에서 식별자를 복사하세요. 이 식별자가 인증을 대신하지는 않습니다.

수신 팩스 다운로드

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_file/inbound/c20ad4d76fe97759aa27a0c99bff6710

예제의 해시는 가상의 받은 팩스함 레코드 12를 나타냅니다. 실제로 사용할 값은 다음에서 가져오세요: fax_inbox. 기존 수신 레코드를 다운로드하면 해당 레코드가 열람한 것으로 표시됩니다. 이 변경은 파일의 이용 가능 여부를 확인하기 전에 이루어지므로, 파일을 이용할 수 없다는 오류가 발생해도 viewed 값은 true로 설정된 상태일 수 있습니다. 열람 상태를 그대로 유지하려면 수신 팩스가 존재하는지 확인하기 위한 용도로만 이 엔드포인트를 사용하지 마세요.

이 처리기는 저장된 PDF를 우선 사용합니다. 없으면 저장된 TIFF를 사용하며, 변환기를 사용할 수 있으면 PDF 변환을 시도합니다. 변환을 사용할 수 없거나 처리 대상인 예외가 발생하면 대신 TIFF를 반환합니다. 반환된 Content-Type을 항상 확인하고, PDF라고 가정하지 마세요.

발신 팩스 다운로드

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_file/outbound/0123456789abcdef0123456789abcdef

사용할 uuid 값은 다음에서 가져오세요: fax_outbox. 이 호환성 유지용 다운로드는 저장된 PDF 바이너리 데이터, TIFF 바이너리 데이터, 이용 가능한 PDF 파일, TIFF 파일, 원본 소스 파일 순으로 우선합니다. 이 우선순위는 현재 발신 문서용 fax_download 처리기와 다릅니다. 새 연동에서 send_fax를 사용하는 경우, 해당 job_id 매개변수와 함께 현재 다운로드 작업 흐름을 사용하세요.

원본 소스 파일은 application/octet-stream 형식으로 반환될 수 있으며, PDF 또는 TIFF 형식이 아닐 수도 있습니다. 첨부 파일 이름에는 원본 확장자가 유지될 수 있습니다. 호환성 유지용 발신 문서 다운로드는 받은 팩스함 레코드를 열람한 것으로 표시하거나, 작업 상태를 변경하거나, 전송을 생성하지 않습니다.

바이트 데이터와 오류를 구분하여 처리

성공하면 Content-Type, 첨부 파일을 나타내는 Content-Disposition, Content-Length 헤더와 함께 문서의 원시 바이트 데이터가 반환됩니다. Base64 데이터를 담은 JSON 응답 래퍼가 아닙니다. 예제처럼 헤더와 바이트 데이터를 따로 저장하고 응답 유형을 확인한 다음에만 파일에 적절한 이름을 붙이거나 처리하세요. 원본 파일의 확장자가 허용되더라도 문서가 유효하거나 변환되었다고 보장되지는 않습니다.

API 코드 400은 필수 경로 값이 누락되었거나 type이 유효하지 않음을 의미합니다. API 코드 404는 해당 계정에 속한 레코드 또는 그 파일을 이용할 수 없음을 의미합니다. 오류에는 일반적인 JSON status/response 응답 래퍼가 사용되며, HTTP 200이 사용될 수도 있습니다. 오류 본문을 문서로 열지 않도록 응답의 Content-Type과 JSON의 status.code를 확인하세요.

개인정보 보호 및 파일 이용 가능 여부

팩스 내용에는 민감한 정보가 포함될 수 있습니다. 다운로드한 파일은 의도한 수신자만 접근할 수 있는 곳에 저장하고, 문서 전체의 바이트 데이터를 로그에 포함하지 마세요. 팩스함에 레코드가 있다고 해서 해당 파일을 계속 이용할 수 있다고 보장되지는 않습니다. 파일 보관 기간은 정해져 있지 않으며, 과거에 저장된 모든 문서에 대한 호환성도 보장되어 있지 않습니다.