Użyj HTTPS i uwierzytelniania HTTP Basic z zatwierdzonymi poświadczeniami API. Przechowuj poświadczenia na serwerze aplikacji. Te punkty końcowe Hosted PBX używają /hpbx/ na api.multitel.net; nie wstawiaj /v3. Sprawdzaj zarówno wynik HTTP, jak i status aplikacji w odpowiedzi JSON.
Odczyt rekordów faksów
curl --request POST --user "USERNAME:PASSWORD" \
"https://api.multitel.net/hpbx/fax/list/YOUR_BILLING_CODE"Zastąp kod rozliczeniowy kodem rozliczeniowym swojej centrali PBX. Zwrócone rekordy obejmują czas faksu, kierunek, źródło, miejsce docelowe, status doręczenia, liczbę prób, błędy i liczbę stron. Doręczenie może być nadal oczekujące w momencie zaakceptowania żądania wysłania.
Parametry wysyłania
Punkt końcowy wysyłania to POST /hpbx/fax/send/{billing_code}. Wysyłanie jest rzeczywistą operacją wysłania. Przygotuj plik i autoryzowane dla konta miejsce docelowe przed wysłaniem; nie ponawiaj niepewnego wysyłania w ciemno.
| Pole | Znaczenie |
|---|---|
| number | Docelowy numer faksu. |
| cidnum | Zatwierdzony identyfikator dzwoniącego nadawcy. |
| schedule | Zaplanowany czas wysyłki, jeśli jest używany. |
| faxquality / pagesize / pagerotate | Obsługiwane opcje jakości, rozmiaru papieru i obrotu. |
| statusemail | Autoryzowany adres do powiadomień o dostarczeniu. |
| deleteaftersend | Określa, czy przechowywany przesłany plik ma zostać usunięty po wysłaniu. |
| filename | Odwołanie do dokumentu oczekiwane przez ten proces faksowy; nie jest to dowolna lokalna ścieżka pliku. |
Śledzenie ukończenia
Po przesłaniu sprawdź status rekordu faksu, liczbę prób i błąd. Potwierdź dostarczenie, zamiast traktować przyjęcie jako dostarczenie. Dokumentacja faksu w portalu opisuje jego bieżący proces przesyłania i wysyłania; jego ścieżki i uwierzytelnianie są odrębne od punktu końcowego powyżej.