Wybierz dokument przychodzący lub wychodzący
Ten punkt końcowy zapewniający zgodność pobiera dokument faksu należący do Twojego konta. Użyj aktywnego konta API MultiTEL przez HTTPS, z przypisanymi do niego danymi uwierzytelniającymi i ograniczeniami adresów IP. Ten punkt końcowy nie wysyła faksu ani nie wysyła go ponownie.
| Parametr | Wymagany | Znaczenie |
|---|---|---|
type | Tak | Użyj wartości inbound lub outbound, dokładnie w podanej postaci. |
id | Tak | Dla inbound użyj wartości hash zwróconej przez fax_inbox. Dla outbound użyj wartości uuid zwróconej przez fax_outbox. |
Te wartości należy umieścić w ścieżce. Właściwa trasa to /v3/fax_file/{type}/{id}, a nie fax_download z dodatkowymi segmentami ścieżki. Skrót faksu przychodzącego nie jest liczbowym identyfikatorem rekordu ani identyfikatorem zadania wychodzącego. Skopiuj identyfikator z listy odpowiedniej skrzynki; nie zastępuje on uwierzytelniania.
Pobierz odebrany faks
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/c20ad4d76fe97759aa27a0c99bff6710Przykładowy skrót odpowiada fikcyjnemu rekordowi 12 w skrzynce odbiorczej. Własną wartość uzyskaj z fax_inbox. Pobranie istniejącego rekordu przychodzącego oznacza go jako wyświetlony. Dzieje się to przed sprawdzeniem dostępności pliku, więc nawet przy błędzie niedostępności pliku pole viewed może pozostać ustawione na true. Nie używaj tego punktu końcowego wyłącznie do sprawdzania, czy odebrany faks istnieje, jeśli chcesz zachować jego stan wyświetlenia bez zmian.
Procedura obsługi preferuje zapisany plik PDF. W przeciwnym razie używa zapisanego pliku TIFF i próbuje przekonwertować go na PDF, jeśli konwerter jest dostępny. Jeśli konwersja jest niedostępna lub zgłosi wyjątek, który zostanie obsłużony, zwracany jest zamiast tego plik TIFF. Zawsze sprawdzaj zwrócony nagłówek Content-Type, zamiast zakładać format PDF.
Pobierz faks wychodzący
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/0123456789abcdef0123456789abcdefUżyj wartości uuid z fax_outbox. Ten mechanizm pobierania zapewniający zgodność preferuje zapisany obiekt binarny w formacie PDF, następnie obiekt binarny w formacie TIFF, a potem dostępny plik PDF, plik TIFF lub oryginalny plik źródłowy. Ta kolejność preferencji różni się od kolejności stosowanej przez aktualną procedurę obsługi faksów wychodzących fax_download. W nowych integracjach korzystających z send_fax, używaj tego aktualnego mechanizmu pobierania z jego parametrem job_id.
Oryginalny plik źródłowy może zostać zwrócony jako application/octet-stream zamiast PDF lub TIFF. Nazwa pliku załącznika może zachować rozszerzenie pliku źródłowego. Pobieranie faksu wychodzącego w trybie zgodności nie oznacza rekordu skrzynki odbiorczej jako wyświetlonego, nie zmienia stanu zadania ani nie tworzy transmisji.
Obsługuj bajty i błędy oddzielnie
W przypadku powodzenia zwracane są surowe bajty dokumentu wraz z nagłówkami Content-Type, Content-Disposition wskazującym załącznik oraz Content-Length. Nie jest to otoczka z danymi zakodowanymi w Base64 w formacie JSON. Zapisz nagłówki i bajty oddzielnie, jak pokazano w przykładzie, sprawdź typ odpowiedzi i dopiero wtedy nadaj plikowi odpowiednią nazwę lub go przetwórz. Dozwolone rozszerzenie pliku źródłowego nie gwarantuje poprawności dokumentu ani jego konwersji.
Kod API 400 oznacza brak wymaganej wartości w ścieżce lub nieprawidłową wartość type. Kod API 404 oznacza, że rekord należący do konta lub jego plik jest niedostępny. Błędy korzystają ze standardowej otoczki JSON z status/response i mogą być zwracane z kodem HTTP 200. Sprawdzaj nagłówek Content-Type odpowiedzi oraz pole status.code w JSON, aby treść błędu nie została otwarta jako dokument.
Prywatność i dostępność
Treść faksu może zawierać informacje poufne. Przechowuj pobrane pliki wyłącznie w miejscach dostępnych tylko dla zamierzonych odbiorców i unikaj zapisywania pełnej zawartości bajtowej dokumentów w dziennikach. Rekord w skrzynce nie gwarantuje, że jego plik pozostanie dostępny. Nie ustalono okresu przechowywania plików ani gwarancji zgodności obejmującej każdy dokument zapisany w przeszłości.