MultiTEL
Programiści

GET/v3/fax_download?job_id={job_id}

Pobieranie dokumentu faksu wychodzącego

Pobierz dostępny dokument dla jednego ze swoich zadań wysyłania faksu.

Na tej stronie
  1. Żądanie dokumentu
  2. Obsługa pliku lub błędu w formacie JSON
  3. Dostępność i prywatność

Żądanie dokumentu

Użyj aktywnego konta API MultiTEL. W przypadku konta z hasłem prześlij dane uwierzytelniające HTTP Basic, a w przypadku konta z tokenem — token Bearer. Uprawnienia konta i ograniczenia adresów IP nadal obowiązują. Nie używaj wewnętrznych danych uwierzytelniających procesów roboczych.

curl --silent --show-error --get --user "$API_USER:$API_PASSWORD" \
  --data-urlencode job_id=0123456789abcdef0123456789abcdef \
  --dump-header fax-response.headers --output fax-response.bin \
  https://api.multitel.net/v3/fax_download

Użyj tego samego wymaganego 32-znakowego identyfikatora szesnastkowego job_id co w przypadku fax_status. Żądanie klienta jest dostępne wyłącznie dla uwierzytelnionego właściciela. Ten przykład zapisuje nagłówki odpowiedzi i jej bajty osobno, aby błąd API nie został pomylony z plikiem PDF.

Obsługa pliku lub błędu w formacie JSON

W przypadku powodzenia zwracane są surowe bajty dokumentu z nagłówkami Content-Type i Content-Disposition wskazującymi załącznik, a nie struktura odpowiedzi w formacie JSON. Sprawdź te nagłówki przed nadaniem nazwy zapisanemu plikowi, jego otwarciem lub przetworzeniem. W zależności od dostępnego dokumentu odpowiedź może mieć format PDF, TIFF lub oryginalny format przesłanego pliku. W przypadku zadania oczekującego w kolejce przed konwersją może zostać zwrócony oryginalny plik źródłowy.

W przypadku niepowodzenia zwracana jest standardowa struktura odpowiedzi JSON z status/response. Kod API 400 oznacza brak lub nieprawidłowy format job_id; 401 oznacza brak uwierzytelnienia; 404 oznacza, że zadanie lub jego plik jest niedostępny dla tego konta. Sprawdź Content-Type i status.code nawet wtedy, gdy status HTTP wynosi 200.

Dostępność i prywatność

Istnienie rekordu zadania nie gwarantuje, że plik będzie dostępny do pobrania bezterminowo; okres przechowywania nie został zweryfikowany. W razie potrzeby zapisuj dokumenty, do których masz uprawnienia, we własnej, kontrolowanej przez siebie przestrzeni dyskowej. Zwrócony plik może zawierać prywatne informacje o odbiorcy. Pobieranie nie powoduje wysłania nowego faksu.