Aby wysłać fax za pomocą API, najpierw musisz przesłać wymagane pliki, a następnie przygotować je do wysłania faxem i zaplanować transmisję.
Po zaplanowaniu faxu możesz zaimplementować serwer HTTP i wykorzystać mechanizm webhook. Takie podejście zapewnia, że wiadomość HTTP zostanie wysłana zarówno w przypadku pomyślnej transmisji faxu, jak i w przypadku niepowodzenia transmisji.
Uwaga: Upewnij się, że wstępne uwierzytelnianie zostało ukończone, a logowanie do API zakończyło się powodzeniem. Dodatkowe instrukcje znajdziesz w naszym przewodniku tutaj.
Aby przesłać plik, wyślij żądanie HTTP POST na następujący adres URL: https://restapi.fax.plus/v3/accounts/[user ID]/files?format=[file format, 'pdf' or 'tiff']
Upewnij się, że w żądaniu zostały uwzględnione następujące nagłówki:
-
Content-Type:
multipart/form-data
-
Authorization:
Bearer [access token]
-
x-fax-clientid:
[client ID]
Treść żądania:
{
"fax_file": [file]
}
W poniższym przykładzie jako identyfikator użytkownika użyto wartości „self”, która oznacza unikalny identyfikator aktualnie zalogowanego użytkownika:
Po pomyślnym przesłaniu pliku otrzymasz ścieżkę prowadzącą do tymczasowej lokalizacji pliku w Fax.Plus.
Po zakończeniu przesyłania plików możesz rozpocząć przygotowanie wysyłki fax. Aby rozpocząć ten proces, wyślij żądanie HTTP POST na następujący adres URL:
https://restapi.fax.plus/v3/accounts/[user ID]/outbox
Upewnij się, że w żądaniu zostały uwzględnione następujące nagłówki:
-
Authorization:
Bearer [access token] -
x-fax-clientid:
[client ID]
Treść żądania:
{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}
Po pomyślnym zaplanowaniu wysyłki fax otrzymasz Outbox ID. Za pomocą tego identyfikatora można zmodyfikować lub usunąć fax przed jego faktycznym wysłaniem.
Uwaga: W naszym API z jednym fax powiązanych jest kilka identyfikatorów. Wynika to z tego, że transmisja fax przebiega asynchronicznie. Konkretnie: wychodzący fax jest identyfikowany przez dwa różne identyfikatory: Outbox ID, który obowiązuje do czasu pomyślnego wysłania fax, oraz Fax ID, który staje się ostatecznym identyfikatorem fax po jego pomyślnym przesłaniu.
Po zaplanowaniu wysyłki fax możesz monitorować jej status, przeglądając listę wiadomości fax znajdujących się w skrzynce nadawczej lub w kategorii wysłanych.
Możesz też skonfigurować serwer HTTP i użyć webhooka. Spowoduje to wysłanie wiadomości HTTP po pomyślnym wysłaniu fax lub w przypadku niepowodzenia wysyłki.
Wykonaj poniższe kroki, aby skonfigurować webhook:
- Zaloguj się na swoje konto Fax.Plus i przejdź do sekcji Ustawienia w swoim panelu.
- Na karcie Integracje znajdź pole webhooków.
- Znajdź Fax przychodzący i Fax przychodzący. Kliknij Zarządzaj, aby zmodyfikować webhook.
Po skonfigurowaniu webhooka, gdy wychodzący fax zostanie przetworzony, otrzymasz następujące powiadomienie:
{
"hook": {
"id": "",
"event": "fax_sent",
"event_time": "2022-12-09 15:50:00",
"target": "http://www.example.com/callback/fax_sent"
},
"data": {
"id": "",
"pages": 1,
"from": "",
"to": "",
"start_time": "2022-12-09 15:50:00",
"file": "",
"file_name": "fax-from-1xxxxxxxxxxxx",
"cost": 1,
"status": "success"
}
}Wiadomość ta zawiera czas transmisji, informuje o powodzeniu transmisji fax (w polu „status”) oraz podaje unikalny identyfikator fax (Fax ID). Identyfikator ten można wykorzystać, aby pobrać plik fax lub uzyskać raport potwierdzenia fax.