Jak mogę wysłać fax za pomocą API?

Zaktualizowano 11/09/2026 15:47

Kto może korzystać z tej funkcji?

Dostępne w planie Enterprise.

Wszyscy członkowie.

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 zakończono początkowy proces uwierzytelniania i pomyślnie zalogowano się do API. Aby uzyskać dodatkowe instrukcje, zapoznaj się z naszym przewodnikiem tutaj.

Krok 1: Prześlij pliki do wysłania faksem

Aby przesłać plik, zainicjuj żądanie HTTP POST pod 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 znajdują się następujące nagłówki:

- Content-Type:
```
multipart/form-data
```

- Authorization:
```
Bearer [access token]
```

- x-fax-clientid:
```
[client ID]
```

W przypadku treści żądania:

{
  "fax_file": [file]
}

‍

W poniższym przykładzie jako identyfikator użytkownika użyto wartości „self”, aby wskazać unikalny identyfikator aktualnie zalogowanego użytkownika:

FAX.PLUS-Send-Fax-API-2.png

FAX.PLUS-Send-Fax-API-3.png

Po pomyślnym przesłaniu pliku otrzymasz ścieżkę prowadzącą do tymczasowej lokalizacji pliku w Fax.Plus.

Krok 2: Wyślij faks za pomocą API

Po zakończeniu przesyłania plików możesz rozpocząć przygotowywanie faksu do wysłania. Aby zainicjować ten proces, wykonaj żądanie HTTP POST pod następujący adres URL:
https://restapi.fax.plus/v3/accounts/[user ID]/outbox

Upewnij się, że w żądaniu znajdują się następujące nagłówki:

- Authorization:
```
Bearer [access token]
```
- x-fax-clientid:
```
[client ID]
```

W przypadku treści żądania:

{
"from": "",
"to": [
""
],
"files": [
""
],
"comment": {
"text": ""
},
"send_time": "",
}

FAX.PLUS-Send-Fax-API-4.png

Po pomyślnym zaplanowaniu faksu otrzymasz identyfikator Outbox ID. Ten identyfikator można wykorzystać do wprowadzania zmian lub usunięcia faksu, zanim zostanie on faktycznie wysłany.

Uwaga: W naszym API każdemu faksowi przypisanych jest kilka identyfikatorów. Takie rozwiązanie wynika z tego, że przesyłanie faksu odbywa się asynchronicznie. Dokładniej mówiąc, faks wychodzący jest identyfikowany za pomocą dwóch odrębnych identyfikatorów: Outbox ID, który obowiązuje do momentu pomyślnego wysłania faksu, oraz Fax ID, który staje się ostatecznym identyfikatorem faksu po jego pomyślnym przesłaniu.

Krok 3: Użyj webhooków, aby sprawdzić status wysłanego faksu

Po zaplanowaniu faksu możesz monitorować jego status, przeglądając listę faksów znajdującą się w outboksie lub w kategorii wysłanych.

Alternatywnie możesz skonfigurować serwer HTTP i skorzystać z webhooka. Spowoduje to wysłanie wiadomości HTTP w momencie pomyślnego wysłania faksu lub w przypadku niepowodzenia wysyłki.

Aby skonfigurować webhook, wykonaj następujące kroki:

Zaloguj się na swoje konto Fax.Plus i przejdź do sekcji Ustawienia w swoim panelu.
W zakładce Integracje znajdź pole WebHooks.
Znajdź Faksy przychodzące i Faksy przychodzące. Kliknij Zarządzaj, aby zmodyfikować webhook.

Po skonfigurowaniu webhooka po przetworzeniu faksu wychodzącego 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"
}
}

Ta wiadomość zawiera informację o czasie przesyłania, wskazuje, czy transmisja faksu zakończyła się powodzeniem (za pomocą pola „status”), oraz podaje unikalny identyfikator faksu. Ten identyfikator faksu można wykorzystać do pobrania pliku faksu lub uzyskania raportu potwierdzenia faksu.

Need Support?